- 概述
- 自定义活动
- 将活动迁移到 .NET 6
- 发行说明
- 构建工作流分析器规则
- 构建活动项目设置
- 创建自定义向导
- 按范围划分活动的优先级
- 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
- 触发器 SDK

开发者指南
在本节中,您可以找到有关如何使用 UiPath.Studio.Activities.Api.Settings构建活动的更多信息。
设置相关功能的入口点。
继承
IActivitiesSettingsReader > IActivitiesSettingsService
方法
void AddCategory(SettingsCategory category)
在项目设置用户界面中添加设置类别。
参数类型 |
参数名称 |
描述 |
---|---|---|
SettingsCategory |
类别 |
设置页面的说明。 |
void AddSection(SettingsCategory category, SettingsSection section)
向此类别添加版块。
参数类型 |
参数名称 |
描述 |
---|---|---|
SettingsCategory |
类别 | |
SettingsSection |
版块 |
If the section key does not start with the the category key, the latter is added as prefix of the former and the SettingsElement.Key value is updated. |
void AddSetting(SettingsEditorControlContainer parent, SettingDescriptionBase setting)
根据设置生成默认的设置编辑器,并将其传递给“添加设置”(SettingsEditorControlContainer)。
参数类型 |
参数名称 |
描述 |
---|---|---|
SettingsEditorControlContainer |
父项 |
The SettingsCategory or SettingsSection where the generated setting control is appended. |
SettingDescriptionBase |
设置 |
用于生成控件的设置说明。 |
void AddSetting(SettingsEditorControlContainer parent, SettingsEditorControl setting)
添加设置控件
参数类型 |
参数名称 |
描述 |
---|---|---|
SettingsEditorControlContainer |
父项 |
The SettingsCategory or SettingsSection where the generated setting control is appended. |
SettingsEditorControl |
设置 |
用于生成控件的设置说明。 |
bool TrySetValue (string key, string value)
设置并保存设置值。
参数类型 |
参数名称 |
描述 |
---|---|---|
字符串 |
键值 |
设置的键。 |
字符串 |
值 |
设置的值。 |
定义活动包处理新式活动与传统活动的首选方式。 如果设置为“使用 全局设置”,则该行为会将行为推迟到全局 Studio 设置。 将其显式设置为“使用 新式” 或 “使用传统” 将导致覆盖特定包的设置。
常量
类型 |
名称 |
描述 |
---|---|---|
字符串 |
UseGlobalSetting |
将决策推迟到全局 Studio 设置。 |
字符串 |
UseModern |
将新式活动设为默认值。 |
字符串 |
UseClassic |
将传统活动设为默认活动。 |
此设置允许从预定义的值集合中选择多个值。
继承
SettingsElement > SettingDescriptionBase > MultipleValuesSelectorDescription
属性
类型 |
名称 |
描述 |
---|---|---|
字符串 |
值 |
要选择的可能值。 |
字符串 |
默认值 |
默认选择。 |
格式化要显示的值。
继承
SettingsElement > SettingDescriptionBase
属性
类型 |
名称 |
描述 |
---|---|---|
字符串 |
描述 |
设置说明。 |
Bool |
只读 |
如果设置为
true ,则该值不可编辑,也无法保留。
|
Bool |
IsDesignTime |
如果在设计时调用,则返回
true 。 需要 Studio 2021.10 或更高版本。
|
字符串 |
标签 |
要用于此设置的标签。 |
Bool |
RequiresPackageReload |
如果设置为
true ,则更改此设置需要重新加载包。 需要 Studio 2021.10 或更高版本。
|
适用于特定类型的设置说明。
继承
SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T>
泛型类型 T
此说明适用的设置类型。
属性
类型 |
名称 |
描述 |
---|---|---|
Func<T, string> |
GetDisplayValue |
需要返回给定类型的格式化显示值的函数。 |
属于用户界面一部分的设置元素。
继承
SettingsElement > SettingsControlBase
属性
类型 |
名称 |
描述 |
---|---|---|
Bool |
IsDesignTime |
在设计时调用时返回
true 。 需要 Studio 2021.10 或更高版本。
|
Bool |
RequiresPackageReload |
如果设置为
true ,则更改此设置需要重新加载包。这仅适用于设计时设置。 需要 Studio 2021.10 或更高版本。
|
设置编辑器。 它显示为带有关联控件的标签。 可以将其实例传递给 SettingsSection.AddSetting(SettingsEditorControl)。
继承
SettingsElement > SettingsControlBase > SettingsEditorControlBase
属性
类型 |
名称 |
描述 |
---|---|---|
ControlDescriptionBase |
控制 |
要用于此设置的控件。 |
字符串 |
描述 |
(可选)此设置的较长说明文本,显示为工具提示。 |
字符串 |
标签 |
(可选)设置编辑器标签。 这可以是降价文本。 |
可托管编辑器的设置用户界面元素。
继承
SettingsElement > SettingsControlBase > SettingsEditorControlContainer
具有关联键的设置元素的基类。
属性
类型 |
名称 |
描述 |
---|---|---|
字符串 |
密钥 |
与此设置关联的唯一键。 用于存储/检索。 |
SettingsCategory
设置类别。
继承
SettingsControlBase > SettingsEditorControlContainer > SettingsCategory
属性
类型 |
名称 |
描述 |
---|---|---|
字符串 |
描述 |
(可选)显示在标题下方,说明此页面的用途。 |
字符串 |
页眉 |
类别标头。 |
Bool |
IsHidden |
如果设置为
true ,则该类别不会显示在“项目设置” 对话框中。 需要 Studio 2020.4 或更高版本。
|
备注
在活动项目设置中添加类别。
包含相关控件的设置组框。
继承
SettingsElement > SettingsControlBase > SettingsEditorControlContainer > SettingsSection
属性
类型 |
名称 |
描述 |
---|---|---|
字符串 |
描述 |
(可选)显示在标题下方,说明本节的目的。 |
Bool |
IsExpanded |
如果设置为
true ,则默认情况下会展开该部分。
|
字符串 |
标题 |
版块标题。 |
备注
向活动项目设置添加一个设置组框。
允许编辑类型 T 的单个值的设置条目。系统会基于 T 创建默认编辑器。
继承
SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T> > SingleValueEditorDescription
泛型类型 T
此说明适用的设置类型。
属性
类型 |
名称 |
描述 |
---|---|---|
T |
默认值 |
此设置的默认值。 |
Func<T, string> |
验证 |
验证值(适用于允许 Free 文本输入的编辑器)。 |
此设置允许从预定义的值集合中选择单个值。
继承
SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T> > SingleValueEditorDescription > SingleValueSelectorDescription
属性
类型 |
名称 |
描述 |
---|---|---|
string[] |
值 |
要选择的可能值。 |
- IActivitiesSettingsService
- 继承
- 方法
- ModernClassicSettings
- 常量
- MultipleValuesSelectorDescription
- 继承
- 属性
- SettingDescriptionBase
- 继承
- 属性
- SettingDescriptionBase <T>
- 继承
- 泛型类型 T
- 属性
- SettingsControlBase
- 继承
- 属性
- SettingsEditorControlBase
- 继承
- 属性
- SettingsEditorControlContainer
- 继承
- SettingsElement
- 属性
- SettingsCategory
- SettingsSection
- 继承
- 属性
- 备注
- SingleValueEditorDescription
- 继承
- 泛型类型 T
- 属性
- SingleValueSelectorDescription
- 继承
- 属性