Class TabSerializedParam

The parameter for a LayoutTabSetting within a LayoutDescriptor which describes a new tab to be displayed within the layout

Inheritance
object
SerializedParam
TabSerializedParam
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts.Core
Assembly: LemonEdge.Client.UI.API.dll
Syntax
[DataContract]
public class TabSerializedParam : SerializedParam, ICloneable, ICloneable<TabSerializedParam>, INotifyPropertyChanged

Constructors

TabSerializedParam()

Declaration
public TabSerializedParam()

Properties

FormulaVisibility

Holds the result executing the VisibilityFormula

Declaration
public bool FormulaVisibility { get; set; }
Property Value
Type Description
bool

IsVisible

Indicates if this tab is visible currently to the logged in user

All settings are taken into account including any VisibilityFormula if EvaluateVisibilityFormula(DisplayableItemDescriptor) has recently been run

Declaration
public bool IsVisible { get; }
Property Value
Type Description
bool

Name

The name of this tab

Declaration
public string? Name { get; set; }
Property Value
Type Description
string

VisibilityFormula

Holds a formula that should be dynamically evaluated at run time, to see if the tab should be visible or not

Declaration
public string? VisibilityFormula { get; set; }
Property Value
Type Description
string

Visible

Indicates if this tab should be visible within the UI or not

Declaration
public bool Visible { get; set; }
Property Value
Type Description
bool

VisibleOnlyToRoles

Indicates if this tab should only be visible to the following specified roles

Declaration
public IEnumerable<Guid> VisibleOnlyToRoles { get; }
Property Value
Type Description
IEnumerable<Guid>

Methods

AddVisibleOnlyToRole(Guid)

Adds the specified role id to the list of roles this tab is visible to from VisibleOnlyToRoles

Declaration
public void AddVisibleOnlyToRole(Guid roleID)
Parameters
Type Name Description
Guid roleID

The role id to add to the list of roles that can see this tab

Clone()

Creates a new instance of this class (of type TabSerializedParam) with all the same property values as this instance

Declaration
public TabSerializedParam Clone()
Returns
Type Description
TabSerializedParam

A new instance of this class with all the same property values as this instance

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(TabSerializedParam)

Updates all properties in this item to have the same properties as the source object.

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

The source object to copy all values from.

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

RemoveVisibleOnlyToRole(Guid)

Removes the specified role id from the list of roles this tab is visible to from VisibleOnlyToRoles

Declaration
public void RemoveVisibleOnlyToRole(Guid roleID)
Parameters
Type Name Description
Guid roleID

The role id to remove from the list of roles that can see this tab

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler? PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods