Namespace: UiPath.Studio.Activities.Api.Settings
Classes and Interfaces
IActivitiesSettingsService Interface
The entry point for settings related functionality.
Public Member Functions:
AddCategory() |
---|
Parameters: |
AddSection() |
---|
|
AddSetting() |
---|
Parameters: |
AddSetting() |
---|
Parameters:
|
TrySetValue() |
---|
Parameters: |
MultipleValuesSelectorDescription Class
A setting that allows selecting multiple value from a predefined collection of values.
In addition to the properties below, this class inherits all properties contained in the SettingDescriptionBase and SettingsElements classes.
Properties | Summary |
---|---|
string[] | Possible values to select. |
string[] | Default selection. |
SettingDescriptionBase Class
Properties | Summary |
---|---|
GetDisplayValue | Format a value for display. |
Description | An explanation of the setting. |
IsReadOnly | If set, the value is not editable and not persisted. |
Label | The label to use for this setting. |
In addition, this class inherits all properties contained in the SettingsElements class.
SettingsCategory Class
In addition to the properties below, this class inherits all properties contained in the SettingsElements class.
Properties | Summary |
---|---|
string | [Optional] Displayed bellow the title, explains the purpose of this page. |
string | The category header. |
bool | If the property is set to true, then the category will not be displayed in the project settings dialog. Requires feature SettingsV2 |
SettingsControlBase Class
A settings element that is part of the UI. This class inherits properties from SettingsElements class.
SettingsEditorControl Class
Settings editor. It appears as a label with an associated control.
An instance of this can be passed to SettingsSection.AddSetting(SettingsEditorControl)
.
In addition to the properties below, this class inherits all properties contained in the SettingsElements class.
Properties | Summary |
---|---|
ControlDescriptionBase | The control to use for this setting. |
string | [Optional] Longer explanatory text for this setting, displayed as a tooltip. |
string | [Optional] The setting editor label. This can be a markdown text. |
SettingsEditorControlContainer Class
A settings UI element that can host editors. This class inherits properties from SettingsElements class.
SettingsElement Class
Base class for settings elements with associated keys.
Properties | Summary |
---|---|
string | The unique key associated with this setting. Used for storage/retrieval. |
SettingsSection Class
A settings "group box".
In addition to the properties below, this class inherits all properties contained in the SettingsElements class.
Properties | Summary |
---|---|
string | [Optional] Displayed bellow the title, explains the purpose of this section. |
bool | Default expanded state. |
string | The section title. |
SingleValueEditorDescription Class
Describes a setting entry that allows editing a single value of type T, bool, int, double or string.
In addition to the properties below, this class inherits all properties contained in the SettingDescriptionBase and SettingsElements classes.
Properties | Summary |
---|---|
T | The default value of this setting. |
Func< T, string > | Validate a value (applies to editors that allow free text input). |
SingleValueSelectorDescription Class
A setting that allows selecting a single value from a predefined collection of values.
In addition to the properties below, this class inherits all properties contained in the SingleValueEditorDescription class.
Properties | Summary |
---|---|
string[] | Possible values to select. |
Updated 8 months ago