Class GUI
Provides a set of extension methods for various UI components.
Assembly: DevToys.Api.dll
Syntax
Properties
Auto
A grid length definition that automatically fits to its content.
Declaration
public static UIGridLength Auto { get; }
Property Value
Methods
Sets the button to appear as accented.
Declaration
public static IUIButton AccentAppearance(this IUIButton element)
Parameters
Returns
AlignHorizontally<T>(T, UIHorizontalAlignment)
Align the element horizontally.
Declaration
public static T AlignHorizontally<T>(this T element, UIHorizontalAlignment alignment) where T : IUIElement
Parameters
Returns
Type Parameters
AlignVertically<T>(T, UIVerticalAlignment)
Align the element vertically.
Declaration
public static T AlignVertically<T>(this T element, UIVerticalAlignment alignment) where T : IUIElement
Parameters
Returns
Type Parameters
AllowSelectItem(IUIDataGrid)
Allows the user to select a row in the data grid.
Declaration
public static IUIDataGrid AllowSelectItem(this IUIDataGrid element)
Parameters
Returns
AllowSelectItem(IUIList)
Allows the user to select an item in the list.
Declaration
public static IUIList AllowSelectItem(this IUIList element)
Parameters
| Type |
Name |
Description |
| IUIList |
element |
|
Returns
AlwaysShowLineNumber(IUIMultiLineTextInput)
Indicates that the line number should always be displayed in the editor.
Declaration
public static IUIMultiLineTextInput AlwaysShowLineNumber(this IUIMultiLineTextInput element)
Parameters
Returns
AlwaysWrap(IUIMultiLineTextInput)
Indicates that the text in the editor will always wrap when it reaches the border of the editor.
Declaration
public static IUIMultiLineTextInput AlwaysWrap(this IUIMultiLineTextInput element)
Parameters
Returns
AutoLineNumber(IUIMultiLineTextInput)
Indicates that the line number should be automatically shown or hidden depending on the user's settings.
Declaration
public static IUIMultiLineTextInput AutoLineNumber(this IUIMultiLineTextInput element)
Parameters
Returns
AutoWrap(IUIMultiLineTextInput)
Indicates that the text in the editor will wrap automatically according to the user's settings.
Declaration
public static IUIMultiLineTextInput AutoWrap(this IUIMultiLineTextInput element)
Parameters
Returns
BottomPaneLength(IUISplitGrid, UIGridLength)
Set the length of the bottom pane.
Declaration
public static IUISplitGrid BottomPaneLength(this IUISplitGrid element, UIGridLength length)
Parameters
Returns
Create a component that represents a button, which reacts when clicking on it.
Declaration
public static IUIButton Button()
Returns
Create a component that represents a button, which reacts when clicking on it.
Declaration
public static IUIButton Button(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Create a component that represents a button, which reacts when clicking on it.
Declaration
public static IUIButton Button(string? id, string text)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
text |
The text to display in the button.
|
Returns
CanCopyWhenEditable<T>(T)
Shows the "copy" button when the editor is editable.
Declaration
public static T CanCopyWhenEditable<T>(this T element) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
CanSelectManyFiles(IUIFileSelector)
Allows the user to select multiple files at once.
Declaration
public static IUIFileSelector CanSelectManyFiles(this IUIFileSelector element)
Parameters
Returns
CanSelectOneFile(IUIFileSelector)
Allows the user to select only one file at once.
Declaration
public static IUIFileSelector CanSelectOneFile(this IUIFileSelector element)
Parameters
Returns
CannotCopyWhenEditable<T>(T)
Hides the "copy" button when the editor is editable.
Declaration
public static T CannotCopyWhenEditable<T>(this T element) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
Card(IUIElement)
A component that represents an empty card and IUIElement for the option value.
Declaration
public static IUICard Card(IUIElement uiElement)
Parameters
| Type |
Name |
Description |
| IUIElement |
uiElement |
The UI element to display.
|
Returns
Card(string?, IUIElement)
A component that represents an empty card and IUIElement for the option value.
Declaration
public static IUICard Card(string? id, IUIElement uiElement)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| IUIElement |
uiElement |
The UI element to display.
|
Returns
Cell()
Create a component hosted by a IUIGrid that represents a cell in a flexible grid.
Declaration
public static IUIGridCell Cell()
Returns
Cell(IUIElement)
Declaration
public static IUIDataGridCell Cell(IUIElement uiElement)
Parameters
| Type |
Name |
Description |
| IUIElement |
uiElement |
The element to display in the cell.
|
Returns
Cell(int, int, int, int, IUIElement?)
Create a component hosted by a IUIGrid that represents a cell in a flexible grid.
Declaration
public static IUIGridCell Cell(int row, int column, int rowSpan, int columnSpan, IUIElement? child = null)
Parameters
| Type |
Name |
Description |
| int |
row |
The row alignment of the cell.
|
| int |
column |
The column alignment of the cell.
|
| int |
rowSpan |
A value that indicates the total number of rows that the cell content spans within the parent grid.
|
| int |
columnSpan |
A value that indicates the total number of columns that the cell content spans within the parent grid.
|
| IUIElement |
child |
The child element to display in the cell.
|
Returns
Cell(string?)
Declaration
public static IUIDataGridCell Cell(string? text)
Parameters
| Type |
Name |
Description |
| string |
text |
The text to display in the cell.
|
Returns
Cell<TRow, TColumn>(TRow, TRow, TColumn, TColumn?, IUIElement?)
Create a component hosted by a IUIGrid that represents a cell in a flexible grid.
Declaration
public static IUIGridCell Cell<TRow, TColumn>(TRow firstRow, TRow lastRow, TColumn firstColumn, TColumn? lastColumn = default, IUIElement? child = null) where TRow : Enum where TColumn : Enum
Parameters
| Type |
Name |
Description |
| TRow |
firstRow |
The first row where the cell should appear.
|
| TRow |
lastRow |
The last row where the cell should appear.
|
| TColumn |
firstColumn |
The first column where the cell should appear.
|
| TColumn |
lastColumn |
The last column where the cell should appear.
|
| IUIElement |
child |
The child element to display in the cell.
|
Returns
Type Parameters
| Name |
Description |
| TRow |
|
| TColumn |
|
Cell<TRow, TColumn>(TRow, TColumn, IUIElement?)
Create a component hosted by a IUIGrid that represents a cell in a flexible grid.
Declaration
public static IUIGridCell Cell<TRow, TColumn>(TRow row, TColumn column, IUIElement? child = null) where TRow : Enum where TColumn : Enum
Parameters
| Type |
Name |
Description |
| TRow |
row |
The row where the cell should be placed.
|
| TColumn |
column |
The column where the cell should be placed.
|
| IUIElement |
child |
The child element to display in the cell.
|
Returns
Type Parameters
| Name |
Description |
| TRow |
|
| TColumn |
|
Cells(IUIGrid, params IUIGridCell[])
Sets the cells in the grid.
Declaration
public static IUIGrid Cells(this IUIGrid element, params IUIGridCell[] cells)
Parameters
Returns
Clear(IUIImageViewer)
Declaration
public static IUIImageViewer Clear(this IUIImageViewer element)
Parameters
Returns
Closable(IUIInfoBar)
Makes the bar closable explicitly by the user.
Declaration
public static IUIInfoBar Closable(this IUIInfoBar element)
Parameters
Returns
Close(IUIInfoBar)
Declaration
public static IUIInfoBar Close(this IUIInfoBar element)
Parameters
Returns
Column(IUIGridCell, int)
Sets the column alignment of the cell.
Declaration
public static IUIGridCell Column(this IUIGridCell element, int column)
Parameters
Returns
ColumnLargeSpacing(IUIGrid)
Sets a large spacing between columns.
Declaration
public static IUIGrid ColumnLargeSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
ColumnMediumSpacing(IUIGrid)
Sets a medium spacing between columns.
Declaration
public static IUIGrid ColumnMediumSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
ColumnNoSpacing(IUIGrid)
Sets no spacing between columns.
Declaration
public static IUIGrid ColumnNoSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
ColumnSmallSpacing(IUIGrid)
Sets a small spacing between columns.
Declaration
public static IUIGrid ColumnSmallSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
ColumnSpan(IUIGridCell, int)
Sets a value that indicates the total number of columns that the cell content spans within the parent grid.
Declaration
public static IUIGridCell ColumnSpan(this IUIGridCell element, int columns)
Parameters
Returns
Columns(IUIGrid, params UIGridLength[])
Declaration
public static IUIGrid Columns(this IUIGrid element, params UIGridLength[] widths)
Parameters
Returns
Columns<TEnum>(IUIGrid, params (TEnum name, UIGridLength width)[])
Declaration
public static IUIGrid Columns<TEnum>(this IUIGrid element, params (TEnum name, UIGridLength width)[] columns) where TEnum : Enum
Parameters
Returns
Type Parameters
CommandBarExtraContent(IUIDataGrid, IUIElement?)
Defines an additional element to display in the command bar.
Declaration
public static IUIDataGrid CommandBarExtraContent(this IUIDataGrid element, IUIElement? extraElement)
Parameters
Returns
CommandBarExtraContent<T>(T, IUIElement?)
Defines an additional element to display in the command bar.
Declaration
public static T CommandBarExtraContent<T>(this T element, IUIElement? extraElement) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
| IUIElement |
extraElement |
|
Returns
Type Parameters
DataGrid()
A component that represents a grid that can display data in with rows and columns.
Declaration
public static IUIDataGrid DataGrid()
Returns
DataGrid(string?)
A component that represents a grid that can display data in with rows and columns.
Declaration
public static IUIDataGrid DataGrid(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Description(IUIInfoBar, string?)
Declaration
public static IUIInfoBar Description(this IUIInfoBar element, string? description)
Parameters
Returns
Description(IUISetting, string?)
Declaration
public static IUISetting Description(this IUISetting element, string? text)
Parameters
Returns
Description(IUISettingGroup, string?)
Declaration
public static IUISettingGroup Description(this IUISettingGroup element, string? description)
Parameters
Returns
DiffTextInput()
A component that can be used to display side by side or inlined texts and highlight differences between them.
Declaration
public static IUIDiffTextInput DiffTextInput()
Returns
DiffTextInput(string?)
A component that can be used to display side by side or inlined texts and highlight differences between them.
Declaration
public static IUIDiffTextInput DiffTextInput(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Disable<T>(T)
Disable the element and its child elements.
Declaration
public static T Disable<T>(this T element) where T : IUIElement
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
Create a component that represents a drop down button where the user can click on a menu item.
Declaration
public static IUIDropDownButton DropDownButton()
Returns
Create a component that represents a drop down button where the user can click on a menu item.
Declaration
public static IUIDropDownButton DropDownButton(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Create a component that represents a drop down button where the user can click on a menu item.
Declaration
public static IUIDropDownButton DropDownButton(string? id, string text)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
text |
The text to display in the drop down button.
|
Returns
Create a component that represents a menu item, which reacts when clicking on it.
Declaration
public static IUIDropDownMenuItem DropDownMenuItem()
Returns
Create a component that represents a menu item, which reacts when clicking on it.
Declaration
public static IUIDropDownMenuItem DropDownMenuItem(string text)
Parameters
| Type |
Name |
Description |
| string |
text |
The text to display in the menu item.
|
Returns
Editable<T>(T)
Sets the text input control as editable.
Declaration
public static T Editable<T>(this T element) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
Enable<T>(T)
Enable the element and its child elements.
Declaration
public static T Enable<T>(this T element) where T : IUIElement
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
Error(IUIInfoBar)
Declaration
public static IUIInfoBar Error(this IUIInfoBar element)
Parameters
Returns
Extendable(IUIDataGrid)
Indicates that the control can be extended to take the size of the whole tool boundaries.
Declaration
public static IUIDataGrid Extendable(this IUIDataGrid element)
Parameters
Returns
Extendable(IUIDiffTextInput)
Indicates that the control can be extended to take the size of the whole tool boundaries.
Declaration
public static IUIDiffTextInput Extendable(this IUIDiffTextInput element)
Parameters
Returns
Extendable(IUIMultiLineTextInput)
Indicates that the control can be extended to take the size of the whole tool boundaries.
Declaration
public static IUIMultiLineTextInput Extendable(this IUIMultiLineTextInput element)
Parameters
Returns
FileSelector()
Create a component that represents a drop zone and selector for files, folders, images coming from the clipboard.
Declaration
public static IUIFileSelector FileSelector()
Returns
FileSelector(string?)
Create a component that represents a drop zone and selector for files, folders, images coming from the clipboard.
Declaration
public static IUIFileSelector FileSelector(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
FontName(IUIIcon, string)
Declaration
public static IUIIcon FontName(this IUIIcon element, string fontName)
Parameters
Returns
ForbidSelectItem(IUIDataGrid)
Prevents the user from selecting a row in the data grid.
Declaration
public static IUIDataGrid ForbidSelectItem(this IUIDataGrid element)
Parameters
Returns
ForbidSelectItem(IUIList)
Prevents the user from selecting an item in the list.
Declaration
public static IUIList ForbidSelectItem(this IUIList element)
Parameters
| Type |
Name |
Description |
| IUIList |
element |
|
Returns
Fraction(int)
A grid length definition that is sized as a weighted proportion of available space.
Declaration
public static UIGridLength Fraction(int value)
Parameters
| Type |
Name |
Description |
| int |
value |
|
Returns
Glyph(IUIIcon, char)
Sets the Glyph of the icon.
Declaration
public static IUIIcon Glyph(this IUIIcon element, char glyph)
Parameters
Returns
Grid()
A component provides a flexible grid area that consists of columns and rows.
Child elements of the Grid are measured and arranged according to their row/column assignments and other logic.
Declaration
public static IUIGrid Grid()
Returns
Grid(string?)
A component provides a flexible grid area that consists of columns and rows.
Child elements of the Grid are measured and arranged according to their row/column assignments and other logic.
Declaration
public static IUIGrid Grid(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Handle(IUISetting, ISettingsProvider, SettingDefinition<bool>, Action<bool>)
Declaration
public static IUISetting Handle(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<bool> settingDefinition, Action<bool> onToggled)
Parameters
Returns
Remarks
Handle(IUISetting, ISettingsProvider, SettingDefinition<bool>, Func<bool, ValueTask>?)
Declaration
public static IUISetting Handle(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<bool> settingDefinition, Func<bool, ValueTask>? onToggled = null)
Parameters
Returns
Remarks
Handle(IUISetting, ISettingsProvider, SettingDefinition<bool>, string?, string?, Action<bool>?)
Declaration
public static IUISetting Handle(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<bool> settingDefinition, string? stateDescriptionWhenOn, string? stateDescriptionWhenOff, Action<bool>? onToggled)
Parameters
Returns
Remarks
Handle(IUISetting, ISettingsProvider, SettingDefinition<bool>, string?, string?, Func<bool, ValueTask>?)
Declaration
public static IUISetting Handle(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<bool> settingDefinition, string? stateDescriptionWhenOn, string? stateDescriptionWhenOff, Func<bool, ValueTask>? onToggled = null)
Parameters
Returns
Remarks
Handle(IUISettingGroup, ISettingsProvider, SettingDefinition<bool>, Action<bool>?)
Declaration
public static IUISettingGroup Handle(this IUISettingGroup element, ISettingsProvider settingsProvider, SettingDefinition<bool> settingDefinition, Action<bool>? onToggled = null)
Parameters
Returns
Handle(IUISettingGroup, ISettingsProvider, SettingDefinition<bool>, Func<bool, ValueTask>?)
Declaration
public static IUISettingGroup Handle(this IUISettingGroup element, ISettingsProvider settingsProvider, SettingDefinition<bool> settingDefinition, Func<bool, ValueTask>? onToggled = null)
Parameters
Returns
Handle<T>(IUISetting, ISettingsProvider, SettingDefinition<T>, Action<T>?, params IUIDropDownListItem[])
Declaration
public static IUISetting Handle<T>(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<T> settingDefinition, Action<T>? onOptionSelected, params IUIDropDownListItem[] dropDownListItems)
Parameters
| Type |
Name |
Description |
| IUISetting |
element |
The IUISetting instance.
|
| ISettingsProvider |
settingsProvider |
The settings provider used for handling the given settingDefinition.
|
| SettingDefinition<T> |
settingDefinition |
The definition of the setting to associate to this IUISetting.
|
| Action<T> |
onOptionSelected |
(optional) A method to invoke when the setting value changed.
|
| IUIDropDownListItem[] |
dropDownListItems |
(optional) A list of items to be displayed in the drop down list. Value should be of type T.
|
Returns
Type Parameters
Remarks
Handle<T>(IUISetting, ISettingsProvider, SettingDefinition<T>, Func<T, ValueTask>?, params IUIDropDownListItem[])
Declaration
public static IUISetting Handle<T>(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<T> settingDefinition, Func<T, ValueTask>? onOptionSelected, params IUIDropDownListItem[] dropDownListItems)
Parameters
Returns
Type Parameters
Remarks
Handle<T>(IUISettingGroup, ISettingsProvider, SettingDefinition<T>, Action<T>?, params IUIDropDownListItem[])
Declaration
public static IUISettingGroup Handle<T>(this IUISettingGroup element, ISettingsProvider settingsProvider, SettingDefinition<T> settingDefinition, Action<T>? onOptionSelected, params IUIDropDownListItem[] dropDownListItems) where T : struct, IConvertible
Parameters
Returns
Type Parameters
| Name |
Description |
| T |
The type of the setting value.
|
Handle<T>(IUISettingGroup, ISettingsProvider, SettingDefinition<T>, Func<T, ValueTask>?, params IUIDropDownListItem[])
Declaration
public static IUISettingGroup Handle<T>(this IUISettingGroup element, ISettingsProvider settingsProvider, SettingDefinition<T> settingDefinition, Func<T, ValueTask>? onOptionSelected, params IUIDropDownListItem[] dropDownListItems) where T : struct, IConvertible
Parameters
Returns
Type Parameters
| Name |
Description |
| T |
The type of the setting value.
|
HideCommandBar<T>(T)
Declaration
public static T HideCommandBar<T>(this T element) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
HideIcon(IUIInfoBar)
Hides the icon of the bar.
Declaration
public static IUIInfoBar HideIcon(this IUIInfoBar element)
Parameters
Returns
Hide<T>(T)
Declaration
public static T Hide<T>(this T element) where T : IUIElement
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
Highlight(IUIMultiLineTextInput, params UIHighlightedTextSpan[])
Sets the list of spans to highlight in the text document.
Declaration
public static IUIMultiLineTextInput Highlight(this IUIMultiLineTextInput element, params UIHighlightedTextSpan[] spans)
Parameters
Returns
Horizontal(IUISplitGrid)
Declaration
public static IUISplitGrid Horizontal(this IUISplitGrid element)
Parameters
Returns
Horizontal(IUIStack)
Declaration
public static IUIStack Horizontal(this IUIStack element)
Parameters
Returns
HoverTooltip(IUIMultiLineTextInput, params UIHoverTooltip[])
Sets the list of tooltips to display on Word hover in the text document.
Declaration
public static IUIMultiLineTextInput HoverTooltip(this IUIMultiLineTextInput element, params UIHoverTooltip[] tooltips)
Parameters
Returns
Sets the button to appear as a hyperlink.
Declaration
public static IUIButton HyperlinkAppearance(this IUIButton element)
Parameters
Returns
Sets the icon of the button.
Declaration
public static IUIButton Icon(this IUIButton element, string fontName, char glyph)
Parameters
| Type |
Name |
Description |
| IUIButton |
element |
The IUIButton instance.
|
| string |
fontName |
The name of the font containing the icon.
|
| char |
glyph |
The glyph corresponding to the icon in the fontName.
|
Returns
Sets the icon of the drop down button.
Declaration
public static IUIDropDownButton Icon(this IUIDropDownButton element, string fontName, char glyph)
Parameters
Returns
Sets the icon of the menu item.
Declaration
public static IUIDropDownMenuItem Icon(this IUIDropDownMenuItem element, string fontName, char glyph)
Parameters
Returns
Icon(IUISetting, string, char)
Sets the Icon of the setting.
Declaration
public static IUISetting Icon(this IUISetting element, string fontName, char glyph)
Parameters
Returns
Icon(IUISettingGroup, string, char)
Sets the Icon of the setting.
Declaration
public static IUISettingGroup Icon(this IUISettingGroup element, string fontName, char glyph)
Parameters
Returns
Icon(string, char)
A component that represents an icon.
Declaration
public static IUIIcon Icon(string fontName, char glyph)
Parameters
| Type |
Name |
Description |
| string |
fontName |
The name of the font containing the icon.
|
| char |
glyph |
The glyph corresponding to the icon
|
Returns
Icon(string?, string, char)
A component that represents an icon.
Declaration
public static IUIIcon Icon(string? id, string fontName, char glyph)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
fontName |
The name of the font containing the icon.
|
| char |
glyph |
The glyph corresponding to the icon
|
Returns
ImageViewer()
A component that displays an image and allows the user to perform some read-only actions on it.
By default, image viewer supports BMP, GIF, JPEG, PBM, PNG, TIFF, TGA, WEBP, SVG formats.
Declaration
public static IUIImageViewer ImageViewer()
Returns
ImageViewer(string?)
A component that displays an image and allows the user to perform some read-only actions on it.
By default, image viewer supports BMP, GIF, JPEG, PBM, PNG, TIFF, TGA, WEBP, SVG formats.
Declaration
public static IUIImageViewer ImageViewer(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
InfoBar()
Create a component that displays a bar aiming at indicating a relevant information to the user.
Declaration
public static IUIInfoBar InfoBar()
Returns
InfoBar(string?)
Create a component that displays a bar aiming at indicating a relevant information to the user.
Declaration
public static IUIInfoBar InfoBar(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
InfoBar(string?, string)
Create a component that displays a bar aiming at indicating a relevant information to the user.
Declaration
public static IUIInfoBar InfoBar(string? id, string title)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
title |
The title to display in the bar.
|
Returns
InfoBar(string?, string, string)
Create a component that displays a bar aiming at indicating a relevant information to the user.
Declaration
public static IUIInfoBar InfoBar(string? id, string title, string description)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
title |
The title to display in the bar.
|
| string |
description |
The description to display in the bar.
|
Returns
InfoBar(string?, string, string, UIInfoBarSeverity)
Create a component that displays a bar aiming at indicating a relevant information to the user.
Declaration
public static IUIInfoBar InfoBar(string? id, string title, string description, UIInfoBarSeverity severity)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
title |
The title to display in the bar.
|
| string |
description |
The description to display in the bar.
|
| UIInfoBarSeverity |
severity |
The severity of the information to display.
|
Returns
Declaration
public static IUIInfoBar Informational(this IUIInfoBar element)
Parameters
Returns
InlineView(IUIDiffTextInput)
Declaration
public static IUIDiffTextInput InlineView(this IUIDiffTextInput element)
Parameters
Returns
InteractiveElement(IUISetting, IUIElement?)
Declaration
public static IUISetting InteractiveElement(this IUISetting element, IUIElement? uiElement)
Parameters
Returns
InteractiveElement(IUISettingGroup, IUIElement?)
Declaration
public static IUISettingGroup InteractiveElement(this IUISettingGroup element, IUIElement? uiElement)
Parameters
Returns
Item(IUIElement, object?)
Create component that represents an item in a list.
Declaration
public static IUIListItem Item(IUIElement uiElement, object? value)
Parameters
| Type |
Name |
Description |
| IUIElement |
uiElement |
The element to display in the item.
|
| object |
value |
The value associated to the item.
|
Returns
Item(object?)
Create component that represents an item in a drop down list.
Declaration
public static IUIDropDownListItem Item(object? value)
Parameters
| Type |
Name |
Description |
| object |
value |
The value associated to the item. It will be used to generate the text to display in the item
|
Returns
Item(string?, object?)
Create component that represents an item in a drop down list.
Declaration
public static IUIDropDownListItem Item(string? text, object? value)
Parameters
| Type |
Name |
Description |
| string |
text |
The text to display in the item.
|
| object |
value |
The value associated to the item.
|
Returns
Label()
A component that displays a text.
Declaration
public static IUILabel Label()
Returns
Label(string?)
A component that displays a text.
Declaration
public static IUILabel Label(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Label(string?, string)
A component that displays a text.
Declaration
public static IUILabel Label(string? id, string text)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
text |
The text to display.
|
Returns
Language(IUIMultiLineTextInput, string)
Sets the programming language name to use to colorize the text in the control.
Declaration
public static IUIMultiLineTextInput Language(this IUIMultiLineTextInput element, string programmingLanguageName)
Parameters
Returns
LargeSpacing(IUIStack)
Sets a large spacing between children.
Declaration
public static IUIStack LargeSpacing(this IUIStack element)
Parameters
Returns
LargeSpacing(IUIWrap)
Sets a large spacing between children.
Declaration
public static IUIWrap LargeSpacing(this IUIWrap element)
Parameters
| Type |
Name |
Description |
| IUIWrap |
element |
|
Returns
LeftPaneLength(IUISplitGrid, UIGridLength)
Set the length of the left pane.
Declaration
public static IUISplitGrid LeftPaneLength(this IUISplitGrid element, UIGridLength length)
Parameters
Returns
LimitFileTypesTo(IUIFileSelector, params string[])
Sets the list of file extensions allowed to be selected. An empty list of file extensions indicates any kind of file.
Declaration
public static IUIFileSelector LimitFileTypesTo(this IUIFileSelector element, params string[] fileExtensions)
Parameters
Returns
LimitFileTypesToImages(IUIFileSelector)
Limits the list of selectable files to known supported image formats as defined in ImageFileExtensions.
Declaration
public static IUIFileSelector LimitFileTypesToImages(this IUIFileSelector element)
Parameters
Returns
List()
A component that represents a list of items.
Declaration
public static IUIList List()
Returns
List(string?)
A component that represents a list of items.
Declaration
public static IUIList List(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
ManuallyHandleSaveAs(IUIImageViewer, string, Func<FileStream, ValueTask>)
Adds a custom action to perform when the user saves the image with a specific file extension.
Declaration
public static IUIImageViewer ManuallyHandleSaveAs(this IUIImageViewer element, string fileExtension, Func<FileStream, ValueTask> action)
Parameters
Returns
Remarks
Sets the maximum value possible.
Declaration
public static IUINumberInput Maximum(this IUINumberInput element, double maximum)
Parameters
Returns
MediumSpacing(IUIStack)
Sets a medium spacing between children.
Declaration
public static IUIStack MediumSpacing(this IUIStack element)
Parameters
Returns
MediumSpacing(IUIWrap)
Sets a medium spacing between children.
Declaration
public static IUIWrap MediumSpacing(this IUIWrap element)
Parameters
| Type |
Name |
Description |
| IUIWrap |
element |
|
Returns
Sets the minimum value possible.
Declaration
public static IUINumberInput Minimum(this IUINumberInput element, double minimum)
Parameters
Returns
MinimumLength(IUISplitGrid, int)
Set the minimum length of a cell, in pixels.
Declaration
public static IUISplitGrid MinimumLength(this IUISplitGrid element, int minimumLength)
Parameters
Returns
ModifiedText<T>(T, string)
Sets the unformatted modified text of the control to compare with the original one.
Declaration
public static T ModifiedText<T>(this T element, string text) where T : IUIDiffTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
| string |
text |
|
Returns
Type Parameters
MultiLineTextInput()
A component that can be used to display or edit unformatted text on multiple lines.
Declaration
public static IUIMultiLineTextInput MultiLineTextInput()
Returns
MultiLineTextInput(string?)
A component that can be used to display or edit unformatted text on multiple lines.
Declaration
public static IUIMultiLineTextInput MultiLineTextInput(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
MultiLineTextInput(string?, string)
A component that can be used to display or edit unformatted text on multiple lines.
Declaration
public static IUIMultiLineTextInput MultiLineTextInput(string? id, string programmingLanguageName)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| string |
programmingLanguageName |
The programming language name to use to colorize the text in the control.
Many languages are supported by default, such as JSON or XML. You can create a custom language support using ILanguageService.
|
Returns
NavigateToUri(IUIWebView, Uri)
Declaration
public static IUIWebView NavigateToUri(this IUIWebView element, Uri uri)
Parameters
Returns
Sets the button to appear as neutral.
Declaration
public static IUIButton NeutralAppearance(this IUIButton element)
Parameters
Returns
NeverShowLineNumber(IUIMultiLineTextInput)
Indicates that the line number should never be displayed in the editor.
Declaration
public static IUIMultiLineTextInput NeverShowLineNumber(this IUIMultiLineTextInput element)
Parameters
Returns
NeverWrap(IUILabel)
Declaration
public static IUILabel NeverWrap(this IUILabel element)
Parameters
Returns
NeverWrap(IUIMultiLineTextInput)
Indicates that the text in the editor will never wrap when it reaches the border of the editor.
Declaration
public static IUIMultiLineTextInput NeverWrap(this IUIMultiLineTextInput element)
Parameters
Returns
NoSpacing(IUIStack)
Sets no spacing between children.
Declaration
public static IUIStack NoSpacing(this IUIStack element)
Parameters
Returns
NoSpacing(IUIWrap)
Sets no spacing between children.
Declaration
public static IUIWrap NoSpacing(this IUIWrap element)
Parameters
| Type |
Name |
Description |
| IUIWrap |
element |
|
Returns
NonClosable(IUIInfoBar)
Makes the bar not closable explicitly by the user.
Declaration
public static IUIInfoBar NonClosable(this IUIInfoBar element)
Parameters
Returns
NotExtendable(IUIDataGrid)
Indicates that the control can not be extended to take the size of the whole tool boundaries.
Declaration
public static IUIDataGrid NotExtendable(this IUIDataGrid element)
Parameters
Returns
NotExtendable(IUIDiffTextInput)
Indicates that the control can not be extended to take the size of the whole tool boundaries.
Declaration
public static IUIDiffTextInput NotExtendable(this IUIDiffTextInput element)
Parameters
Returns
NotExtendable(IUIMultiLineTextInput)
Indicates that the control can not be extended to take the size of the whole tool boundaries.
Declaration
public static IUIMultiLineTextInput NotExtendable(this IUIMultiLineTextInput element)
Parameters
Returns
A component that can be used to display or edit numbers on a single line.
Declaration
public static IUINumberInput NumberInput()
Returns
A component that can be used to display or edit numbers on a single line.
Declaration
public static IUINumberInput NumberInput(string? id, double min = -2147483648, double max = 2147483647, double step = 1)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
| double |
min |
The minimum value possible.
|
| double |
max |
The maximum value possible.
|
| double |
step |
The interval between legal numbers.
|
Returns
Off(IUISwitch)
Sets the IsOn of the switch to off.
Declaration
public static IUISwitch Off(this IUISwitch element)
Parameters
Returns
OffText(IUISwitch, string?)
Declaration
public static IUISwitch OffText(this IUISwitch element, string? text)
Parameters
Returns
On(IUISwitch)
Sets the IsOn of the switch to true.
Declaration
public static IUISwitch On(this IUISwitch element)
Parameters
Returns
Sets the action to run when clicking on the button.
Declaration
public static IUIButton OnClick(this IUIButton element, Action? actionOnClick)
Parameters
| Type |
Name |
Description |
| IUIButton |
element |
The IUIButton instance.
|
| Action |
actionOnClick |
The action to run when clicking on the button.
|
Returns
Sets the action to run when clicking on the button.
Declaration
public static IUIButton OnClick(this IUIButton element, Func<ValueTask>? actionOnClick)
Parameters
Returns
Sets the action to run when clicking on the menu item.
Declaration
public static IUIDropDownMenuItem OnClick(this IUIDropDownMenuItem element, Action? actionOnClick)
Parameters
Returns
Sets the action to run when clicking on the menu item.
Declaration
public static IUIDropDownMenuItem OnClick(this IUIDropDownMenuItem element, Func<ValueTask>? actionOnClick)
Parameters
Returns
OnClose(IUIInfoBar, Action?)
Sets the action to run when the user clicks the action button.
Declaration
public static IUIInfoBar OnClose(this IUIInfoBar element, Action? actionOnClose)
Parameters
Returns
OnClose(IUIInfoBar, Func<ValueTask>?)
Sets the action to run when the user clicks the action button.
Declaration
public static IUIInfoBar OnClose(this IUIInfoBar element, Func<ValueTask>? actionOnClose)
Parameters
Returns
OnFilesSelected(IUIFileSelector, Action<SandboxedFileReader[]>?)
Sets the action to run when the user selected file(s).
Declaration
public static IUIFileSelector OnFilesSelected(this IUIFileSelector element, Action<SandboxedFileReader[]>? actionOnFilesSelected)
Parameters
Returns
Remarks
OnFilesSelected(IUIFileSelector, Func<SandboxedFileReader[], ValueTask>?)
Sets the action to run when the user selected file(s).
Declaration
public static IUIFileSelector OnFilesSelected(this IUIFileSelector element, Func<SandboxedFileReader[], ValueTask>? actionOnFilesSelected)
Parameters
Returns
Remarks
OnItemSelected(IUIList, Action<IUIListItem?>?)
Sets the action to run when selecting an item in the list.
Declaration
public static IUIList OnItemSelected(this IUIList element, Action<IUIListItem?>? onItemSelectedAction)
Parameters
Returns
OnItemSelected(IUIList, Func<IUIListItem?, ValueTask>?)
Sets the action to run when selecting an item in the list.
Declaration
public static IUIList OnItemSelected(this IUIList element, Func<IUIListItem?, ValueTask>? onItemSelectedAction)
Parameters
Returns
OnItemSelected(IUISelectDropDownList, Action<IUIDropDownListItem?>?)
Sets the action to run when selecting an item in the drop down list.
Declaration
public static IUISelectDropDownList OnItemSelected(this IUISelectDropDownList element, Action<IUIDropDownListItem?>? onItemSelectedAction)
Parameters
Returns
OnItemSelected(IUISelectDropDownList, Func<IUIDropDownListItem?, ValueTask>?)
Sets the action to run when selecting an item in the drop down list.
Declaration
public static IUISelectDropDownList OnItemSelected(this IUISelectDropDownList element, Func<IUIDropDownListItem?, ValueTask>? onItemSelectedAction)
Parameters
Returns
OnRowSelected(IUIDataGrid, Action<IUIDataGridRow?>?)
Sets the action to run when selecting an item in the data grid.
Declaration
public static IUIDataGrid OnRowSelected(this IUIDataGrid element, Action<IUIDataGridRow?>? onRowSelectedAction)
Parameters
Returns
OnRowSelected(IUIDataGrid, Func<IUIDataGridRow?, ValueTask>?)
Sets the action to run when selecting an item in the data grid.
Declaration
public static IUIDataGrid OnRowSelected(this IUIDataGrid element, Func<IUIDataGridRow?, ValueTask>? onRowSelectedAction)
Parameters
Returns
OnText(IUISwitch, string?)
Sets the OnText of the switch.
Declaration
public static IUISwitch OnText(this IUISwitch element, string? text)
Parameters
Returns
OnTextChanged<T>(T, Action<string>)
Sets the action to run when the text changed.
Declaration
public static T OnTextChanged<T>(this T element, Action<string> actionOnTextChanged) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
| Action<string> |
actionOnTextChanged |
|
Returns
Type Parameters
OnTextChanged<T>(T, Func<string, ValueTask>)
Sets the action to run when the text changed.
Declaration
public static T OnTextChanged<T>(this T element, Func<string, ValueTask> actionOnTextChanged) where T : IUISingleLineTextInput
Parameters
Returns
Type Parameters
OnToggle(IUISwitch, Action<bool>?)
Sets the action to run when toggling the switch.
Declaration
public static IUISwitch OnToggle(this IUISwitch element, Action<bool>? actionOnToggle)
Parameters
Returns
OnToggle(IUISwitch, Func<bool, ValueTask>?)
Sets the action to run when toggling the switch.
Declaration
public static IUISwitch OnToggle(this IUISwitch element, Func<bool, ValueTask>? actionOnToggle)
Parameters
Returns
Sets the action to run when the value changed.
Declaration
public static IUINumberInput OnValueChanged(this IUINumberInput element, Action<double> actionOnValueChanged)
Parameters
Returns
Sets the action to run when the value changed.
Declaration
public static IUINumberInput OnValueChanged(this IUINumberInput element, Func<double, ValueTask> actionOnValueChanged)
Parameters
Returns
Open(IUIInfoBar)
Declaration
public static IUIInfoBar Open(this IUIInfoBar element)
Parameters
Returns
OriginalText<T>(T, string)
Sets the unformatted original text of the control to compare with the modified one.
Declaration
public static T OriginalText<T>(this T element, string text) where T : IUIDiffTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
| string |
text |
|
Returns
Type Parameters
A component that can be used to display or edit passwords on a single line.
Declaration
public static IUIPasswordInput PasswordInput()
Returns
A component that can be used to display or edit passwords on a single line.
Declaration
public static IUIPasswordInput PasswordInput(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
ProgressAsync<T>(T, double)
Asynchronously set the Value property. This method makes sure to update the
progress bar's value without blocking the caller.
Declaration
public static ValueTask ProgressAsync<T>(this T element, double percentage) where T : IUIProgressBar
Parameters
| Type |
Name |
Description |
| T |
element |
The IUIProgressBar instance.
|
| double |
percentage |
A value between 0 and 100.
|
Returns
Type Parameters
ProgressBar()
Create a component that indicates the progress of an operation.
Declaration
public static IUIProgressBar ProgressBar()
Returns
ProgressBar(string?)
Create a component that indicates the progress of an operation.
Declaration
public static IUIProgressBar ProgressBar(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
ProgressRing()
Create a circular component that indicates the progress of an operation.
Declaration
public static IUIProgressRing ProgressRing()
Returns
ProgressRing(string?)
Create a circular component that indicates the progress of an operation.
Declaration
public static IUIProgressRing ProgressRing(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Progress<T>(T, double)
Synchronously set the Value property.
Declaration
public static T Progress<T>(this T element, double percentage) where T : IUIProgressBar
Parameters
| Type |
Name |
Description |
| T |
element |
The IUIProgressBar instance.
|
| double |
percentage |
A value between 0 and 100.
|
Returns
Type Parameters
ReadOnly<T>(T)
Sets the text input control as read-only.
Declaration
public static T ReadOnly<T>(this T element) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
RemoveManuallyHandleSaveAs(IUIImageViewer, string)
Removes the custom action to perform when the user saves the image with a specific file extension.
Declaration
public static IUIImageViewer RemoveManuallyHandleSaveAs(this IUIImageViewer element, string fileExtension)
Parameters
Returns
RemoveValue(ObservableCollection<IUIListItem>, object?)
Removes the first occurrence of an IUIListItem where Value match the given value.
Declaration
public static void RemoveValue(this ObservableCollection<IUIListItem> listItems, object? value)
Parameters
RenderHTML(IUIWebView, string)
Sets the Source from an HTML document.
Declaration
public static IUIWebView RenderHTML(this IUIWebView element, string html)
Parameters
Returns
RightPaneLength(IUISplitGrid, UIGridLength)
Set the length of the right pane.
Declaration
public static IUISplitGrid RightPaneLength(this IUISplitGrid element, UIGridLength length)
Parameters
Returns
Row(IUIGridCell, int)
Sets the row alignment of the cell.
Declaration
public static IUIGridCell Row(this IUIGridCell element, int row)
Parameters
Returns
Row(object?, params IUIDataGridCell[])
Create component that represents an item in a list.
Declaration
public static IUIDataGridRow Row(object? value, params IUIDataGridCell[] cells)
Parameters
| Type |
Name |
Description |
| object |
value |
The value associated to the item.
|
| IUIDataGridCell[] |
cells |
The cells to display in the row.
|
Returns
Row(object?, IUIElement?, params IUIDataGridCell[])
Create component that represents an item in a list.
Declaration
public static IUIDataGridRow Row(object? value, IUIElement? details, params IUIDataGridCell[] cells)
Parameters
| Type |
Name |
Description |
| object |
value |
The value associated to the item.
|
| IUIElement |
details |
The element to display as detail information in the row.
|
| IUIDataGridCell[] |
cells |
The cells to display in the row.
|
Returns
Row(object?, IUIElement?, params string[])
Create component that represents an item in a list.
Declaration
public static IUIDataGridRow Row(object? value, IUIElement? details, params string[] cells)
Parameters
| Type |
Name |
Description |
| object |
value |
The value associated to the item.
|
| IUIElement |
details |
The element to display as detail information in the row.
|
| string[] |
cells |
The cells to display in the row.
|
Returns
Row(object?, params string[])
Create component that represents an item in a list.
Declaration
public static IUIDataGridRow Row(object? value, params string[] cells)
Parameters
| Type |
Name |
Description |
| object |
value |
The value associated to the item.
|
| string[] |
cells |
The cells to display in the row.
|
Returns
RowLargeSpacing(IUIGrid)
Sets a large spacing between rows.
Declaration
public static IUIGrid RowLargeSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
RowMediumSpacing(IUIGrid)
Sets a medium spacing between rows.
Declaration
public static IUIGrid RowMediumSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
RowNoSpacing(IUIGrid)
Sets no spacing between rows.
Declaration
public static IUIGrid RowNoSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
RowSmallSpacing(IUIGrid)
Sets a small spacing between rows.
Declaration
public static IUIGrid RowSmallSpacing(this IUIGrid element)
Parameters
| Type |
Name |
Description |
| IUIGrid |
element |
|
Returns
RowSpan(IUIGridCell, int)
Sets a value that indicates the total number of rows that the cell content spans within the parent grid.
Declaration
public static IUIGridCell RowSpan(this IUIGridCell element, int rows)
Parameters
Returns
Rows(IUIGrid, params UIGridLength[])
Declaration
public static IUIGrid Rows(this IUIGrid element, params UIGridLength[] heights)
Parameters
Returns
Rows<TEnum>(IUIGrid, params (TEnum name, UIGridLength height)[])
Declaration
public static IUIGrid Rows<TEnum>(this IUIGrid element, params (TEnum name, UIGridLength height)[] rows) where TEnum : Enum
Parameters
Returns
Type Parameters
Select(IUIDataGrid, IUIDataGridRow?)
Sets the IUIDataGridRow that should be selected in the data grid.
If row is null or does not exist in the data grid, no row will be selected.
Declaration
public static IUIDataGrid Select(this IUIDataGrid element, IUIDataGridRow? row)
Parameters
Returns
Select(IUIDataGrid, int)
Sets the IUIDataGridRow that should be selected in the data grid, using its index in the data grid.
If index smaller or greater than the amount of rows in the data grid, no row will be selected.
Declaration
public static IUIDataGrid Select(this IUIDataGrid element, int index)
Parameters
Returns
Select(IUIList, IUIListItem?)
Sets the IUIList that should be selected in the list.
If item is null or does not exist in the list, no item will be selected.
Declaration
public static IUIList Select(this IUIList element, IUIListItem? item)
Parameters
Returns
Select(IUIList, int)
Sets the IUIList that should be selected in the list, using its index in the list.
If index smaller or greater than the amount of items in the list, no item will be selected.
Declaration
public static IUIList Select(this IUIList element, int index)
Parameters
Returns
Select(IUIMultiLineTextInput, TextSpan)
Selects the given span in the text document.
Declaration
public static IUIMultiLineTextInput Select(this IUIMultiLineTextInput element, TextSpan span)
Parameters
Returns
Select(IUIMultiLineTextInput, int, int)
Selects the given span in the text document.
Declaration
public static IUIMultiLineTextInput Select(this IUIMultiLineTextInput element, int start, int length)
Parameters
Returns
Select(IUISelectDropDownList, IUIDropDownListItem?)
Sets the IUIDropDownListItem that should be selected in the drop down list.
If item is null or does not exist in the list, no item will be selected.
Declaration
public static IUISelectDropDownList Select(this IUISelectDropDownList element, IUIDropDownListItem? item)
Parameters
Returns
Select(IUISelectDropDownList, int)
Sets the IUIDropDownListItem that should be selected in the drop down list, using its index in the list.
If index smaller or greater than the amount of items in the list, no item will be selected.
Declaration
public static IUISelectDropDownList Select(this IUISelectDropDownList element, int index)
Parameters
Returns
SelectDropDownList()
A component that represents a drop down list where the user can select one item in it.
Declaration
public static IUISelectDropDownList SelectDropDownList()
Returns
SelectDropDownList(string?)
A component that represents a drop down list where the user can select one item in it.
Declaration
public static IUISelectDropDownList SelectDropDownList(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Setting()
A component that represents a setting, with a title, description, icon and IUIElement for the option value.
Declaration
public static IUISetting Setting()
Returns
Setting(string?)
A component that represents a setting, with a title, description, icon and IUIElement for the option value.
Declaration
public static IUISetting Setting(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
SettingGroup()
A component that represents a group of settings, with a title, description and an icon.
Declaration
public static IUISettingGroup SettingGroup()
Returns
SettingGroup(string?)
A component that represents a group of settings, with a title, description and an icon.
Declaration
public static IUISettingGroup SettingGroup(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
ShowCommandBar<T>(T)
Shows the command bar on top of the editor.
Declaration
public static T ShowCommandBar<T>(this T element) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
ShowIcon(IUIInfoBar)
Shows the icon of the bar.
Declaration
public static IUIInfoBar ShowIcon(this IUIInfoBar element)
Parameters
Returns
Show<T>(T)
Declaration
public static T Show<T>(this T element) where T : IUIElement
Parameters
| Type |
Name |
Description |
| T |
element |
|
Returns
Type Parameters
SingleLineTextInput()
Create a component that can be used to display or edit unformatted text on a single line.
Declaration
public static IUISingleLineTextInput SingleLineTextInput()
Returns
SingleLineTextInput(string?)
Create a component that can be used to display or edit unformatted text on a single line.
Declaration
public static IUISingleLineTextInput SingleLineTextInput(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Size(IUIIcon, int)
Sets the Size of the icon.
Declaration
public static IUIIcon Size(this IUIIcon element, int size)
Parameters
Returns
SmallSpacing(IUIStack)
Sets a small spacing between children.
Declaration
public static IUIStack SmallSpacing(this IUIStack element)
Parameters
Returns
SmallSpacing(IUIWrap)
Sets a small spacing between children.
Declaration
public static IUIWrap SmallSpacing(this IUIWrap element)
Parameters
| Type |
Name |
Description |
| IUIWrap |
element |
|
Returns
SplitGrid()
Create a component that splits horizontally or vertically an area into two panes. Panes can be resized by the user.
Declaration
public static IUISplitGrid SplitGrid()
Returns
SplitGrid(string?)
Create a component that splits horizontally or vertically an area into two panes. Panes can be resized by the user.
Declaration
public static IUISplitGrid SplitGrid(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
SplitView(IUIDiffTextInput)
Declaration
public static IUIDiffTextInput SplitView(this IUIDiffTextInput element)
Parameters
Returns
Stack()
Create a component that stacks child elements into a single line that can be oriented horizontally or vertically.
Declaration
public static IUIStack Stack()
Returns
Stack(string?)
Create a component that stacks child elements into a single line that can be oriented horizontally or vertically.
Declaration
public static IUIStack Stack(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
StartIndeterminateProgress<T>(T)
Indicates the progress bar should a generic, continuous progress feedback.
Declaration
public static T StartIndeterminateProgress<T>(this T element) where T : IUIProgressBar
Parameters
Returns
Type Parameters
StateDescription(IUISetting, string?)
Declaration
public static IUISetting StateDescription(this IUISetting element, string? text)
Parameters
Returns
Sets the interval between legal numbers.
Declaration
public static IUINumberInput Step(this IUINumberInput element, double step)
Parameters
Returns
StopIndeterminateProgress<T>(T)
Indicates the progress bar should show actual values.
Declaration
public static T StopIndeterminateProgress<T>(this T element) where T : IUIProgressBar
Parameters
Returns
Type Parameters
Style(IUILabel, UILabelStyle)
Declaration
public static IUILabel Style(this IUILabel element, UILabelStyle style)
Parameters
Returns
Success(IUIInfoBar)
Declaration
public static IUIInfoBar Success(this IUIInfoBar element)
Parameters
Returns
Switch()
A component that represents a changeable boolean value.
Declaration
public static IUISwitch Switch()
Returns
Switch(string?)
A component that represents a changeable boolean value.
Declaration
public static IUISwitch Switch(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
SynchronizeScrollBarWith(IUIMultiLineTextInput, IUIMultiLineTextInput?)
Synchronizes the scroll bars of the given element with the scroll bars of the other element.
Declaration
public static IUIMultiLineTextInput SynchronizeScrollBarWith(this IUIMultiLineTextInput element, IUIMultiLineTextInput? otherElement)
Parameters
Returns
Text(IUIButton, string?)
Sets the Text of the button.
Declaration
public static IUIButton Text(this IUIButton element, string? text)
Parameters
Returns
Text(IUIDropDownButton, string?)
Sets the Text of the drop down button.
Declaration
public static IUIDropDownButton Text(this IUIDropDownButton element, string? text)
Parameters
Returns
Sets the Text of the menu item.
Declaration
public static IUIDropDownMenuItem Text(this IUIDropDownMenuItem element, string? text)
Parameters
Returns
Text(IUILabel, string?)
Declaration
public static IUILabel Text(this IUILabel element, string? text)
Parameters
Returns
Text<T>(T, string)
Sets the unformatted text of the control.
Declaration
public static T Text<T>(this T element, string text) where T : IUISingleLineTextInput
Parameters
| Type |
Name |
Description |
| T |
element |
|
| string |
text |
|
Returns
Type Parameters
Title(IUIInfoBar, string?)
Sets the Title of the bar.
Declaration
public static IUIInfoBar Title(this IUIInfoBar element, string? title)
Parameters
Returns
Title<T>(T, string?)
Sets the title of the element.
Declaration
public static T Title<T>(this T element, string? title) where T : IUITitledElement
Parameters
| Type |
Name |
Description |
| T |
element |
|
| string |
title |
|
Returns
Type Parameters
TopPaneLength(IUISplitGrid, UIGridLength)
Set the length of the top pane.
Declaration
public static IUISplitGrid TopPaneLength(this IUISplitGrid element, UIGridLength length)
Parameters
Returns
Declaration
public static IUINumberInput Value(this IUINumberInput element, double value)
Parameters
Returns
Vertical(IUISplitGrid)
Declaration
public static IUISplitGrid Vertical(this IUISplitGrid element)
Parameters
Returns
Vertical(IUIStack)
Declaration
public static IUIStack Vertical(this IUIStack element)
Parameters
Returns
Warning(IUIInfoBar)
Declaration
public static IUIInfoBar Warning(this IUIInfoBar element)
Parameters
Returns
WebView()
A component that displays a web page.
Declaration
public static IUIWebView WebView()
Returns
WebView(string?)
A component that displays a web page.
Declaration
public static IUIWebView WebView(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
Sets the optional action button of the bar. The bar closes when the user click on the button.
Declaration
public static IUIInfoBar WithActionButton(this IUIInfoBar element, string text, bool isAccent, Action actionOnClick)
Parameters
Returns
Sets the optional action button of the bar. The bar closes when the user click on the button.
Declaration
public static IUIInfoBar WithActionButton(this IUIInfoBar element, string text, bool isAccent, Func<ValueTask> actionOnClick)
Parameters
Returns
WithBottomPaneChild(IUISplitGrid, IUIElement?)
Set the element to display in the bottom pane.
Declaration
public static IUISplitGrid WithBottomPaneChild(this IUISplitGrid element, IUIElement? child)
Parameters
Returns
WithChild(IUIGridCell, IUIElement?)
Sets the child element to display in the cell.
Declaration
public static IUIGridCell WithChild(this IUIGridCell element, IUIElement? child)
Parameters
Returns
WithChildren(IUISettingGroup, params IUIElement[])
Sets the children to be displayed in the group.
Declaration
public static IUISettingGroup WithChildren(this IUISettingGroup element, params IUIElement[] children)
Parameters
Returns
WithChildren(IUIStack, params IUIElement[])
Sets the children to be displayed in the stack.
Declaration
public static IUIStack WithChildren(this IUIStack element, params IUIElement[] children)
Parameters
Returns
WithChildren(IUIWrap, params IUIElement[])
Sets the children to be displayed in the stack.
Declaration
public static IUIWrap WithChildren(this IUIWrap element, params IUIElement[] children)
Parameters
Returns
WithColumns(IUIDataGrid, params string[])
Sets the title of each column in the data grid.
Declaration
public static IUIDataGrid WithColumns(this IUIDataGrid element, params string[] columns)
Parameters
Returns
WithFile(IUIImageViewer, FileInfo)
Declaration
public static IUIImageViewer WithFile(this IUIImageViewer element, FileInfo imageFile)
Parameters
Returns
WithFiles(IUIFileSelector, params SandboxedFileReader[])
Declaration
public static IUIFileSelector WithFiles(this IUIFileSelector element, params SandboxedFileReader[] files)
Parameters
Returns
Remarks
WithImage(IUIImageViewer, Image, bool)
Declaration
public static IUIImageViewer WithImage(this IUIImageViewer element, Image image, bool disposeAutomatically)
Parameters
| Type |
Name |
Description |
| IUIImageViewer |
element |
The IUIImageViewer instance.
|
| Image |
image |
The Image to display.
|
| bool |
disposeAutomatically |
Indicates whether the image should be disposed when not displayed in the UI anymore.
|
Returns
WithItems(IUIList, params IUIListItem[])
Sets the Items of the list.
Declaration
public static IUIList WithItems(this IUIList element, params IUIListItem[] items)
Parameters
Returns
WithItems(IUISelectDropDownList, params IUIDropDownListItem[])
Sets the Items of the drop down list.
Declaration
public static IUISelectDropDownList WithItems(this IUISelectDropDownList element, params IUIDropDownListItem[] items)
Parameters
Returns
WithLeftPaneChild(IUISplitGrid, IUIElement?)
Set the element to display in the left pane.
Declaration
public static IUISplitGrid WithLeftPaneChild(this IUISplitGrid element, IUIElement? child)
Parameters
Returns
Declaration
public static IUIDropDownButton WithMenuItems(this IUIDropDownButton element, params IUIDropDownMenuItem[] menuItems)
Parameters
Returns
WithPickedFile(IUIImageViewer, SandboxedFileReader, bool)
Declaration
public static IUIImageViewer WithPickedFile(this IUIImageViewer element, SandboxedFileReader pickedFile, bool disposeAutomatically)
Parameters
Returns
WithRightPaneChild(IUISplitGrid, IUIElement?)
Set the element to display in the right pane.
Declaration
public static IUISplitGrid WithRightPaneChild(this IUISplitGrid element, IUIElement? child)
Parameters
Returns
Sets the element to be displayed in the view.
Declaration
public static UIToolView WithRootElement(this UIToolView toolView, IUIElement? rootElement)
Parameters
Returns
WithRows(IUIDataGrid, params IUIDataGridRow[])
Sets the Rows of the data grid.
Declaration
public static IUIDataGrid WithRows(this IUIDataGrid element, params IUIDataGridRow[] rows)
Parameters
Returns
WithSettings(IUISettingGroup, params IUISetting[])
Sets the children to be displayed in the group.
Declaration
public static IUISettingGroup WithSettings(this IUISettingGroup element, params IUISetting[] settings)
Parameters
Returns
WithTopPaneChild(IUISplitGrid, IUIElement?)
Set the element to display in the top pane.
Declaration
public static IUISplitGrid WithTopPaneChild(this IUISplitGrid element, IUIElement? child)
Parameters
Returns
Wrap()
Create a component that stacks child elements horizontally and stack them into multiple lines if there's not enough space to keep everything on a single line.
Declaration
public static IUIWrap Wrap()
Returns
Wrap(string?)
Create a component that stacks child elements horizontally and stack them into multiple lines if there's not enough space to keep everything on a single line.
Declaration
public static IUIWrap Wrap(string? id)
Parameters
| Type |
Name |
Description |
| string |
id |
An optional unique identifier for this UI element.
|
Returns
WrapIfNeeded(IUILabel)
Declaration
public static IUILabel WrapIfNeeded(this IUILabel element)
Parameters
Returns