Class LabelItem

Class representing a label in the plugin UI.

Inheritance

System.Object

LabelItem

Namespace: Emby.Web.GenericEdit.Elements

Assembly: Emby.Web.GenericEdit.dll

Syntax

public class LabelItem

Constructors

LabelItem()

Initializes a new instance of the LabelItem class.

Declaration

public LabelItem()

LabelItem(String)

Initializes a new instance of the LabelItem class.

Declaration

public LabelItem(string text)

Parameters

Type	Name	Description
System.String	text	The text.

Properties

CanHideInCompactView

Gets or sets a value indicating whether the label can be hidden in views with limited screen space.

Declaration

public bool CanHideInCompactView { get; set; }

Property Value

Type	Description
System.Boolean	true if this label can be hidden; otherwise, false.

Remarks

This is intentended for hiding elements in views (like TV mnode), where screen space is limited.

Apply this to non-essential elements only as there might be no way to make them visible at the client side.

HyperLink

Gets or sets the hyper link url.

Declaration

public string HyperLink { get; set; }

Property Value

Type	Description
System.String	The hyper link url.

Remarks

The URL will open externally. The behavior is app-specific. Not all client applications are able to show web content in external windows.

Icon

Gets or sets an icon for the button.

Declaration

public IconNames? Icon { get; set; }

Property Value

Type	Description
System.Nullable<IconNames>	The icon.

IsVisible

Gets or sets a value indicating whether the label is visible.

Declaration

public bool IsVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if the label is visible; otherwise, false.

StandardIcon

Gets or sets a standard icon.

Declaration

public StandardIcons? StandardIcon { get; set; }

Property Value

Type	Description
System.Nullable<StandardIcons>	The standard icon.

Remarks

If specified, takes precedence over the Icon property.

Text

Gets or sets the label text.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The text.

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)