DevToys logo DevToys
  • Home
  • Blog
  • Documentation
  • Download
Search Results for

    Show / Hide Table of Contents

    Interface IUIDataGrid

    A component that represents a grid that can display data with rows and columns.

    Inherited Members
    IUITitledElement.Title
    IUITitledElement.TitleChanged
    IUIElementWithChildren.GetChildElementById(string)
    IUIElement.Id
    IUIElement.IsVisible
    IUIElement.IsEnabled
    IUIElement.HorizontalAlignment
    IUIElement.VerticalAlignment
    IUIElement.IsVisibleChanged
    IUIElement.IsEnabledChanged
    IUIElement.HorizontalAlignmentChanged
    IUIElement.VerticalAlignmentChanged
    Namespace: DevToys.Api
    Assembly: DevToys.Api.dll
    Syntax
    public interface IUIDataGrid : IUITitledElementWithChildren, IUITitledElement, IUIElementWithChildren, IUIElement

    Properties

    CanSelectRow

    Gets whether rows are selectable in the data grid. Default is true.

    Declaration
    bool CanSelectRow { get; }
    Property Value
    Type Description
    bool

    Columns

    Gets the title of each column in the data grid.

    Declaration
    string[] Columns { get; }
    Property Value
    Type Description
    string[]

    CommandBarExtraContent

    Gets an extra interactive content to display in the command bar of the text input.

    Declaration
    IUIElement? CommandBarExtraContent { get; }
    Property Value
    Type Description
    IUIElement

    IsExtendableToFullScreen

    Gets whether the element can be expanded to take the size of the whole tool boundaries. Default is false.

    Declaration
    bool IsExtendableToFullScreen { get; }
    Property Value
    Type Description
    bool
    Remarks

    When IsVisible is false and that the element is in full screen mode, the element goes back to normal mode.

    OnRowSelectedAction

    Gets the action to run when the user selects an row in the data grid.

    Declaration
    Func<IUIDataGridRow?, ValueTask>? OnRowSelectedAction { get; }
    Property Value
    Type Description
    Func<IUIDataGridRow, ValueTask>

    Rows

    Gets the list of rows displayed in the data grid.

    Declaration
    ObservableCollection<IUIDataGridRow> Rows { get; }
    Property Value
    Type Description
    ObservableCollection<IUIDataGridRow>

    SelectedRow

    Gets the selected row in the data grid.

    Declaration
    IUIDataGridRow? SelectedRow { get; }
    Property Value
    Type Description
    IUIDataGridRow

    Events

    CanSelectRowChanged

    Raised when CanSelectRow is changed.

    Declaration
    event EventHandler? CanSelectRowChanged
    Event Type
    Type Description
    EventHandler

    CommandBarExtraContentChanged

    Raised when CommandBarExtraContent is changed.

    Declaration
    event EventHandler? CommandBarExtraContentChanged
    Event Type
    Type Description
    EventHandler

    IsExtendableToFullScreenChanged

    Raised when IsExtendableToFullScreen is changed.

    Declaration
    event EventHandler? IsExtendableToFullScreenChanged
    Event Type
    Type Description
    EventHandler

    SelectedRowChanged

    Raised when SelectedRow is changed.

    Declaration
    event EventHandler? SelectedRowChanged
    Event Type
    Type Description
    EventHandler

    Extension Methods

    GUI.AlignHorizontally<T>(T, UIHorizontalAlignment)
    GUI.AlignVertically<T>(T, UIVerticalAlignment)
    GUI.AllowSelectItem(IUIDataGrid)
    GUI.CommandBarExtraContent(IUIDataGrid, IUIElement?)
    GUI.Disable<T>(T)
    GUI.Enable<T>(T)
    GUI.Extendable(IUIDataGrid)
    GUI.ForbidSelectItem(IUIDataGrid)
    GUI.Hide<T>(T)
    GUI.NotExtendable(IUIDataGrid)
    GUI.OnRowSelected(IUIDataGrid, Action<IUIDataGridRow?>?)
    GUI.OnRowSelected(IUIDataGrid, Func<IUIDataGridRow?, ValueTask>?)
    GUI.Select(IUIDataGrid, IUIDataGridRow?)
    GUI.Select(IUIDataGrid, int)
    GUI.Show<T>(T)
    GUI.Title<T>(T, string?)
    GUI.WithColumns(IUIDataGrid, params string[])
    GUI.WithRows(IUIDataGrid, params IUIDataGridRow[])
    LoggingExtensions.Log<T>(T)
    In this article
    DevToys logo © 2024 DevToys