sdk

latest

false

Developer Guide

Last updated Oct 25, 2024

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 <T>

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.

InputControlDescriptionBase <T>

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.

ItemsControlDescriptionBase <T>

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.

CheckBoxDescription

A check box.

Inheritance

ControlDescriptionBase > InputControlDescriptionBase <T> > CheckBoxDescription

ComboBoxDescription

A select-only combo box.

Inheritance

ControlDescriptionBase > InputControlDescriptionBase <T> > ComboBoxDescription

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 <T>

A numeric input control.

Inheritance

ControlDescriptionBase > InputControlDescriptionBase <T> > EditorDescriptionBase <T> > NumericBoxDescription

Generic Type T

The type of data that this numeric box displays. It must implement IComparable, IFormattable, IConvertible, IComparable<T>, IEquatable<T> and must be a struct.

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.