Class ToolWindowItem

The base item that is used for an Item in a DisplayableItemDescriptorForToolWindow instance

This item simply indicates that this is the type of tool window to be loaded - it does not load anything itself so has no cost. That is the responsibility of the views in the IModelLayoutDisplayer for this tool window (which typically work against the active IModelLayoutDisplayer)

All implementations must also have a parameterless constructor so the system can determine the different types of layouts this LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForToolWindow supports (through an internal LemonEdge.Client.Core.Views.Core.IDisplayableDescriptorPossibleLayouts implementation)
Inheritance
object
ToolWindowItem
AuditHistoryToolWindow
LayoutDisplayerToolWindow
SafeStatusToolWindow
ToolWindowItemForSingleTabOrGridSelectedItem
Inherited Members
Namespace: LemonEdge.Client.UI.API.Views
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public abstract class ToolWindowItem

Constructors

ToolWindowItem(IRootController, IModelLayoutDisplayer?)

Create a new tool window item to work against the specified active layout displayer initially

Declaration
protected ToolWindowItem(IRootController rootController, IModelLayoutDisplayer? displayer = null)
Parameters
Type Name Description
IRootController rootController

The root app controller, for service access
IModelLayoutDisplayer displayer

The initial active layout displayer this tool window item is for

Fields

RootController

Declaration
protected readonly IRootController RootController
Field Value
Type Description
IRootController

Properties

Displayer

The current active IModelLayoutDisplayer this tool window is currently working against

This is automatically updated by the main system as the user selects different IModelLayoutDisplayer

Declaration
public IModelLayoutDisplayer? Displayer { get; set; }
Property Value
Type Description
IModelLayoutDisplayer

ImageID

The image to be used for the ImageID

Requires a custom implementation from the inheriting class

Declaration
public abstract Guid ImageID { get; }
Property Value
Type Description
Guid

Label

The label for this tool window IModelLayoutDisplayer to be used in the GetLabel()

Declaration
public abstract string Label { get; }
Property Value
Type Description
string

LayoutDiplayName

The key name of the layout to be used for the UniqueLayoutDisplayName

Requires a custom implementation from the inheriting class

Declaration
public abstract string LayoutDiplayName { get; }
Property Value
Type Description
string

UsesDisplayerContext

Indicates if this tool window should have access to, and use, the context of the IModelLayoutDisplayer it is currently working with

The default value returned is false indicating the tool window by default does not edit data within the context of the IModelLayoutDisplayer it is working against

Declaration
public virtual bool UsesDisplayerContext { get; }
Property Value
Type Description
bool

Extension Methods