Class LeftCollectionWithRightViewLayoutGenerator<T>
A default layout generator that creates a standard IBaseGrid view of type T
on the left, and a child view of the grid on the right
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts
Assembly: ClientCore.dll
Syntax
public abstract class LeftCollectionWithRightViewLayoutGenerator<T> : DefaultLayoutGenerator, ILayoutGenerator where T : IBaseEntity
Type Parameters
Name | Description |
---|---|
T | The type of entity that is in the grid on the left of this layout |
Constructors
LeftCollectionWithRightViewLayoutGenerator()
Creates a new default generator that creates a grid on the left with a child view of that grid on the right
Declaration
public LeftCollectionWithRightViewLayoutGenerator()
Properties
Descriptor
The entity descriptor for type T
Declaration
protected EntityDescriptor Descriptor { get; }
Property Value
Type | Description |
---|---|
EntityDescriptor |
LeftCollectionRatioOf100
Indicates the percentage of the horizontal available screen space the left collection grid should take up.
The default is 50
Declaration
protected virtual int LeftCollectionRatioOf100 { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Methods
CanGenerateLayout(String, String)
Returns true if this is the default layout generator for displaying a collection of type T
Declaration
public override bool CanGenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type | Name | Description |
---|---|---|
System.String | uniqueLayoutName | The unique layout name to see if it matches the SetName of entity type |
System.String | layoutParam | Optionaly parameters for this layout |
Returns
Type | Description |
---|---|
System.Boolean | True if this is the default layout generator for displaying a collection of type |
Overrides
GenerateAdditionalTabsForLayout(LayoutDescriptor)
Provides any inheriting implementation the option to generate additional tabs for the layout before it is returned
Declaration
protected virtual Task GenerateAdditionalTabsForLayout(LayoutDescriptor rootDescriptor)
Parameters
Type | Name | Description |
---|---|---|
LayoutDescriptor | rootDescriptor | The top level descriptor to add additional tabs to |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task indicating the completion of the operation |
GenerateLayout(String, String)
Generates a layout with a grid for the collection of entities of type T
on the left, with a sub view of the specified GetChildView(ViewDescriptorInstance) on the right
Declaration
public override Task<LayoutDescriptor> GenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type | Name | Description |
---|---|---|
System.String | uniqueLayoutName | The unique layout name of the layout to be generated |
System.String | layoutParam | ANy optional parameters for generating the layout with |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LayoutDescriptor> | A layout with a grid for the collection of entities of type |
Overrides
GetChildView(ViewDescriptorInstance)
Provides the inheriting implementation the ability to create the type of view that will be a child to the collection grid on the left of this layout
Declaration
protected abstract ViewDescriptorInstance GetChildView(ViewDescriptorInstance parent)
Parameters
Type | Name | Description |
---|---|---|
ViewDescriptorInstance | parent | The parent collection grid |
Returns
Type | Description |
---|---|
ViewDescriptorInstance | The view that should be a child of the |