DataWeb
Search Results for

    Show / Hide Table of Contents

    Class View

    Represents a view in the application.

    Inheritance
    object
    View
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: DataWeb.Structure
    Assembly: DataWeb.Core.dll
    Syntax
    public sealed class View
    Remarks

    Creates a new instance of the View class with the specified view store.

    Constructors

    View(IViewStore)

    Represents a view in the application.

    Declaration
    public View(IViewStore viewStore)
    Parameters
    Type Name Description
    IViewStore viewStore

    The view store to use for retrieving view data.

    Remarks

    Creates a new instance of the View class with the specified view store.

    Properties

    Filters

    The filter string of the view.

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

    IdMaster

    Gets or sets the unique identifier.

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

    IsCompleted

    Whether the view is completed.

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

    Name

    The name of the view.

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

    Status

    The status of the view.

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

    Title

    The title of the view.

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

    VisibleRoles

    The roles that are allowed to view the view.

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

    Methods

    Init(ViewData)

    Initializes the view with the specified view data.

    Declaration
    public void Init(ViewData viewData)
    Parameters
    Type Name Description
    ViewData viewData

    The ViewData to initialize the view with.

    InitAsync(string, CancellationToken)

    Asynchronously initializes the view with the specified name.

    Declaration
    public Task InitAsync(string name, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string name

    The name of the view to initialize.

    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    A task representing the asynchronous initialization of the view.

    IsVisible(PermissionSet)

    Determines whether the view is visible to the user with the specified permission set.

    Declaration
    public bool IsVisible(PermissionSet permissionSet)
    Parameters
    Type Name Description
    PermissionSet permissionSet

    The PermissionSet of the user.

    Returns
    Type Description
    bool

    True if the view is visible to the user, otherwise false.

    Extension Methods

    StructureMapperExtension.ToViewInfo(View)
    In this article
    Back to top Generated by DocFX