Interface IModelLayoutHost

The main interface for hosting multiple IModelLayoutDisplayer instances. The IMainForm implements this too as the main display for hosting multiple IModelLayoutDisplayer instances

Inherited Members

IModelLayoutCommon.Refresh(bool)

IModelLayoutCommon.GetHost()

IModelLayoutCommon.Close(bool)

IModelLayoutCommon.Window

IBusyReporter.DisplayBusy(string)

IBusyReporter.StopBusy()

IBusyReporter.IsBusy

IDisposable.Dispose()

IWindow.CloseWindow()

IWindow.ShowDialog()

IWindow.Show()

IWindow.SetOwner(IWindow)

Namespace: LemonEdge.Client.Core.Views.Core

Assembly: LemonEdge.ClientCore.dll

Syntax

public interface IModelLayoutHost : IModelLayoutCommon, IBusyReporter, IDisposable, IWindow

Properties

Context

Gets the host context

Declaration

IHostContext Context { get; }

Property Value

Type	Description
IHostContext

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
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
Task<bool>	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
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

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)