Class LayoutTabSetting
A tab within a LayoutDescriptor used for defining the view, and their arrangement, within this tab for viewing by a user in the client application
Has customizable TabSerializedParam parameters for configurable user settings of the tab itself
Inherited Members
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts.Core
Assembly: LemonEdge.Client.UI.API.dll
Syntax
[DataContract(IsReference = true)]
public class LayoutTabSetting : ICloneable, ICloneable<LayoutTabSetting>, INotifyPropertyChanging, INotifyPropertyChangedConstructors
LayoutTabSetting()
Declaration
public LayoutTabSetting()Properties
IsDisplayed
Indicates this tab has been displayed to the user at some point
Used by the system to keep track that this tab needs to be refreshed, or passed display information
Declaration
public bool IsDisplayed { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Loaded
Indicates this tab has already been loaded into the UI
Used by the system as tabs are dynamically loaded as users look at them to reduce client application resources and loading
Declaration
public bool Loaded { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Loader
If this tab is being dynamically generated from code, this function is used to create the LayoutDescriptorGroup when the tab is activated by the user
This is not loaded until it is needed, and may never be loaded if not looked at by the user
Declaration
public Func<LayoutDescriptorGroup, Task>? Loader { get; set; }Property Value
| Type | Description |
|---|---|
| Func<LayoutDescriptorGroup, Task> |
Name
The name of this tab
Declaration
public string? Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Param
The settings for this tab, including under what circumstances it is visible. Default implementation is always visible.
Declaration
public TabSerializedParam? Param { get; set; }Property Value
| Type | Description |
|---|---|
| TabSerializedParam |
Methods
Clone()
Creates a new instance of this class (of type LayoutTabSetting) with all the same property values as this instance
Declaration
public LayoutTabSetting Clone()Returns
| Type | Description |
|---|---|
| LayoutTabSetting | A new instance of this class with all the same property values as this instance |
CopyFromSource(LayoutTabSetting)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(LayoutTabSetting source)Parameters
| Type | Name | Description |
|---|---|---|
| LayoutTabSetting | source | The source object to copy all values from. |
Events
PropertyChanged
Declaration
public event PropertyChangedEventHandler? PropertyChangedEvent Type
| Type | Description |
|---|---|
| PropertyChangedEventHandler |
PropertyChanging
Declaration
public event PropertyChangingEventHandler? PropertyChangingEvent Type
| Type | Description |
|---|---|
| PropertyChangingEventHandler |