Interface IDisplayableItemDescriptorFactory

Namespace: LemonEdge.Client.UI.API.Views.Factories

Assembly: LemonEdge.Client.UI.API.dll

Syntax

public interface IDisplayableItemDescriptorFactory

Properties

UIRestrictedMaxCollectionItems

Declaration

int? UIRestrictedMaxCollectionItems { get; set; }

Property Value

Type	Description
int?

Methods

ClearCache()

Clears the local cache of layouts so they are reloaded on next call

Declaration

Task ClearCache()

Returns

Type	Description
Task

CreateCollectionDefault(IEntityUpdater, Type)

Creates a LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForCollection<T> for the specified entity forType

Declaration

DisplayableItemDescriptor CreateCollectionDefault(IEntityUpdater context, Type forType)

Parameters

Type	Name	Description
IEntityUpdater	context	The context this collection should be loaded in, and that the IModelLayoutDisplayer should operate within
Type	forType	The type of entity this collection displayable item should display

Returns

Type	Description
DisplayableItemDescriptor	A LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForCollection<T> for the specified entity forType

CreateCustomSettingsDefault(IEntityUpdater, CustomSettingsItem)

Creates a LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForCustomSettings for the specified custom setting type item

Declaration

DisplayableItemDescriptor CreateCustomSettingsDefault(IEntityUpdater context, CustomSettingsItem item)

Parameters

Type	Name	Description
IEntityUpdater	context	The context this custom setting and the IModelLayoutDisplayer should operate within
CustomSettingsItem	item	The type of custom setting to be loaded

Returns

Type	Description
DisplayableItemDescriptor	A LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForCustomSettings for the specified custom setting type item

CreateForCollectionAny<T>(IEntityUpdater, string)

Declaration

DisplayableItemDescriptor CreateForCollectionAny<T>(IEntityUpdater context, string labelProperty) where T : class

Parameters

Type	Name	Description
IEntityUpdater	context
string	labelProperty

Returns

Type	Description
DisplayableItemDescriptor

Type Parameters

Name	Description
T

CreateSingleDefault(IEntityUpdater, object)

Creates a LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorSingle<T> for the specified entity item

Declaration

DisplayableItemDescriptor CreateSingleDefault(IEntityUpdater context, object item)

Parameters

Type	Name	Description
IEntityUpdater	context	The context this item belongs to, and that the IModelLayoutDisplayer should operate within
object	item	The single entity to be displayed in the IModelLayoutDisplayer

Returns

Type	Description
DisplayableItemDescriptor	A LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorSingle<T> for the specified entity item

CreateToolWindowDefault(IEntityUpdater, ToolWindowItem)

Creates a LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForToolWindow for the specified tool window type item

Declaration

DisplayableItemDescriptor CreateToolWindowDefault(IEntityUpdater context, ToolWindowItem item)

Parameters

Type	Name	Description
IEntityUpdater	context	The context this tool window and the IModelLayoutDisplayer should operate within
ToolWindowItem	item	The type of tool window to be loaded

Returns

Type	Description
DisplayableItemDescriptor	A LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForToolWindow for the specified tool window type item

GetAllDisplayableLayouts()

Returns all the possible layouts that are used by all implementations of DisplayableItemDescriptor

This is determined by enumerating all LemonEdge.Client.Core.Views.Core.IDisplayableDescriptorPossibleLayouts implementations

Declaration

Task<IEnumerable<DisplayableLayoutInfo>> GetAllDisplayableLayouts()

Returns

Type	Description
Task<IEnumerable<DisplayableLayoutInfo>>	All the possible layouts that are used by all implementations of DisplayableItemDescriptor

GetDisplayableType(string, string)

Returns the type of the item that is displayed against the specified layout key combination

Declaration

Task<Type> GetDisplayableType(string layoutName, string layoutParam)

Parameters

Type	Name	Description
string	layoutName	The unique name for the layout
string	layoutParam	Any optional parameters for the layout

Returns

Type	Description
Task<Type>	The type of the item that is displayed against the specified layout key combination

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)