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

Inheritance
System.Object
LayoutTabSetting
Implements
System.ComponentModel.INotifyPropertyChanging
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts
Assembly: ClientCore.dll
Syntax
[DataContract(IsReference = true)]
public class LayoutTabSetting : ICloneable, ICloneable<LayoutTabSetting>, INotifyPropertyChanging, INotifyPropertyChanged

Properties

Creator

Obsolete.

The ILayoutCreator interface is no longer required and will be removed at a later date. Implement Loader instead

Declaration
[Obsolete("The ILayoutCreator interface is no longer required, implement Loader instead")]
public Func<LayoutDescriptorGroup, ILayoutCreator, Task> Creator { get; set; }
Property Value
Type Description
System.Func<LayoutDescriptorGroup, ILayoutCreator, System.Threading.Tasks.Task>

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
System.Boolean

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
System.Boolean

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
System.Func<LayoutDescriptorGroup, System.Threading.Tasks.Task>

Name

The name of this tab

Declaration
public string Name { get; set; }
Property Value
Type Description
System.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()

Declaration
public LayoutTabSetting Clone()
Returns
Type Description
LayoutTabSetting

CopyFromSource(LayoutTabSetting)

Declaration
public void CopyFromSource(LayoutTabSetting source)
Parameters
Type Name Description
LayoutTabSetting source

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

PropertyChanging

Declaration
public event PropertyChangingEventHandler PropertyChanging
Event Type
Type Description
System.ComponentModel.PropertyChangingEventHandler

Explicit Interface Implementations

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
System.Object

ICloneable.CopyFromSource(Object)

Declaration
void ICloneable.CopyFromSource(object source)
Parameters
Type Name Description
System.Object source

Implements

System.ComponentModel.INotifyPropertyChanging
System.ComponentModel.INotifyPropertyChanged

Extension Methods