Interface ILayoutGeneratorFactory

Namespace: LemonEdge.Client.UI.API.Layouts
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public interface ILayoutGeneratorFactory

Methods

CanGenerateDefaultLayout(string, string)

Determines whether a default layout generator can be generated for the given arguments

Declaration
bool CanGenerateDefaultLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
string uniqueLayoutName

The unique layout name
string layoutParam

The layout parameters
Returns
Type Description
bool

Whether the layout can be created

CanGenerateDefaultOrCustomLayout(string, string)

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

Declaration
Task<bool> CanGenerateDefaultOrCustomLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
string uniqueLayoutName

The unique name of the layout to generate
string layoutParam

Any optional parameters for the layout to use while generating it
Returns
Type Description
Task<bool>

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

GetDefaultLayoutGenerator(string, string)

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

Declaration
DefaultLayoutGenerator? GetDefaultLayoutGenerator(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
string uniqueLayoutName

The unique name of the layout to generate
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 combination

GetDefaultLayoutGenerators()

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

Declaration
DefaultLayoutGenerator[] GetDefaultLayoutGenerators()
Returns
Type Description
DefaultLayoutGenerator[]

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

GetDefaultLayoutGenerators(string, string)

Returns all the default layout generators in the system and any loaded custom IAddIn, for the given uniqueLayoutName and layoutParam

Declaration
DefaultLayoutGenerator[] GetDefaultLayoutGenerators(string uniqueLayoutName, string layoutParam)
Parameters
Type Name Description
string uniqueLayoutName
string layoutParam
Returns
Type Description
DefaultLayoutGenerator[]

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

GetItemSelectorGenerator<T>(EntityDescriptor)

Returns a T, where T is a specific, non-default LayoutGenerator

Declaration
ILayoutGenerator? GetItemSelectorGenerator<T>(EntityDescriptor descriptor) where T : ILayoutGenerator
Parameters
Type Name Description
EntityDescriptor descriptor

The descriptor for which you would like the generator
Returns
Type Description
ILayoutGenerator
Type Parameters
Name Description
T

GetLayoutDescriptor(ILayoutGenerator, string, string)

Declaration
Task<LayoutDescriptor> GetLayoutDescriptor(ILayoutGenerator generator, string uniqueLayoutName, string param)
Parameters
Type Name Description
ILayoutGenerator generator
string uniqueLayoutName
string param
Returns
Type Description
Task<LayoutDescriptor>

RegenerateLayouts()

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

Declaration
Task RegenerateLayouts()
Returns
Type Description
Task

Extension Methods