Namespace: UiPath.Studio.Activities.Api.Settings

Classes and Interfaces

IActivitiesSettingsService Interface

The entry point for settings related functionality.

Public Member Functions:

AddCategory()
`void AddCategory (SettingsCategory category)` Adds a settings category in the project settings UI. Parameters: `category`: The description of the settings page.

AddCategory()

void AddCategory (SettingsCategory category)
Adds a settings category in the project settings UI.

Parameters:
category: The description of the settings page.

AddSection()
`void AddSection (SettingsCategory category, SettingsSection section)` Adds a section to this category. If the section key does not start with the category key, the latter is added as a prefix of the former and the `SettingsElement`. Key-value is updated.

AddSetting()
`void AddSetting (SettingsEditorControlContainer parent, SettingDescriptionBase setting)` Generates a default `SettingsEditorControl` based on the setting and passes it to `AddSetting(SettingsEditorControl)`. Parameters: `parent`: The `SettingsCategory` or `SettingsSection` where the generated setting control is appended. `setting`: The setting description that is used to generate a control.

AddSetting()

void AddSetting (SettingsEditorControlContainer parent, SettingDescriptionBase setting)
Generates a default SettingsEditorControl based on the setting and passes it to AddSetting(SettingsEditorControl).

Parameters:
parent: The SettingsCategory or SettingsSection where the generated setting control is appended.
setting: The setting description that is used to generate a control.

AddSetting()
`void AddSetting (SettingsEditorControlContainer parent, SettingsEditorControl setting)` Adds a settings control. Parameters: `parent` - The `SettingsCategory` or `SettingsSection` where the generated setting control is appended. `setting` - The setting description that is used to generate a control.

AddSetting()

void AddSetting (SettingsEditorControlContainer parent, SettingsEditorControl setting)
Adds a settings control.

Parameters:

parent - The SettingsCategory or SettingsSection where the generated setting control is appended.
setting - The setting description that is used to generate a control.

TrySetValue()
`bool TrySetValue (string key, string value)` Sets and saves a setting value. Parameters: `key` - The key of the setting to be set. `value` - The value of the setting to be set Returns: `true` if the value has been set.

TrySetValue()

bool TrySetValue (string key, string value)
Sets and saves a setting value.

Parameters:
key - The key of the setting to be set.
value - The value of the setting to be set
Returns:
true if the value has been set.

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[] `Values{ get; set; }`	Possible values to select.
string[] `DefaultValues{ get; set; }`	Default selection.

SettingDescriptionBase Class

Properties	Summary
GetDisplayValue Func<T, string> `GetDisplayValue{ get; set; }`	Format a value for display.
Description string `Description{ get; set; }`	An explanation of the setting.
IsReadOnly bool `IsReadOnly{ get; set; }`	If set, the value is not editable and not persisted.
Label string `Label{ get; set; }`	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 `Description{ get; set; }`	[Optional] Displayed bellow the title, explains the purpose of this page.
string `Header{ get; set; }`	The category header.
bool `IsHidden{ get; set; }`	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 `Control{ get; set; }`	The control to use for this setting.
string `Description{ get; set; }`	[Optional] Longer explanatory text for this setting, displayed as a tooltip.
string `Label{ get; set; }`	[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 `Key{ get; set; }`	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 `Description{ get; set; }`	[Optional] Displayed bellow the title, explains the purpose of this section.
bool `IsExpanded = true{ get; set; }`	Default expanded state.
string `Title{ get; set; }`	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 `DefaultValue{ get; set; }`	The default value of this setting.
Func< T, string > `Validate{ get; set; }`	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[] `Values{ get; set; }`	Possible values to select.

UiPath Developer

The UiPath Developer Guide

Activities Project Settings Reference

Classes and Interfaces

IActivitiesSettingsService Interface

MultipleValuesSelectorDescription Class

SettingDescriptionBase Class

SettingsCategory Class

SettingsControlBase Class

SettingsEditorControl Class

SettingsEditorControlContainer Class

SettingsElement Class

SettingsSection Class

SingleValueEditorDescription Class

SingleValueSelectorDescription Class

Activities Project Settings Reference

Suggested Edits are limited on API Reference Pages