Struct LeaderboardColumn

One resolved, render-ready column of a leaderboard view: what it shows and how it is presented.

Implements

IEquatable<LeaderboardColumn>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Serenity.Leaderboard.Infrastructure.Views

Assembly: Serenity.UnityLeaderboard.Infrastructure.dll

Syntax

public readonly struct LeaderboardColumn : IEquatable<LeaderboardColumn>

Constructors

LeaderboardColumn(LeaderboardColumnKind, string, float, UiComponentAlignmentType, bool, string, bool, string, bool)

Creates a resolved column.

Declaration

public LeaderboardColumn(LeaderboardColumnKind kind, string headerText, float width, UiComponentAlignmentType alignment, bool isTranslatingHeaderText = false, string prefix = "", bool isTranslatingPrefix = false, string suffix = "", bool isTranslatingSuffix = false)

Parameters

Type	Name	Description
LeaderboardColumnKind	kind	Which piece of entry data this column renders.
string	headerText	Header text shown when the layout shows column headers.
float	width	Column width in reference-resolution pixels; zero sizes to content.
UiComponentAlignmentType	alignment	Horizontal alignment of this column's cells.
bool	isTranslatingHeaderText	Whether headerText is a localization key.
string	prefix	Text prepended to this column's cell value when carried by the caller.
bool	isTranslatingPrefix	Whether prefix is a localization key.
string	suffix	Text appended to this column's cell value when carried by the caller.
bool	isTranslatingSuffix	Whether suffix is a localization key.

Fields

Alignment

Horizontal alignment of this column's cells.

Declaration

public readonly UiComponentAlignmentType Alignment

Field Value

Type	Description
UiComponentAlignmentType

HeaderText

Header text shown above this column when the layout shows column headers.

Declaration

public readonly string HeaderText

Field Value

Type	Description
string

IsTranslatingHeaderText

Whether HeaderText is treated as a localization key and translated at runtime.

Declaration

public readonly bool IsTranslatingHeaderText

Field Value

Type	Description
bool

IsTranslatingPrefix

Whether Prefix is treated as a localization key and translated at runtime.

Declaration

public readonly bool IsTranslatingPrefix

Field Value

Type	Description
bool

IsTranslatingSuffix

Whether Suffix is treated as a localization key and translated at runtime.

Declaration

public readonly bool IsTranslatingSuffix

Field Value

Type	Description
bool

Kind

Which piece of entry data this column renders.

Declaration

public readonly LeaderboardColumnKind Kind

Field Value

Type	Description
LeaderboardColumnKind

Prefix

Text prepended to this column's cell value when its authored affix mode is Prefix or Both.

Declaration

public readonly string Prefix

Field Value

Type	Description
string

Suffix

Text appended to this column's cell value when its authored affix mode is Suffix or Both.

Declaration

public readonly string Suffix

Field Value

Type	Description
string

Width

Column width, in reference-resolution pixels. Zero sizes the column to its content.

Declaration

public readonly float Width

Field Value

Type	Description
float

Methods

Equals(LeaderboardColumn)

Declaration

public bool Equals(LeaderboardColumn other)

Parameters

Type	Name	Description
LeaderboardColumn	other

Returns

Type	Description
bool

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

ValueType.ToString()

Operators

operator ==(LeaderboardColumn, LeaderboardColumn)

Declaration

public static bool operator ==(LeaderboardColumn left, LeaderboardColumn right)

Parameters

Type	Name	Description
LeaderboardColumn	left
LeaderboardColumn	right

Returns

Type	Description
bool

operator !=(LeaderboardColumn, LeaderboardColumn)

Declaration

public static bool operator !=(LeaderboardColumn left, LeaderboardColumn right)

Parameters

Type	Name	Description
LeaderboardColumn	left
LeaderboardColumn	right

Returns

Type	Description
bool

Implements

IEquatable<T>