Facebook
Twitter
Pinterest
Tumblr
GitHub
RSS
  • DEV Home
  • Documentation
  • Reference
  • Download
Search Results for

    Show / Hide Table of Contents

    Class GenericListItem

    Class representing a generic list item in the plugin UI.

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

    Constructors

    GenericListItem()

    Initializes a new instance of the GenericListItem class.

    Declaration
    public GenericListItem()

    GenericListItem(IconNames, String, String)

    Initializes a new instance of the GenericListItem class.

    Declaration
    public GenericListItem(IconNames icon, string primaryText, string secondaryText)
    Parameters
    Type Name Description
    IconNames icon

    The icon.

    System.String primaryText

    The primary text.

    System.String secondaryText

    The secondary text.

    GenericListItem(StandardIcons, String, String)

    Initializes a new instance of the GenericListItem class.

    Declaration
    public GenericListItem(StandardIcons icon, string primaryText, string secondaryText)
    Parameters
    Type Name Description
    StandardIcons icon

    The icon.

    System.String primaryText

    The primary text.

    System.String secondaryText

    The secondary text.

    Properties

    Button1

    Gets or sets the button1.

    Declaration
    public ButtonItem Button1 { get; set; }
    Property Value
    Type Description
    ButtonItem

    The button1.

    Button2

    Gets or sets the button2.

    Declaration
    public ButtonItem Button2 { get; set; }
    Property Value
    Type Description
    ButtonItem

    The button2.

    HasPercentage

    Gets or sets a value indicating whether this instance has percentage.

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

    true if this instance has percentage; otherwise, false.

    Remarks

    If set to true, a progressbar will be shown across the content area.

    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 be followed, unless HyperLinkTargetExternal is set, causing it to be opened externally. The exect behavior is app-specific. Not all client applications are able to show web content in external windows.

    HyperLinkTargetExternal

    Gets or sets a value indicating whether the hyper link target will be opened externally.

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

    true to open the hyper link target externally; otherwise, false.

    Icon

    Gets or sets an icon for the button.

    Declaration
    public IconNames? Icon { get; set; }
    Property Value
    Type Description
    System.Nullable<IconNames>

    The icon.

    IconMode

    Gets or sets the icon mode.

    Declaration
    public ItemListIconMode IconMode { get; set; }
    Property Value
    Type Description
    ItemListIconMode

    The icon mode.

    PercentComplete

    Gets or sets the percent complete value.

    Declaration
    public int PercentComplete { get; set; }
    Property Value
    Type Description
    System.Int32

    The percent complete value.

    Remarks

    Controls the state of the progress bar if HasPercentage it set to true.

    PrimaryText

    Gets or sets the primary text.

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

    The primary text.

    SecondaryText

    Gets or sets the secondary text.

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

    The secondary text.

    ShowSecondaryFirst

    Gets or sets a value indicating whether to show the secondary text first.

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

    true to show the secondary text first; 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.

    Status

    Gets or sets the status.

    Declaration
    public ItemStatus Status { get; set; }
    Property Value
    Type Description
    ItemStatus

    The status.

    SubItems

    Gets or sets the sub items.

    Declaration
    public List<GenericListItem> SubItems { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<GenericListItem>

    The sub items.

    Remarks

    This allows nested list presentation.

    Tag

    Gets or sets the tag.

    Declaration
    public TagItem Tag { get; set; }
    Property Value
    Type Description
    TagItem

    The tag.

    Toggle

    Gets or sets the toggle item.

    Declaration
    public ToggleButtonItem Toggle { get; set; }
    Property Value
    Type Description
    ToggleButtonItem

    The toggle item.

    Extension Methods

    Extensions.JsonClone<T>(T, IJsonSerializer)
    SDK
    On this Page
    Back to Top Copyright 2022 © EMBY LLC. Please see our terms of use and privacy policy.