Class LayoutDesigner
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers.ToolWindows
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class LayoutDesigner : ModelToolWindowController, IModelViewController, IHasToggleStatus, IDisposableConstructors
LayoutDesigner(IModelView)
Declaration
public LayoutDesigner(IModelView view)Parameters
| Type | Name | Description |
|---|---|---|
| IModelView | view |
Properties
ContextHelpURL
An optional associated url of a help file for the view this controller works with
Declaration
public override string ContextHelpURL { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
IsNewLayout
Declaration
public bool IsNewLayout { get; }Property Value
| Type | Description |
|---|---|
| bool |
SelectedItemForSubViews
The currently active IModelLayoutDisplayer main displayed item, or the selected grid item within it
Declaration
public override object SelectedItemForSubViews { get; }Property Value
| Type | Description |
|---|---|
| object |
Overrides
TrackLayoutTabChanging
Indicates this view needs to track the current active tab of the layout this tool window is working against.
This is required for view based tool windows such as the LayoutDesigner
The default value is false
Declaration
protected override bool TrackLayoutTabChanging { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Methods
Clear()
Clears the associated View back to an initial blank state
Declaration
public override Task Clear()Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |
Overrides
DisplayToolWindow(object)
Must be implemented by the inheriting controller to display the associated view
Declaration
public override Task DisplayToolWindow(object item)Parameters
| Type | Name | Description |
|---|---|---|
| object | item | The current item against the active layout, or selected grid item within the layout, this tool window is working against |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |
Overrides
GetAddableViews(ViewDescriptorInstance)
Declaration
public Task<IEnumerable<ViewDescriptorInstance>> GetAddableViews(ViewDescriptorInstance parent = null)Parameters
| Type | Name | Description |
|---|---|---|
| ViewDescriptorInstance | parent |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<ViewDescriptorInstance>> |
InitCommands(IList<ViewCommand>)
If TrackViewSelectedItems is true this adds a tool window command that toggles between this view working against the item of the currently active IModelLayoutDisplayer, or the selected grid item within it
Declaration
protected override void InitCommands(IList<ViewCommand> commands)Parameters
| Type | Name | Description |
|---|---|---|
| IList<ViewCommand> | commands | The current list of commands for this view |
Overrides
OnNameUpdate(string)
Declaration
public void OnNameUpdate(string newName)Parameters
| Type | Name | Description |
|---|---|---|
| string | newName |
OnTabChanged(IModelLayoutDisplayerController, LayoutTabChangedEventArgs)
Is called when the current tab against the currently active layout has been changed by the user
Only called if TrackLayoutTabChanging is true
Declaration
protected override void OnTabChanged(IModelLayoutDisplayerController source, LayoutTabChangedEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| IModelLayoutDisplayerController | source | The active layout displayer this tool window view is working against |
| LayoutTabChangedEventArgs | e | The arguments of the tab that has changed |