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://help.lemonedge.com/layouts/ for more info
Namespace: LemonEdge.Client.UI.API.Layouts
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public interface ILayoutGenerator

Properties

LayoutHelpURL

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

Declaration
string LayoutHelpURL { get; }
Property Value
Type Description
string

Methods

CanGenerateLayout(string, string)

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

Declaration
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 uniqueLayoutName and layoutParam combination

GenerateLayout(string, string)

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

Declaration
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

Extension Methods