Class CustomSettingsItem
The base item that is used for an Item in a LemonEdge.Client.Core.Views.Core.DisplayableItemDescriptorForCustomSettings instance
This custom item provides all the overrides to the properties the DisplayableItemDescriptor is responsible for so you have complete control of how to display any custom object
Should be marked with a LemonEdge.Client.Core.Views.Core.CustomSettingsItemLayoutInfoAttributeInheritance
Inherited Members
Namespace: LemonEdge.Client.UI.API.Views
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public abstract class CustomSettingsItem
Constructors
CustomSettingsItem()
Creates a new custom setting item
Declaration
public CustomSettingsItem()
CustomSettingsItem(SerializedParam)
Creates a new custom setting item with the specifed custom parameter
Declaration
public CustomSettingsItem(SerializedParam param = null)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | param | The optional custom parameters for this custom item |
Properties
HelpURL
The help url to be used for the HelpURL
Optionally can have a custom implementation from the inheriting class, the default value is ""
Declaration
public virtual string HelpURL { get; }
Property Value
Type | Description |
---|---|
string |
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 to be used for the GetLabel()
Requires a custom implementation from the inheriting class
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 |
LayoutDisplayParams
The optional name of the parameter of the layotu to be used for the LayoutDisplayParam
Optionally can have a custom implementation from the inheriting class, the default value is ""
Declaration
public virtual string LayoutDisplayParams { get; }
Property Value
Type | Description |
---|---|
string |
OverlayImageID
The optional overlay image to be used for the OverlayImageID
Optionally can have a custom implementation from the inheriting class, the default value is null
Declaration
public virtual Guid? OverlayImageID { get; }
Property Value
Type | Description |
---|---|
Guid? |
Params
Any custom parameters associated with this item that views in the IModelLayoutDisplayer can refer to
Declaration
public SerializedParam Params { get; set; }
Property Value
Type | Description |
---|---|
SerializedParam |