Class BadgeColumn<T>
Represents a column of badge components.
public class BadgeColumn<T> : TrinityColumn<BadgeColumn<T>, string>, ITrinityColumn, ITrinityComponent
Type Parameters
T
The type of the values stored in the column.
- Inheritance
-
BadgeColumn<T>
- Implements
- Derived
- Inherited Members
Constructors
BadgeColumn(string)
public BadgeColumn(string columnName)
Parameters
columnName
string
Properties
ComponentName
The component name in the front-end side.
public override string ComponentName { get; }
Property Value
Options
Gets or sets the list of options for the badge column.
public List<object>? Options { get; protected set; }
Property Value
Methods
SetOptions(params (T?, string, BadgeSeverityType, string?)[])
Sets the options for the badge column.
public BadgeColumn<T> SetOptions(params (T?, string, BadgeSeverityType, string?)[] options)
Parameters
options
(T, string, BadgeSeverityType, string)[]A collection of option values, their corresponding severity types, and their icons.
Returns
- BadgeColumn<T>
This BadgeColumn<T> instance.
Examples
SetOptions( ("draft", "Draft", BadgeSeverityType.Info, "pi pi-eraser") )
Remarks
SetOptions( (columnValue, LabelToDisplay, Severity, Icon) )
SetOptions(params (T?, string, BadgeSeverityType)[])
Sets the options for the badge column.
public BadgeColumn<T> SetOptions(params (T?, string, BadgeSeverityType)[] options)
Parameters
options
(T, string, BadgeSeverityType)[]A collection of option values and their corresponding severity types.
Returns
- BadgeColumn<T>
This BadgeColumn<T> instance.
Examples
SetOptions( ("draft", "Draft", BadgeSeverityType.Info) )
Remarks
SetOptions( (columnValue, LabelToDisplay, Severity) )
SetOptions(params (T?, string)[])
Sets the options for the badge column.
public BadgeColumn<T> SetOptions(params (T?, string)[] options)
Parameters
options
(T, string)[]A collection of option values and their corresponding severity types.
Returns
- BadgeColumn<T>
This BadgeColumn<T> instance.
Examples
SetOptions( ("draft", "Draft") )
Remarks
SetOptions( (columnValue, LabelToDisplay) )
SetSize(BadgeSizeType)
Sets the size of the badge column.
public BadgeColumn<T> SetSize(BadgeSizeType size)
Parameters
size
BadgeSizeTypeThe size of the badge column.
Returns
- BadgeColumn<T>
This BadgeColumn<T> instance.