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
Implements
Inherited Members
Namespace: LemonEdge.Client.UI.API.Layouts
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public abstract class DefaultLayoutGenerator : ILayoutGeneratorConstructors
DefaultLayoutGenerator(IRootController)
Creates a new DefaultLayoutGenerator
Declaration
protected DefaultLayoutGenerator(IRootController rootController)Parameters
| Type | Name | Description |
|---|---|---|
| IRootController | rootController |
Properties
LayoutHelpURL
An optional url containing help documentation on this layout. Integrates with the system LemonEdge.Client.Core.Commands.Help command
Declaration
public virtual string LayoutHelpURL { get; }Property Value
| Type | Description |
|---|---|
| string |
RootController
The application controller, for access to services.
Declaration
protected IRootController RootController { get; }Property Value
| Type | Description |
|---|---|
| IRootController |
Methods
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 |
|---|---|---|
| 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 |
|---|---|
| bool | True if this default layout generator works for the specified |
GenerateLayout(string, string)
Creates a LayoutDescriptor that contains the definition of tabs, views, sub-views, parameters and other interactions for the display
Declaration
public virtual Task<LayoutDescriptor> GenerateLayout(string uniqueLayoutName, string layoutParam)Parameters
| Type | Name | Description |
|---|---|---|
| string | uniqueLayoutName | The unique name of the layout this is being generated for |
| string | layoutParam | ANy optional parameters for the layout that are could be used to generate this layout |
Returns
| Type | Description |
|---|---|
| Task<LayoutDescriptor> | A LayoutDescriptor that details how to construct the layout in the UI of the client application |