Interface ILayoutGenerator
Whenever an item is displayed in the system a LayoutDescriptor is used to define a collection of tabs, views, sub-views, and other interactions to present that correctly to the user
This interface is used by the system to dynamically create a LayoutDescriptor for a particular type of layout name and parameter.
A user can also create a ILayout through drag+dropping views, which can be used to load a LayoutDescriptor too. See https://web.lemonedge.com/help/layouts/ for more infoNamespace: LemonEdge.Client.Core.Views.DefaultLayouts
Assembly: ClientCore.dll
Syntax
public interface ILayoutGenerator
Properties
LayoutHelpURL
An optional url containing help documentation on this layout. Integrates with the system Help command
Declaration
virtual string LayoutHelpURL { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
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, implement GenerateLayout(string uniqueLayoutName, string layoutParam) instead")]
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
Declaration
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 |