- Overview
- Custom activities
- Migrating Activities to .NET 6
- Release Notes
- Building Workflow Analyzer Rules
- Building Activities Project Settings
- Creating Custom Wizards
- Prioritize Activities by Scope
- UiPath.Activities.Api.Base
- UiPath.Studio.Activities.Api
- UiPath.Studio.Activities.Api.Activities
- UiPath.Studio.Activities.Api.BusyService
- UiPath.Studio.Activities.Api.ExpressionEditor
- UiPath.Studio.Activities.Api.Expressions
- UiPath.Studio.Activities.Api.Licensing
- UiPath.Studio.Activities.Api.Mocking
- UiPath.Studio.Activities.Api.ObjectLibrary
- UiPath.Studio.Activities.Api.PackageBindings
- UiPath.Studio.Activities.Api.ProjectProperties
- UiPath.Studio.Activities.Api.ScopedActivities
- UiPath.Studio.Activities.Api.Settings
- UiPath.Studio.Activities.Api.Wizards
- UiPath.Studio.Activities.Api.Workflow
- UiPath.Studio.Api.Controls
- UiPath.Studio.Api.Telemetry
- UiPath.Studio.Api.Theme
- Robot JavaScript SDK
- Triggers SDK
UiPath.Studio.Api.Controls
In this section you can find more information on how to build activities using UiPath.Studio.Api.Controls.
In this section you can find more information on how to build activities using UiPath.Studio.Api.Controls.Base.
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. |
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.
A text input control.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase <T> > EditorDescriptionBase<T>
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. |
Base class for control that allow selecting / editing a value.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase<T>
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. |
Base class for item controls, for example combo box.
Inheritance
ControlDescriptionBase > InputControlDescriptionBase <T> > ItemsControlDescriptionBase<T>
Generic Type T
A type that is supported by ControlDescriptionBase.
Properties
|
Type |
Name |
Description |
|---|---|---|
|
List<T> |
Items |
The possible values. |
A check box.
ControlDescriptionBase > InputControlDescriptionBase <T> > CheckBoxDescription
A select-only combo box.
ControlDescriptionBase > InputControlDescriptionBase <T> > ComboBoxDescription
|
Type |
Name |
Description |
|---|---|---|
|
bool |
AllowMultipleSelection |
If set to
true, each item will have an associated check box.
|
A numeric input control.
ControlDescriptionBase > InputControlDescriptionBase <T> > EditorDescriptionBase <T> > NumericBoxDescription
The type of data that this numeric box displays. It must implement IComparable, IFormattable, IConvertible, IComparable<T>, IEquatable<T> and must be a struct.
|
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. |
Radio button group generated from a list of string values.
ControlDescriptionBase > InputControlDescriptionBase <T> > > RadioButtonGroupDescription
A list of controls arranged on a single line.
ControlDescriptionBase > ControlsContainerDescription > StackPanelDescription
A text box control.
ControlDescriptionBase > InputControlDescriptionBase <T> > EditorDescriptionBase <T> > TextBoxDescription
A toggle button.
ControlDescriptionBase > InputControlDescriptionBase <T> > ToggleDescription
- UiPath.Studio.Api.Controls.Base
- ControlDescriptionBase
- ControlsContainerDescription
- EditorDescriptionBase <T>
- InputControlDescriptionBase <T>
- ItemsControlDescriptionBase <T>
- CheckBoxDescription
- Inheritance
- ComboBoxDescription
- Inheritance
- Properties
- Remarks
- NumericBoxDescription <T>
- Inheritance
- Generic Type T
- Properties
- Remarks
- RadioButtonGroupDescription
- Inheritance
- Remarks
- StackPanelDescription
- Inheritance
- Remarks
- TextBoxDescription
- Inheritance
- Properties
- Remarks
- ToggleDescription
- Inheritance
- Properties
