Class LeaderboardColumnSetting

One authored column of a leaderboard view: which entry data it renders and how it is presented.

Inheritance

object

LeaderboardColumnSetting

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.Leaderboard.Infrastructure.Settings

Assembly: Serenity.UnityLeaderboard.Infrastructure.dll

Syntax

public class LeaderboardColumnSetting

Constructors

LeaderboardColumnSetting()

Unity constructor. Use LeaderboardColumnSetting(LeaderboardColumnKind) from code.

Declaration

public LeaderboardColumnSetting()

LeaderboardColumnSetting(LeaderboardColumnKind)

Declaration

public LeaderboardColumnSetting(LeaderboardColumnKind forKind)

Parameters

Type	Name	Description
LeaderboardColumnKind	forKind

Properties

AffixMode

Whether this column wraps its cell value with a prefix and/or a suffix.

Declaration

public LeaderboardColumnAffixMode AffixMode { get; }

Property Value

Type	Description
LeaderboardColumnAffixMode

Alignment

Horizontal alignment of this column's cells.

Declaration

public UiComponentAlignmentType Alignment { get; }

Property Value

Type	Description
UiComponentAlignmentType

HeaderText

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

Declaration

public string HeaderText { get; }

Property Value

Type	Description
string

IsTranslatingHeaderText

Whether the header text is treated as a localization key and translated at runtime.

Declaration

public bool IsTranslatingHeaderText { get; }

Property Value

Type	Description
bool

IsTranslatingPrefix

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

Declaration

public bool IsTranslatingPrefix { get; }

Property Value

Type	Description
bool

IsTranslatingSuffix

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

Declaration

public bool IsTranslatingSuffix { get; }

Property Value

Type	Description
bool

Kind

Which piece of entry data this column renders.

Declaration

public LeaderboardColumnKind Kind { get; }

Property Value

Type	Description
LeaderboardColumnKind

Prefix

Text prepended to this column's cell value when AffixMode is Prefix or Both.

Declaration

public string Prefix { get; }

Property Value

Type	Description
string

Suffix

Text appended to this column's cell value when AffixMode is Suffix or Both.

Declaration

public string Suffix { get; }

Property Value

Type	Description
string

Visible

Whether this column is shown.

Declaration

public bool Visible { get; }

Property Value

Type	Description
bool

Width

Column width, in reference-resolution pixels; zero or above. Zero sizes to content.

Declaration

public float Width { get; }

Property Value

Type	Description
float

Methods

SetAffixMode(LeaderboardColumnAffixMode)

Sets the column's affix mode. Used by the Leaderboard View Designer.

Declaration

public void SetAffixMode(LeaderboardColumnAffixMode value)

Parameters

Type	Name	Description
LeaderboardColumnAffixMode	value

SetAlignment(UiComponentAlignmentType)

Sets the column's horizontal alignment. Used by the Leaderboard View Designer.

Declaration

public void SetAlignment(UiComponentAlignmentType value)

Parameters

Type	Name	Description
UiComponentAlignmentType	value

SetHeaderText(string)

Sets the column's header text. Used by the Leaderboard View Designer.

Declaration

public void SetHeaderText(string value)

Parameters

Type	Name	Description
string	value

SetIsTranslatingHeaderText(bool)

Sets whether the header text is translated. Used by the Leaderboard View Designer.

Declaration

public void SetIsTranslatingHeaderText(bool value)

Parameters

Type	Name	Description
bool	value

SetIsTranslatingPrefix(bool)

Sets whether the prefix is translated. Used by the Leaderboard View Designer.

Declaration

public void SetIsTranslatingPrefix(bool value)

Parameters

Type	Name	Description
bool	value

SetIsTranslatingSuffix(bool)

Sets whether the suffix is translated. Used by the Leaderboard View Designer.

Declaration

public void SetIsTranslatingSuffix(bool value)

Parameters

Type	Name	Description
bool	value

SetPrefix(string)

Sets the column's prefix text. Used by the Leaderboard View Designer.

Declaration

public void SetPrefix(string value)

Parameters

Type	Name	Description
string	value

SetSuffix(string)

Sets the column's suffix text. Used by the Leaderboard View Designer.

Declaration

public void SetSuffix(string value)

Parameters

Type	Name	Description
string	value

SetVisible(bool)

Sets whether this column is shown. Used by the Leaderboard View Designer.

Declaration

public void SetVisible(bool value)

Parameters

Type	Name	Description
bool	value

SetWidth(float)

Sets the column width. Used by the Leaderboard View Designer.

Declaration

public void SetWidth(float value)

Parameters

Type	Name	Description
float	value