Interface IModelLayouHost
The main interface for hosting multiple IModelLayoutDisplayer instances. The IMainform implements this too as the main display for hosting multiple IModelLayoutDisplayer instances
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Core
Assembly: ClientCore.dll
Syntax
public interface IModelLayouHost : IModelLayoutCommon, IBusyReporter, IDisposable, IWindow
Properties
Controller
The instance of the controller associated with this layout host
Declaration
ModelLayoutHostController Controller { get; }
Property Value
Type | Description |
---|---|
ModelLayoutHostController |
Methods
CloseLayout(IModelLayoutDisplayer)
Removes the specified layout from the layouts displayed by this host.
Declaration
void CloseLayout(IModelLayoutDisplayer layout)
Parameters
Type | Name | Description |
---|---|---|
IModelLayoutDisplayer | layout | The layout contained within this host to be removed from the UI |
DisplayItem(DisplayableItemDescriptor)
Displays the specified item
to the user within this host layout
If the item is already displayed that layout will be activated and presented to the user. If not a new IModelLayoutDisplayer is created, with an appropriate layout ILayoutGenerator, to display the item and present it to the user
Declaration
Task DisplayItem(DisplayableItemDescriptor item)
Parameters
Type | Name | Description |
---|---|---|
DisplayableItemDescriptor | item | The item to be displayed to the user |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task indicating the completion of the operation |
DisplaySingleLayoutItem(DisplayableItemDescriptor, DefaultLayoutGenerator)
Displays the specified item
in a new modal popup layout displayer (IModelSingleLayoutDisplayer) for the user to interact with, before returning to this one
Declaration
Task<bool> DisplaySingleLayoutItem(DisplayableItemDescriptor item, DefaultLayoutGenerator layout = null)
Parameters
Type | Name | Description |
---|---|---|
DisplayableItemDescriptor | item | The item to display to the user |
DefaultLayoutGenerator | layout | An optional layout to force to be used instead of the default one the system will select |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> | A task indicating if the user exited the popup by clicking OK, or Cancel |
OnLayoutsChanged(LayoutChangeEventArgs)
Raises the LayoutsChanged event, and updates the display depending on how the ayouts have changed
Declaration
void OnLayoutsChanged(LayoutChangeEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
LayoutChangeEventArgs | args | The arguments for how the layouts in this host have changed |
SelectLayout(IModelLayoutDisplayer)
Selects the specified layout and displays it to the user
Declaration
Task SelectLayout(IModelLayoutDisplayer layout)
Parameters
Type | Name | Description |
---|---|---|
IModelLayoutDisplayer | layout | The layout instance within this host to be displayed to the user |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task indicating the completion of the operation |
Events
LayoutsChanged
An event raised by this layout host to indicate that layouts it is displaying (IModelLayoutDisplayer) have changed
Declaration
event LayoutChangedEvent LayoutsChanged
Event Type
Type | Description |
---|---|
LayoutChangedEvent |