Class LayoutViewDescriptor

A descriptor of a view within a LayoutDescriptorGroup for a LayoutDescriptor

This describes how the view should be displayed within the parent group.

The view itself is described through the ViewDescriptorInstance
Inheritance
object
LayoutViewDescriptor
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts.Core
Assembly: LemonEdge.Client.UI.API.dll
Syntax
[DataContract]
public class LayoutViewDescriptor : ICloneable, ICloneable<LayoutViewDescriptor>, IHasLayoutPosition

Constructors

LayoutViewDescriptor(ViewDescriptorInstance)

Creates a new LayoutViewDescriptor with the specified view descriptor instance

Declaration
public LayoutViewDescriptor(ViewDescriptorInstance descriptor)
Parameters
Type Name Description
ViewDescriptorInstance descriptor

A descriptor of the view to be created by in the UI of the client application

LayoutViewDescriptor(ViewDescriptorInstance, LayoutDockPosition, int, int)

Creates a new LayoutViewDescriptor with the specified view descriptor instance and specified IHasLayoutPosition properties

Declaration
public LayoutViewDescriptor(ViewDescriptorInstance descriptor, LayoutDockPosition position, int proportionalVerticalSize, int proportionalHorizontalSize)
Parameters
Type Name Description
ViewDescriptorInstance descriptor

A descriptor of the view to be created by in the UI of the client application
LayoutDockPosition position

The position this view should take within this group
int proportionalVerticalSize

The proportional percentage this view should take up of the position in the vertical space
int proportionalHorizontalSize

The proportional percentage this view should take up of the position in the horizontal space

Properties

Hidden

Indicates if this view should be currently hidden within the parent group

Declaration
public bool Hidden { get; set; }
Property Value
Type Description
bool

Position

The position this view should take within this group

Declaration
public LayoutDockPosition Position { get; set; }
Property Value
Type Description
LayoutDockPosition

ProportionalHorizontalSize

The proportional percentage this view should take up of the position in the horizontal space

Declaration
public int ProportionalHorizontalSize { get; set; }
Property Value
Type Description
int

ProportionalVerticalSize

The proportional percentage this view should take up of the position in the vertical space

Declaration
public int ProportionalVerticalSize { get; set; }
Property Value
Type Description
int

View

The view itself when it has been constructed by the UI of the client application

Declaration
public IModelView? View { get; set; }
Property Value
Type Description
IModelView

ViewDescriptor

The descriptor of the view itself that should be created within the UI of the client application

When it is created it is accessible through View

Declaration
public ViewDescriptorInstance ViewDescriptor { get; set; }
Property Value
Type Description
ViewDescriptorInstance

ViewItemInvalid

Indicates an item that is not allowed to be displayed against this view, was attempted to be passed to it

Declaration
public bool ViewItemInvalid { get; set; }
Property Value
Type Description
bool

Methods

Clone()

Creates a new instance of this class (of type LayoutViewDescriptor) with all the same property values as this instance

Declaration
public LayoutViewDescriptor Clone()
Returns
Type Description
LayoutViewDescriptor

A new instance of this class with all the same property values as this instance

CopyFromSource(LayoutViewDescriptor)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(LayoutViewDescriptor source)
Parameters
Type Name Description
LayoutViewDescriptor source

The source object to copy all values from.

Implements

Extension Methods