Class TabSerializedParam

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

Inheritance
System.Object
SerializedParam
TabSerializedParam
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.Core
Assembly: ClientCore.dll
Syntax
[DataContract]
public class TabSerializedParam : SerializedParam, ICloneable, ICloneable<TabSerializedParam>

Properties

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

Name

The name of this tab

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

Visible

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

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

VisibleOnlyToRoles

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

Declaration
public IEnumerable<Guid> VisibleOnlyToRoles { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.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
System.Guid roleID

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

Clone()

Declaration
public TabSerializedParam Clone()
Returns
Type Description
TabSerializedParam

CopyFromParam(SerializedParam)

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

CopyFromSource(TabSerializedParam)

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

CreateNewParam()

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam
Overrides

EvaluateVisibilityFormula(DisplayableItemDescriptor)

Evaluates the if this tab should be visible or not against the specified displayedItem.

Stores the result internally and ensures IsVisible accounts for the correct formula evaluated value

Declaration
public Task EvaluateVisibilityFormula(DisplayableItemDescriptor displayedItem)
Parameters
Type Name Description
DisplayableItemDescriptor displayedItem

The current displayed item to process a formula against
Returns
Type Description
System.Threading.Tasks.Task

A task indicating the completion of the operation

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
System.Guid roleID

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

Implements

Extension Methods