Class DefaultLayoutGenerator

Any layout generator that inherits this class can be used automatically (if marked with the DefaultLayoutAttribute) by the system to display items in the application correctly

Inheritance
System.Object
DefaultLayoutGenerator
DefaultEntityCollectionLayouts
DefaultEntitySingleLayouts
LeftCollectionWithRightViewLayoutGenerator<T>
TopCollectionWithBottomViewLayoutGenerator<T>
TopSingleWithBottomViewLayoutGenerator<T>
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts
Assembly: ClientCore.dll
Syntax
public abstract class DefaultLayoutGenerator : ILayoutGenerator

Properties

LayoutHelpURL

An optional url containing help documentation on this layout. Integrates with the system Help command

Declaration
public virtual string LayoutHelpURL { get; }
Property Value
Type Description
System.String

Methods

CanGenerateDefaultOrCustomLayout(String, String)

Returns true if there is a default layout generator, or ILayout, that works for the specified uniqueLayoutName and layoutParam combination

Declaration
public static Task<bool> CanGenerateDefaultOrCustomLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
System.String uniqueLayoutName

The unique name of the layout to generate
System.String layoutParam

Any optional parameters for the layout to use while generating it
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True if there is a default layout generator, or ILayout, that works for the specified uniqueLayoutName and layoutParam combination

CanGenerateLayout(String, String)

Returns true if this default layout generator works for the specified uniqueLayoutName and layoutParam combination

Declaration
public abstract bool CanGenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
System.String uniqueLayoutName

The unique name of the layout to generate
System.String layoutParam

Any optional parameters for the layout to use while generating it
Returns
Type Description
System.Boolean

True if this default layout generator works for the specified uniqueLayoutName and layoutParam combination

GenerateLayout(ILayoutCreator, String, String)

Obsolete.

The ILayoutCreator interface is no longer required and will be removed at a later date. Implement GenerateLayout(String, String) instead

Declaration
[Obsolete("The ILayoutCreator interface is no longer required, override GenerateLayout(string uniqueLayoutName, string layoutParam) instead")]
public virtual Task<LayoutDescriptor> GenerateLayout(ILayoutCreator displayer, string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
ILayoutCreator displayer
System.String uniqueLayoutName
System.String layoutParam
Returns
Type Description
System.Threading.Tasks.Task<LayoutDescriptor>

GenerateLayout(String, String)

Creates a LayoutDescriptor that contains the definition of tabs, views, sub-views, parameters and other interactions for the display

You must override this method to generate your layout descriptor

Declaration
public virtual Task<LayoutDescriptor> GenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
System.String uniqueLayoutName

The unique name of the layout this is being generated for
System.String layoutParam

ANy optional parameters for the layout that are could be used to generate this layout
Returns
Type Description
System.Threading.Tasks.Task<LayoutDescriptor>

A LayoutDescriptor that details how to construct the layout in the UI of the client application

GetDefaultLayoutGenerator(String, String)

Returns the default layout generator for the specified uniqueLayoutName and layoutParam combintation

Declaration
public static DefaultLayoutGenerator GetDefaultLayoutGenerator(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
System.String uniqueLayoutName

The unique name of the layout to generate
System.String layoutParam

Any optional parameters for the layout to use while generating it
Returns
Type Description
DefaultLayoutGenerator

The default layout generator for the specified uniqueLayoutName and layoutParam combintation

GetDefaultLayoutGenerators()

Returns all the default layout generators in the system and any loaded custom IAddIn

Declaration
public static IEnumerable<DefaultLayoutGenerator> GetDefaultLayoutGenerators()
Returns
Type Description
System.Collections.Generic.IEnumerable<DefaultLayoutGenerator>

All the default layout generators in the system and any loaded custom IAddIn

RegenerateDefaultLayouts()

Forces the system to reload all default layouts from the dlls and any custom loaded IAddIn

Declaration
public static void RegenerateDefaultLayouts()

Implements

Extension Methods