Search Results for

    Show / Hide Table of Contents

    Class TopCollectionWithBottomViewLayoutGenerator<T>

    A default layout generator that creates a standard IBaseGrid view of type T on the top, and a child view of the grid on the bottom

    Inheritance
    System.Object
    DefaultLayoutGenerator
    TopCollectionWithBottomViewLayoutGenerator<T>
    TopCollectionWithBottomChildSingleLayoutGenerator<T>
    TopCollectionWithBottomCollectionLayoutGenerator<T, CHILDT>
    Implements
    ILayoutGenerator
    Inherited Members
    DefaultLayoutGenerator.CanGenerateDefaultOrCustomLayout(String, String)
    DefaultLayoutGenerator.RegenerateDefaultLayouts()
    DefaultLayoutGenerator.GetDefaultLayoutGenerators()
    DefaultLayoutGenerator.GetDefaultLayoutGenerator(String, String)
    DefaultLayoutGenerator.GenerateLayout(ILayoutCreator, String, String)
    DefaultLayoutGenerator.LayoutHelpURL
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: LemonEdge.Client.Core.Views.DefaultLayouts
    Assembly: ClientCore.dll
    Syntax
    public abstract class TopCollectionWithBottomViewLayoutGenerator<T> : DefaultLayoutGenerator, ILayoutGenerator where T : IBaseEntity
    Type Parameters
    Name Description
    T

    The type of entity that is in the grid on the top of this layout

    Constructors

    TopCollectionWithBottomViewLayoutGenerator()

    Creates a new default generator that creates a grid on the top with a child view of that grid on the bottom

    Declaration
    public TopCollectionWithBottomViewLayoutGenerator()

    Properties

    Descriptor

    The entity descriptor for type T

    Declaration
    protected EntityDescriptor Descriptor { get; }
    Property Value
    Type Description
    EntityDescriptor

    TopViewPercentHeight

    Indicates the percentage of the vertical available screen space the top collection grid should take up.

    The default is 20

    Declaration
    protected virtual int TopViewPercentHeight { 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 T

    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 T

    Overrides
    DefaultLayoutGenerator.CanGenerateLayout(String, String)

    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 top, with a sub view of the specified on the bottom

    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 T on the top, with a sub view of the specified on the bottom

    Overrides
    DefaultLayoutGenerator.GenerateLayout(String, String)

    GetBottomView(ViewDescriptorInstance)

    Provides the inheriting implementation the ability to create the type of view that will be a child to the collection grid on the bottom of this layout

    Declaration
    protected abstract Task<ViewDescriptorInstance> GetBottomView(ViewDescriptorInstance topView)
    Parameters
    Type Name Description
    ViewDescriptorInstance topView

    The top view collection grid

    Returns
    Type Description
    System.Threading.Tasks.Task<ViewDescriptorInstance>

    The view that should be a child of the topView view that will be displayed on the bottom of this generated layout

    Implements

    ILayoutGenerator

    Extension Methods

    MiscExtensions.SetIfNotEqual<T, P>(T, Expression<Func<T, P>>, P)
    ReflectionExtensions.ClearEventInvocations(Object, String)
    StringExtensions.ToCSVFormatString(Object, Type)
    SQLExtensions.ToSQLValue(Object, Boolean)
    In This Article
    Back to top © LemonTree Software Ltd. All rights reserved.