Class LayoutDescriptorGroup

A container group within a LayoutDescriptor which can contain multiple other groups or LayoutViewDescriptor

Each LayoutTabSetting also has an associated group which is the top level group that hosts all the groups/views within the tab itself

Inheritance
System.Object
LayoutDescriptorGroup
Inherited Members
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
[DataContract]
public class LayoutDescriptorGroup : ICloneable, ICloneable<LayoutDescriptorGroup>, IHasLayoutPosition

Properties

AreChildrenTabbed

Returns true if there is more than one chil group/view and they all have a position of Center with percentages >= 100

Declaration
public bool AreChildrenTabbed { get; }
Property Value
Type Description
System.Boolean

Groups

A list of all the direct groups contained within thie group

Declaration
public IEnumerable<LayoutDescriptorGroup> Groups { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<LayoutDescriptorGroup>

HasHiddenViews

Returns true if any of the direct groups or views are currently hidden (as the UI may have to adjust for that)

Declaration
public bool HasHiddenViews { get; }
Property Value
Type Description
System.Boolean

HorizontalOrientation

Indicates the items in this group should be orientated horizontally if stacked together

Declaration
public bool HorizontalOrientation { get; set; }
Property Value
Type Description
System.Boolean

IsContainer

Indicates this group will be used as a container to host other groups

Declaration
public bool IsContainer { get; }
Property Value
Type Description
System.Boolean

Position

The position this group should take within a parent item

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

ProportionalHorizontalSize

The proportional percentage this group should take up of the Position in the horizontal space

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

ProportionalVerticalSize

The proportional percentage this group should take up of the Position in the vertical space

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

Views

A list of all the direct views contained within this group

Declaration
public IEnumerable<LayoutViewDescriptor> Views { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<LayoutViewDescriptor>

Methods

AddGroup(Boolean, LayoutDockPosition, Int32, Int32)

Creates and adds a new child group to this group with the specified IHasLayoutPosition properties

Declaration
public LayoutDescriptorGroup AddGroup(bool isContainer, LayoutDockPosition position, int proportionalVerticalSize, int proportionalHorizontalSize)
Parameters
Type Name Description
System.Boolean isContainer

Indicates this group will be used as a container to host other groups
LayoutDockPosition position

The position this new child group should take within this group
System.Int32 proportionalVerticalSize

The proportional percentage this new child group should take up of the position in the vertical space
System.Int32 proportionalHorizontalSize

The proportional percentage this new child group should take up of the position in the horizontal space
Returns
Type Description
LayoutDescriptorGroup

The new child group that has been added to this group

AddView(ViewDescriptorInstance, LayoutDockPosition, Int32, Int32)

Adds the specified viewDescriptor to this group with the specified IHasLayoutPosition properties

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

The descriptor of the view to add to this group within the layout
LayoutDockPosition position

The position this view should take within this group
System.Int32 proportionalVerticalSize

The proportional percentage this view should take up of the position in the vertical space
System.Int32 proportionalHorizontalSize

The proportional percentage this view should take up of the position in the horizontal space
Returns
Type Description
LayoutViewDescriptor

The view that has been added to this group

Clone()

Declaration
public LayoutDescriptorGroup Clone()
Returns
Type Description
LayoutDescriptorGroup

CopyFromSource(LayoutDescriptorGroup)

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

DeleteView(LayoutViewDescriptor)

Indicates that the specified view should be remvoed from this group

This works recursively, so if the view is not directly attached to this group then all child groups will be searched until the view is removed

Declaration
public void DeleteView(LayoutViewDescriptor view)
Parameters
Type Name Description
LayoutViewDescriptor view

The view to remove from this group layout

DeleteViewAndChildren(ViewDescriptorInstance)

Indicates that the specified view should be remvoed from this group, and all views that in turn are child views of that view should also be removed

This works recursively, so if the view is not directly attached to this group then all child groups will be searched until the view is removed

Declaration
public IEnumerable<ViewDescriptorInstance> DeleteViewAndChildren(ViewDescriptorInstance view)
Parameters
Type Name Description
ViewDescriptorInstance view

The view to remove from this group layout
Returns
Type Description
System.Collections.Generic.IEnumerable<ViewDescriptorInstance>

A list of all the views (and any sub-views) that were remvoed from this operation

DeleteViewAndChildren(LayoutViewDescriptor)

Indicates that the specified view should be remvoed from this group, and all views that in turn are child views of that view should also be removed

This works recursively, so if the view is not directly attached to this group then all child groups will be searched until the view is removed

Declaration
public IEnumerable<LayoutViewDescriptor> DeleteViewAndChildren(LayoutViewDescriptor view)
Parameters
Type Name Description
LayoutViewDescriptor view

The view to remove from this group layout
Returns
Type Description
System.Collections.Generic.IEnumerable<LayoutViewDescriptor>

A list of all the views (and any sub-views) that were remvoed from this operation

GetAllViewDescriptorLayouts()

Returns all view descriptors held within this group either directly or in any sub groups (found recursively)

Declaration
public IEnumerable<LayoutViewDescriptor> GetAllViewDescriptorLayouts()
Returns
Type Description
System.Collections.Generic.IEnumerable<LayoutViewDescriptor>

All view descriptors held within this group either directly or in any sub groups (found recursively)

GetViewChildren(LayoutViewDescriptor)

Returns all views that are direct child views of the specified view

Declaration
public IEnumerable<LayoutViewDescriptor> GetViewChildren(LayoutViewDescriptor view)
Parameters
Type Name Description
LayoutViewDescriptor view

The view to retrieve all direct child views of
Returns
Type Description
System.Collections.Generic.IEnumerable<LayoutViewDescriptor>

All views that are direct child views of the specified view

Explicit Interface Implementations

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
System.Object

ICloneable.CopyFromSource(Object)

Declaration
void ICloneable.CopyFromSource(object source)
Parameters
Type Name Description
System.Object source

Implements

Extension Methods