DataWeb
Search Results for

    Show / Hide Table of Contents

    Class ListWidget

    Inheritance
    object
    ListWidget
    CultureList
    CustomListWidget
    FileDownload
    FileRender
    Label
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: DataWeb.Structure
    Assembly: DataWeb.Core.dll
    Syntax
    public abstract class ListWidget

    Constructors

    ListWidget(Section, IServiceProvider)

    Declaration
    protected ListWidget(Section section, IServiceProvider serviceProvider)
    Parameters
    Type Name Description
    Section section
    IServiceProvider serviceProvider

    Fields

    section

    Declaration
    protected readonly Section section
    Field Value
    Type Description
    Section

    serviceProvider

    Declaration
    protected readonly IServiceProvider serviceProvider
    Field Value
    Type Description
    IServiceProvider

    Properties

    CustomListWidgetComponent

    Gets or sets the name of the custom list widget component.

    Declaration
    public string CustomListWidgetComponent { get; set; }
    Property Value
    Type Description
    string

    CustomListWidgetOptions

    Gets or sets the options for the custom list widget.

    Declaration
    public object CustomListWidgetOptions { get; set; }
    Property Value
    Type Description
    object

    DataField

    The data field associated with the list widget.

    Declaration
    public string DataField { get; set; }
    Property Value
    Type Description
    string

    DataSubField

    The data sub field associated with the list widget.

    Declaration
    public string DataSubField { get; set; }
    Property Value
    Type Description
    string

    DataType

    The data type associated with the list widget.

    Declaration
    public string DataType { get; set; }
    Property Value
    Type Description
    string

    FileTagName

    The name of the file tag associated with the list widget.

    Declaration
    public string FileTagName { get; set; }
    Property Value
    Type Description
    string

    IsVisibleRoles

    Indicates whether the list widget is visible to certain roles.

    Declaration
    public bool IsVisibleRoles { get; set; }
    Property Value
    Type Description
    bool

    ListWidgetClass

    Gets or sets the CSS class for the list widget.

    Declaration
    public string ListWidgetClass { get; set; }
    Property Value
    Type Description
    string

    Name

    The name of the list widget.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    string

    Title

    The title of the list widget.

    Declaration
    public string Title { get; set; }
    Property Value
    Type Description
    string

    Type

    The type of the list widget.

    Declaration
    public string Type { get; set; }
    Property Value
    Type Description
    string

    VisibleRoles

    The roles that have access to view the list widget.

    Declaration
    public string VisibleRoles { get; set; }
    Property Value
    Type Description
    string

    Methods

    IsProcessDeferredValue()

    Declaration
    public virtual bool IsProcessDeferredValue()
    Returns
    Type Description
    bool

    ProcessDeferredValueAsync(string, object, Navigation, NavigationContext, IEnumerable<UserSetting>, CancellationToken)

    Declaration
    public virtual Task<ListWidget.DetailValueResult> ProcessDeferredValueAsync(string itemId, object value, Navigation itemNavigation, NavigationContext listNavigationContext, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string itemId
    object value
    Navigation itemNavigation
    NavigationContext listNavigationContext
    IEnumerable<UserSetting> userSettings
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ListWidget.DetailValueResult>

    ProcessValue(string, object, Navigation, NavigationContext, IEnumerable<UserSetting>)

    Declaration
    public virtual object ProcessValue(string itemId, object value, Navigation itemNavigation, NavigationContext listNavigationContext, IEnumerable<UserSetting> userSettings)
    Parameters
    Type Name Description
    string itemId
    object value
    Navigation itemNavigation
    NavigationContext listNavigationContext
    IEnumerable<UserSetting> userSettings
    Returns
    Type Description
    object
    In this article
    Back to top Generated by DocFX