UiPath.Studio.Api.Controls
In this section you can find more information on how to build activities using UiPath.Studio.Api.Controls.
UiPath.Studio.Api.Controls.Base
In this section you can find more information on how to build activities using UiPath.Studio.Api.Controls.Base.
ControlDescriptionBase
The control to use for this setting.
Properties
| Type | Name | Description |
|---|---|---|
| string | Tooltip | (Optional) The tooltip to display for this control. |
| string | Text | (Optional) The text to display for this control. |
ControlsContainerDescription
The control to use as a container for other controls in this setting.
Inheritance
ControlDescriptionBase > ControlsContainerDescription
Properties
| Type | Name | Description |
|---|---|---|
| IList<ControlDescriptionBase | Controls | A collection of controls. |
Remarks
We recommend using StackPanelDescription as it offers a way to arrange controls.
EditorDescriptionBase
A text input control.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Properties
| Type | Name | Description |
|---|---|---|
| string | ValueHint | The value hint if there is no value. |
| Func<T, string> | Validate | Returns a validation error or an empty string if there is no error. |
InputControlDescriptionBase
Base class for control that allow selecting / editing a value.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Properties
| Type | Name | Description |
|---|---|---|
| T | DefaultValue | The default value. |
| bool | IsReadOnly | If set to true, input is disabled (the control is read-only). |
| Func<T, string> | GetDisplayValue | The formatted text for the given value. |
ItemsControlDescriptionBase
Base class for item controls, for example combo box.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Generic Type T
A type that is supported by ControlDescriptionBase.
Properties
| Type | Name | Description |
|---|---|---|
| List | Items | The possible values. |
CheckBoxDescription
A check box.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
ComboBoxDescription
A select-only combo box.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Properties
| Type | Name | Description |
|---|---|---|
| bool | AllowMultipleSelection | If set to true, each item will have an associated check box. |
Remarks
Adds a dropdown in activities project settings.
NumericBoxDescription
A numeric input control.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Generic Type T
The type of data that this numeric box displays. It must implement IComparable, IFormattable, IConvertible, IComparable
Properties
| Type | Name | Description |
|---|---|---|
| T | MaxValue | (Optional) The higher bound value. |
| T | MinValue | (Optional) The lower bound value. |
| T | StepSize | (Optional) If set, an up/down control is displayed that increments/decrements using the given value. |
Remarks
Adds a numeric box to activity project settings.
RadioButtonGroupDescription
Radio button group generated from a list of string values.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Remarks
Adds a radio button control to activity project settings.
Use InputControlDescriptionBase{T}.GetDisplayValue to provide the localized display value.
StackPanelDescription
A list of controls arranged on a single line.
Inheritance
ControlDescriptionBase > ControlsContainerDescription > StackPanelDescription
Remarks
Adds a panel to activities project settings that arranges its child elements in a single line.
TextBoxDescription
A text box control.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Properties
| Type | Name | Description |
|---|---|---|
| bool | IsMultiLine | If set to true, the text box expands vertically |
Remarks
Adds a text box control in activities project settings.
ToggleDescription
A toggle button.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase
Properties
| Type | Name | Description |
|---|---|---|
| bool | IsMultiLine | If set to true, the text box expands vertically |