UiPath.Studio.Activities.Api.ObjectLibrary

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

ActivityCreationObjectData

注:

この機能は UiPath.Studio.Activities.Api v22.4 で導入されました。

オブジェクト リポジトリが IActivityFactoryRepository とのインタラクションに使用するモデルです。このモデルは、 RegisterArgs.FactoryV3 以降で使用できます。

プロパティ

入力	名前	説明
string	ID	ソース ID です。
string	参照	オブジェクトの参照です。

IContentComputeArgs

注:

この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。

プロパティ

入力	名前	説明
string	SourceId	ソース ID
string	ObjectReference	オブジェクト参照
string	ContentName	コンテンツ名

IContentDescription

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

コンテンツ ハンドラー インターフェイス。

プロパティ

入力	名前	説明
string	ContentName	コンテンツ名です。
string	表示名	ローカライズされた表示名です。
string	説明	ローカライズされた説明。
string	DisplayColor	コンテンツの色 (オブジェクトの編集ボタンの場合)
byte[]	Icon	コンテンツ アイコン。
string	SelectionName	IObjectSelectionDescription を使用して登録されたこのコンテンツに対応する選択名。
Func<IContentEditArgs, Task<bool?>>	OnEdit	編集ハンドラー。
Func<IContentHighlightArgs, Task>	OnHighlight	対象のアプリケーション内の要素を強調表示する機能を有効化します。
Bool	NeedsParentValidation	true に設定すると、このコンテンツには追加操作および移動操作に対する特定の親が必要であると指定されます。

メソッド

void RegisterParentValidation(Action setter)

NeedsParentValidation が true の場合に、追加時と移動時に親オブジェクトを検証するために使用されます。

パラメーターの種類	パラメーター名	説明
操作	setter

IContentEditArgs

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

プロパティ

入力	名前	説明
string	SourceId	ソース ID
string	ObjectReference	オブジェクト参照
string	ContentName	コンテンツ名

IContentHighlightArgs

注:

この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。

プロパティ

入力	名前	説明
string	SourceId	ソース ID
string	ObjectReference	オブジェクト参照
string	ContentName	コンテンツ名

IContentOperations

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

デザイナー操作 API。

メソッド

void RegisterContent(Action setter)

特定のコンテンツ名に対してコンテンツ ハンドラーを登録します。

パラメーターの種類	パラメーター名
操作	setter

void RegisterObjectSelection(Actionsetter)

オブジェクトを指定するためのハンドラーを登録します。

パラメーターの種類	パラメーター名
操作	setter

ILibraryService

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

ライブラリ オブジェクトを操作するための API です。

プロパティ

入力	名前	説明
IContentOperations	コンテンツ
IObjectOperations	オブジェクト
Bool	DesignTimeEnforced	trueに設定すると、オブジェクト リポジトリのオブジェクトの使用が強制されます。

IObjectCreateCriteria

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

プロパティ

入力	名前
string	SourceId
string	ObjectRef
string	ParentRef
string	名前
string	説明
string	入力
string	TaxonomyType
IReadOnlyList<string>	コンテンツ
IReadOnlyList<byte[]>	画像

IObjectDragArgs

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

プロパティ

入力	名前
string	オブジェクトの種類
IReadOnlyList<string>	コンテンツ

IObjectOperations

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

メソッド

Task<IObjectCreateCriteria> ShowCreateWindow(Action<IObjectCreateCriteria> criteriaSetter)

パラメーターの種類	パラメーター名
操作	criteriaSetter

void InvokeOnSourcesChanged(Action handler)

パラメーターの種類	パラメーター名
操作	handler

void InvokeOnBeginDrag(Action handler);

パラメーターの種類	パラメーター名
操作	handler

void InvokeOnEndDrag(Action handler)

パラメーターの種類	パラメーター名
操作	handler

void NotifyObjectChanged(string sourceId, string objectReference)

パラメーターの種類	パラメーター名
string	sourceId
string	objectReference

IDisposable BeginEdit(string sourceId, IReadOnlyList<string> objectReferences)

パラメーターの種類	パラメーター名
string	sourceId
IReadOnlyList<string>	objectReferences

Task<IDisposable> BeginEditAsync(string sourceId, IReadOnlyList<string> objectReferences)

パラメーターの種類	パラメーター名
string	sourceId
IReadOnlyList<string>	objectReferences

void Focus(string sourceId, string objectReference)

パラメーターの種類	パラメーター名
string	sourceId
string	objectReference

Task<bool?> ShowReuseObjectDialog(string objectReference, bool addingToLibrary)

パラメーターの種類	パラメーター名
string	objectReference
Bool	addingToLibrary

Task<bool?> ShowEditLinkedObjectDialog(string objectReference, bool isReindicating)

パラメーターの種類	パラメーター名
string	objectReference
Bool	isReindicating

IObjectRestriction

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

プロパティ

入力	名前	説明
string	オブジェクトの種類	この制限が適用されるオブジェクトの種類です。 nullすると、すべてに適用されます。
IReadOnlyList<string>	RequiredContent	オブジェクトに指定したコンテンツ名が 1 つ含まれているかどうかを検証するために使用されます。

IObjectSelectionDescription

注:

この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。

オブジェクト リポジトリ オブジェクトから画面上で指定できます。

プロパティ

入力	名前	説明
string	SelectionName	選択名です。
string	表示名	[指定] ボタンのローカライズされた表示名です。
string	説明	ローカライズされた説明。
string	DisplayColor	[オブジェクトを編集] ボタンのコンテンツの色です。
byte[]	Icon	コンテンツ アイコン。
string	RecordDisplayName	[記録] ボタンのローカライズされた表示名です。
Bool	SupportsObjectRecorderHighlight	要素の強調表示がサポートされている場合 true を返します。 v2021.10 以降の Studio が必要です。
Bool	SupportsObjectRecorderCurrentElements	記録中に要素が一覧表示されている場合に true を返します。 v2021.10 以降の Studio が必要です。
IReadOnlyList<string>	サポートされているオブジェクトの種類	記録できるオブジェクトのリストを返します。
Func<ISelectionArgs, Task<bool?>>	OnIndicate	[画面上で指定] をクリックしたときに呼び出すことができる関数の挿入を許可します。
Func	GetObjectRecorderFactory	オブジェクト リポジトリからのオブジェクトの記録を可能にする関数を返します。
Func	GetAutoCaptureElementsFactory	オブジェクト リポジトリから [すべてをキャプチャ ] 機能をトリガーできる関数を返します。v2021.10 以降の Studio が必要です。

IObjectSource

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

プロパティ

入力	名前
string	ID
string	URL
Bool	CanWrite

ISelectionArgs

注:

この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。

プロパティ

入力	名前
string	SourceId
string	ObjectReference
string	SelectionName