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.Core.Views.DefaultLayouts.Core
Assembly: LemonEdge.ClientCore.dll
Syntax
public abstract class DefaultLayoutGenerator : ILayoutGeneratorConstructors
DefaultLayoutGenerator()
Declaration
protected DefaultLayoutGenerator()Properties
LayoutHelpURL
An optional url containing help documentation on this layout. Integrates with the system Help command
Declaration
public virtual string LayoutHelpURL { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
CanGenerateDefaultLayout(string, string)
Declaration
public static bool CanGenerateDefaultLayout(string uniqueLayoutName, string layoutParam)Parameters
| Type | Name | Description |
|---|---|---|
| string | uniqueLayoutName | |
| string | layoutParam |
Returns
| Type | Description |
|---|---|
| bool |
CanGenerateDefaultOrCustomLayout(string, string)
Returns true if there is a default layout generator, or ILayout, that works for the
specified uniqueLayoutName and layoutParam combination
Declaration
public static 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 |
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(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, override GenerateLayout(string uniqueLayoutName, string layoutParam) instead")]
public virtual Task<LayoutDescriptor> GenerateLayout(ILayoutCreator displayer, string uniqueLayoutName, string layoutParam)Parameters
| Type | Name | Description |
|---|---|---|
| ILayoutCreator | displayer | |
| string | uniqueLayoutName | |
| string | layoutParam |
Returns
| Type | Description |
|---|---|
| Task<LayoutDescriptor> |
GenerateLayout(string, string)
Creates a LayoutDescriptor that contains the definition of tabs, views, sub-views, parameters and other interactions for the display
You must override this method to generate your layout descriptor
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 |
GetDefaultLayoutGenerator(string, string)
Returns the default layout generator for the specified uniqueLayoutName and
layoutParam combination
Declaration
public static 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 |
GetDefaultLayoutGenerators()
Returns all the default layout generators in the system and any loaded custom IAddIn
Declaration
public static IEnumerable<DefaultLayoutGenerator> GetDefaultLayoutGenerators()Returns
| Type | Description |
|---|---|
| IEnumerable<DefaultLayoutGenerator> | All the default layout generators in the system and any loaded custom IAddIn |
GetDefaultLayoutGenerators(string, string)
Declaration
public static IEnumerable<DefaultLayoutGenerator> GetDefaultLayoutGenerators(string uniqueLayoutName, string layoutParam)Parameters
| Type | Name | Description |
|---|---|---|
| string | uniqueLayoutName | |
| string | layoutParam |
Returns
| Type | Description |
|---|---|
| IEnumerable<DefaultLayoutGenerator> |
RegenerateDefaultLayouts()
Forces the system to reload all default layouts from the dlls and any custom loaded IAddIn
Declaration
public static void RegenerateDefaultLayouts()