Class CaptionItem

Class representing a caption in the plugin UI.

Inheritance
System.Object
CaptionItem
Namespace: Emby.Web.GenericEdit.Elements
Assembly: Emby.Web.GenericEdit.dll
Syntax
public class CaptionItem

Constructors

CaptionItem()

Initializes a new instance of the CaptionItem class.

Declaration
public CaptionItem()

CaptionItem(String)

Initializes a new instance of the CaptionItem class.

Declaration
public CaptionItem(string caption)
Parameters
Type Name Description
System.String caption

The caption.

Properties

CanHideInCompactView

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

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

true if this caption 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.

Caption

Gets or sets the caption text.

Declaration
public string Caption { get; set; }
Property Value
Type Description
System.String

The caption text.

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 caption is visible.

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

true if the caption 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.

Extension Methods