Class AddInModuleDefaultLayout
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts
Assembly: LemonEdge.ClientEntities.dll
Syntax
[DefaultLayout]
public class AddInModuleDefaultLayout : DefaultLayoutGenerator, ILayoutGenerator
Constructors
AddInModuleDefaultLayout(IRootController)
Declaration
public AddInModuleDefaultLayout(IRootController rootController)
Parameters
Type | Name | Description |
---|---|---|
IRootController | rootController |
Fields
WARNING_MSG
Declaration
public const string WARNING_MSG = "**You should refresh your application when you've changed add-in dll's.** \r\nIf you are connecting to the system through a web service, it will be forced to restart to load in your changes - so only perform changes at low usage times. \r\nThis may result in some errors while the service restarts, in either case you will need to *quit* and restart your client app to load in the new changes."
Field Value
Type | Description |
---|---|
string |
Methods
CanGenerateLayout(string, string)
Returns true if this default layout generator works for the specified uniqueLayoutName
and
layoutParam
combination
Declaration
public override 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 |
Overrides
GenerateLayout(string, string)
Creates a LayoutDescriptor that contains the definition of tabs, views, sub-views, parameters and other interactions for the display
Declaration
public override 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 |