SDK

UiPath.Studio.Activities.Api.Settings

このセクションでは、 UiPath.Studio.Activities.API.Settingsを使用してアクティビティを構築する方法について詳しく説明します。

IActivitiesSettingsService

設定関連の機能のエントリポイントです。

継承

IActivitiesSettingsReader > IActivitiesSettingsService

メソッド

void AddCategory(SettingsCategory category)

プロジェクト設定 UI に設定カテゴリを追加します。

パラメーターの種類	パラメーター名	説明
SettingsCategory	カテゴリ	設定ページの説明です。

void AddSection(SettingsCategory category, SettingsSection section)

このカテゴリにセクションを追加します。

パラメーターの種類	パラメーター名	説明
SettingsCategory	カテゴリ
SettingsSection	セクション	セクションキーがカテゴリキーで始まるわけではない場合、後者は前者のプレフィックスとして追加され、SettingsElement.Key の値が更新されます。

void AddSetting(SettingsEditorControlContainer parent, SettingDescriptionBase setting)

設定に基づいて既定の設定エディターを生成し、AddSetting (SettingsEditorControlContainer) に渡します。

パラメーターの種類	パラメーター名	説明
SettingsEditorControlContainer	親	[ 設定のカテゴリ] または [設定] セクション。生成された設定コントロールが追加されます。
SettingDescriptionBase	設定	コントロールの生成に使用する設定の説明です。

void AddSetting(SettingsEditorControlContainer parent, SettingsEditorControl setting)

設定コントロールを追加する

パラメーターの種類	パラメーター名	説明
SettingsEditorControlContainer	親	[ 設定のカテゴリ] または [設定] セクション。生成された設定コントロールが追加されます。
SettingsEditorControl	設定	コントロールの生成に使用する設定の説明です。

bool TrySetValue (string key, string value)

設定値を設定して保存します。

パラメーターの種類	パラメーター名	説明
string	キー	設定のキーです。
string	value	設定の値です。

ModernClassicSettings

メモ：この機能は UiPath.Studio.Activities.API v21.10 で導入されました。

アクティビティパッケージがモダンアクティビティとクラシックアクティビティをどのように処理するかを定義します。 [ UseGlobalSetting] に設定すると、Studio のグローバル設定の動作が延期されます。 UseModern または UseClassic に明示的に設定すると、特定のパッケージで設定が上書きされます。

定数

入力	名前	説明
string	UseGlobalSetting	Studio のグローバル設定の判断を延期します。
string	UseModern	モダンアクティビティを既定のアクティビティにします。
string	UseClassic	クラシックアクティビティを既定にします。

MultipleValuesSelectorDescription

定義済みの値のコレクションから複数の値を選択できる設定です。

継承

SettingsElement > SettingDescriptionBase > MultipleValuesSelectorDescription

プロパティ

入力	名前	説明
string	値	選択できる値です。
string	既定値	既定の選択項目です。

SettingDescriptionBase

表示する値の書式を設定します。

継承

SettingsElement > SettingDescriptionBase

プロパティ

入力	名前	説明
string	説明	設定の説明。
Bool	読み取り専用	[ `true`に設定すると、値は編集できず、保持されません。
Bool	IsDesignTime	設計時に呼び出した場合 `true`を返します。 v2021.10 以降の Studio が必要です。
string	ラベル	この設定に使用するラベルです。
Bool	RequiresPackageReload	`true`に設定した場合は、この設定を変更するにはパッケージを再読み込みする必要があります。v2021.10 以降の Studio が必要です。

SettingDescriptionBase <T>

特定の種類に適用される設定の説明です。

継承

SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T>

一般型 T

この説明が適用される設定の種類です。

プロパティ

入力	名前	説明
Func<T, string>	GetDisplayValue	指定した型の書式付きの表示値を返す必要がある関数。

SettingsControlBase

UI に含まれる settings 要素です。

継承

SettingsElement > SettingsControlBase

プロパティ

入力	名前	説明
Bool	IsDesignTime	設計時に呼び出された場合 `true` を返します。 v2021.10 以降の Studio が必要です。
Bool	RequiresPackageReload	`true`に設定した場合は、この設定を変更するにはパッケージを再読み込みする必要があります。これは設計時の設定にのみ適用されます。v2021.10 以降の Studio が必要です。

SettingsEditorControlBase

設定エディター。関連付けられたコントロールのラベルとして表示されます。このインスタンスは、SettingsSection.AddSetting(SettingsEditorControl) に渡すことができます。

継承

SettingsElement > SettingsControlBase > SettingsEditorControlBase

プロパティ

入力	名前	説明
ControlDescriptionBase	制御	この設定に使用するコントロールです。
string	説明	(任意)この設定の説明用のテキストがツールチップに表示されるようにしました。
string	ラベル	(任意)設定エディターラベル。これはマークダウンテキストです。

SettingsEditorControlContainer

エディターをホストできる設定 UI 要素です。

継承

SettingsElement > SettingsControlBase > SettingsEditorControlContainer

SettingsElement

関連付けられたキーを持つ設定要素の基本クラスです。

プロパティ

入力	名前	説明
string	キー	この設定に関連付けられている一意のキーです。ストレージ/取得に使用します。

SettingsCategory

設定カテゴリです。

継承

SettingsControlBase > SettingsEditorControlContainer > SettingsCategory

プロパティ

入力	名前	説明
string	説明	(任意)次のタイトルを表示して、このページの目的について説明します。
string	ヘッダー	カテゴリヘッダーです。
Bool	IsHidden	`true`設定すると、カテゴリは [プロジェクト設定] ダイアログに表示されません。v2020.4 以降の Studio が必要です。

備考

アクティビティのプロジェクト設定にカテゴリを追加します。

SettingsSection

関連するコントロールを含む設定グループボックスです。

継承

SettingsElement > SettingsControlBase > SettingsEditorControlContainer > SettingsSection

プロパティ

入力	名前	説明
string	説明	(任意)次のタイトルが表示されます。このセクションの目的を説明します。
Bool	IsExpanded	`true`に設定すると、セクションが既定で展開されます。
string	タイトル	セクションのタイトルです。

備考

アクティビティのプロジェクト設定に設定グループボックスを追加します。

SingleValueEditorDescription

T 型の単一値の編集が可能な設定エントリです。既定のエディターが T に基づいて作成されます。

継承

SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T> > SingleValueEditorDescription

一般型 T

この説明が適用される設定の種類です。

プロパティ

入力	名前	説明
T	DefaultValue	この設定の既定値です。
Func<T, string>	検証	値を検証します (テキスト入力を許可するエディター Free 適用されます)。