Interface ILayoutDesignConfigure

If the client application IModelLayoutDisplayer also implements this interface then that allows the user to configure the layouts using the LayoutDesigner ( https://help.lemonedge.com/tool-window-layout-designer/)

This enables the designer to manipulate the layout by adding/removing/moving/changing views and tabs within the layout itself

Namespace: LemonEdge.Client.Core.Views.Core
Assembly: LemonEdge.ClientCore.dll
Syntax
public interface ILayoutDesignConfigure

Properties

CanLockDesign

Indicates the current layout is in a state valid for the layout to be locked.

Declaration
bool CanLockDesign { get; }
Property Value
Type Description
bool

LayoutDesignLocked

Indicates the layout itself is locked for modification and the user can not drag+drop views, or make other alterations

This is the default state for all layouts unless the user has otherwise indicated they want to modify the layout.

When this is set back to true, the system will update the internal LayoutDescriptor representation of the layout and its changes for serialization into a custom ILayout
Declaration
bool LayoutDesignLocked { get; set; }
Property Value
Type Description
bool

Methods

AddView(LayoutViewDescriptor)

Adds the specified view to the views displayed against this layout for the currently active tab

Declaration
void AddView(LayoutViewDescriptor view)
Parameters
Type Name Description
LayoutViewDescriptor view

The view to be added to the display against this layout for the currently active tab

Deleteviews(LayoutTabSetting, IEnumerable<ViewDescriptorInstance>)

Indicates the specified set of views within the specified tab should all be removed from the display

Declaration
void Deleteviews(LayoutTabSetting forTab, IEnumerable<ViewDescriptorInstance> views)
Parameters
Type Name Description
LayoutTabSetting forTab

The tab the specified views belong to
IEnumerable<ViewDescriptorInstance> views

The views to remove from the display for the specified tab

LoadNewTab(LayoutTabSetting)

Indicates the specified new tab should be added to the display for this layout

Declaration
void LoadNewTab(LayoutTabSetting tab)
Parameters
Type Name Description
LayoutTabSetting tab

The new tab to be added to the display

MoveTabLeft(LayoutTabSetting)

Indicates the specified existing tab should be increment towards being first in the list of all tabs for this layout.

Declaration
void MoveTabLeft(LayoutTabSetting tab)
Parameters
Type Name Description
LayoutTabSetting tab

The existing tab to increment towards being the first tab in the list of all tabs for this layout

MoveTabRight(LayoutTabSetting)

Indicates the specified existing tab should be decremented towards being last in the list of all tabs for this layout.

Declaration
void MoveTabRight(LayoutTabSetting tab)
Parameters
Type Name Description
LayoutTabSetting tab

The existing tab to decrement towards being the last tab in the list of all tabs for this layout

RemoveTab(LayoutTabSetting)

Indicates the specified existing tab should be removed from the display of this layout

Declaration
void RemoveTab(LayoutTabSetting tab)
Parameters
Type Name Description
LayoutTabSetting tab

The existing tab to be removed from the display

UpdateLayout(LayoutTabSetting, LayoutDescriptorGroup)

Forces the client application to translate the configured UI for the specified tab onto the newMainGroup instance describing the layout

Declaration
void UpdateLayout(LayoutTabSetting forTab, LayoutDescriptorGroup newMainGroup)
Parameters
Type Name Description
LayoutTabSetting forTab

The layout to update the configuration of from the current configured layout within the client ui
LayoutDescriptorGroup newMainGroup

The group for this tab that should reflect the new configuration from the client ui

UpdateView(ViewDescriptorInstance)

Updates the display for the specified view taking into account any setting changes

Declaration
void UpdateView(ViewDescriptorInstance view)
Parameters
Type Name Description
ViewDescriptorInstance view

The view to be updated in this display layout

Extension Methods