Interface IModelLayoutCommon

A common interface implemented by the IModelLayoutHost and IModelLayoutDisplayer for displaying items, closing, and getting the root host instance

Inherited Members
Namespace: LemonEdge.Client.UI.API.Layouts
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public interface IModelLayoutCommon : IBusyReporter, IDisposable

Properties

Window

The window in which this ui display implementation is hosted

Declaration
IWindow Window { get; }
Property Value
Type Description
IWindow

Methods

Close(bool)

Closes this display. If this is a IModelLayoutHost then this closes everything the host contains, and if this is the main application it will close that. If this is a displayer it will close that layout displayer.

Declaration
Task Close(bool silent = false)
Parameters
Type Name Description
bool silent

False indicates the user should be prompted to save any pending changes if the data to be closed contains changes, before processing the close
Returns
Type Description
Task

A task indicating the completion of the operation

GetHost()

Returns the root host this display is contained within. If this is a IModelLayoutHost implementation it will return itself. A displayer will return the host it is displayed within.

Declaration
IModelLayoutHost GetHost()
Returns
Type Description
IModelLayoutHost

The root host this display is contained within

Refresh(bool)

Causes the display for this item to be refreshed. For a host this refreshes the whole system, for an individual layout it refreshes that context and reloads the display

Declaration
Task Refresh(bool silent = false)
Parameters
Type Name Description
bool silent

False indicates the user should be prompted to save any pending changes if the data to be refreshed contains changes, before processing the refresh
Returns
Type Description
Task

A task indicating the completion of the operation

Extension Methods