SDK - UiPath.Studio.Activities.Api.ObjectLibrary

sdk

latest

false

开发者指南

重要 :

请注意，此内容已使用机器翻译进行了部分本地化。新发布内容的本地化可能需要 1-2 周的时间才能完成。

UiPath.Studio.Activities.Api.ObjectLibrary

UiPath.Studio.Activities.Api.ObjectLibrary 命名空间，用于构建 Studio 活动，包括 v22.4 中引入的对象存储库交互模型。

在本节中，您可以找到有关如何使用UiPath.Studio.Activities.Api.ObjectLibrary构建活动的更多信息。

ActivityCreationObjectData

备注：

UiPath.Studio.Activities.Api v22.4 中引入了此功能。

“对象存储库”用于与“IActivityFactoryRepository”进行交互的模型。该模型适用于RegisterArgs.FactoryV3及更高版本。

属性

类型	名称	描述
字符串	ID	来源 ID。
字符串	参考	对象引用。

IContentComputeArgs

备注：

UiPath.Studio.Activities.Api v21.4 中引入了此功能。

属性

类型	名称	描述
字符串	SourceId	来源 ID
字符串	ObjectReference	对象引用
字符串	ContentName	内容名称

IContentDescription

备注：

UiPath.Studio.Activities.Api v20.4 中引入了此功能。

内容处理程序接口。

属性

类型	名称	描述
字符串	ContentName	内容名称。
字符串	显示名称	本地化的显示名称。
字符串	描述	本地化说明。
字符串	DisplayColor	内容颜色（用于编辑对象按钮）。
byte[]	图标	内容图标。
字符串	SelectionName	使用IObjectSelectionDescription注册的与此内容对应的选择名称。
`Func<IContentEditArgs, Task<bool?>>`	OnEdit	编辑处理程序。
`Func<IContentHighlightArgs, Task>`	OnHighlight	启用高亮显示目标应用程序中的元素的功能。
Bool	NeedsParentValidation	如果设置为 `true` ，则它指定此内容需要特定的父项才能执行添加和移动操作。

方法

void RegisterParentValidation(Action setter)

用于当“需要父项验证”为“true”时在添加和移动时验证父对象。

参数类型	参数名称	描述
操作	setter

IContentEditArgs

备注：

UiPath.Studio.Activities.Api v20.4 中引入了此功能。

属性

类型	名称	描述
字符串	SourceId	来源 ID
字符串	ObjectReference	对象引用
字符串	ContentName	内容名称

IContentHighlightArgs

备注：

UiPath.Studio.Activities.Api v21.4 中引入了此功能。

属性

类型	名称	描述
字符串	SourceId	来源 ID
字符串	ObjectReference	对象引用
字符串	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 中引入了此功能。

属性

类型	名称
字符串	SourceId
字符串	ObjectRef
字符串	ParentRef
字符串	名称
字符串	描述
字符串	类型
字符串	TaxonomyType
`IReadOnlyList<string>`	内容
IReadOnlyList<byte[]>	图像

IObjectDragArgs

备注：

UiPath.Studio.Activities.Api v20.4 中引入了此功能。

属性

类型	名称
字符串	对象类型
`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)

参数类型	参数名称
字符串	sourceId
字符串	objectReference

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

参数类型	参数名称
字符串	sourceId
`IReadOnlyList<string>`	objectReferences

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

参数类型	参数名称
字符串	sourceId
`IReadOnlyList<string>`	objectReferences

void Focus(string sourceId, string objectReference)

参数类型	参数名称
字符串	sourceId
字符串	objectReference

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

参数类型	参数名称
字符串	objectReference
Bool	addingToLibrary

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

参数类型	参数名称
字符串	objectReference
Bool	isReindicating

IObjectRestriction

备注：

UiPath.Studio.Activities.Api v20.4 中引入了此功能。

属性

类型	名称	描述
字符串	对象类型	此限制适用的对象类型。如果为 `null`，则适用于全部。
`IReadOnlyList<string>`	RequiredContent	用于验证对象是否包含指定的内容名称之一。

IObjectSelectionDescription

备注：

UiPath.Studio.Activities.Api v21.4 中引入了此功能。

允许在屏幕上从对象存储库对象指示。

属性

类型	名称	描述
字符串	SelectionName	选择名称。
字符串	显示名称	“指明”按钮的本地化显示名称。
字符串	描述	本地化说明。
字符串	DisplayColor	“编辑对象”按钮的内容颜色。
byte[]	图标	内容图标。
字符串	RecordDisplayName	录制按钮的本地化显示名称。
Bool	SupportsObjectRecorderHighlight	如果支持元素高亮显示，则返回 `true` 。需要 Studio 2021.10 或更高版本。
Bool	SupportsObjectRecorderCurrentElements	如果在记录期间列出了元素，则返回 `true` 。需要 Studio 2021.10 或更高版本。
`IReadOnlyList<string>`	支持的对象类型	返回可录制的对象列表。
`Func<ISelectionArgs, Task<bool?>>`	OnIndicate	允许注入可在单击“在屏幕上指定”时调用的函数。
Func	GetObjectRecorderFactory	返回允许录制对象存储库中对象的函数。
Func	GetAutoCaptureElementsFactory	返回允许从“对象存储库”中触发“捕获全部”功能的函数。需要 Studio 2021.10 或更高版本。

IObjectSource

备注：

UiPath.Studio.Activities.Api v20.4 中引入了此功能。

属性

类型	名称
字符串	ID
字符串	URL
Bool	CanWrite

ISelectionArgs

备注：

UiPath.Studio.Activities.Api v21.4 中引入了此功能。

属性

类型	名称
字符串	SourceId
字符串	ObjectReference
字符串	SelectionName

此页面有帮助吗？

前一个UiPath.Studio.Activities.Api.Mocking

下一个UiPath.Studio.Activities.Api.PackageBindings

ActivityCreationObjectData​

属性​

IContentComputeArgs​

属性​

IContentDescription​

属性​

方法​

void RegisterParentValidation(Action setter)​

IContentEditArgs​

属性​

IContentHighlightArgs​

属性​

IContentOperations​

方法​

void RegisterContent(Action setter)​

void RegisterObjectSelection(Actionsetter)​

ILibraryService​

属性​

IObjectCreateCriteria​

属性​

IObjectDragArgs​

属性​

IObjectOperations​

方法​

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

void InvokeOnSourcesChanged(Action handler)​

void InvokeOnBeginDrag(Action handler);​

void InvokeOnEndDrag(Action handler)​

void NotifyObjectChanged(string sourceId, string objectReference)​

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

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

void Focus(string sourceId, string objectReference)​

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

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

IObjectRestriction​

属性​

IObjectSelectionDescription​

属性​

IObjectSource​

属性​

ISelectionArgs​

属性​

此页面有帮助吗？

ActivityCreationObjectData

属性

IContentComputeArgs

属性

IContentDescription

属性

方法

void RegisterParentValidation(Action setter)

IContentEditArgs

属性

IContentHighlightArgs

属性

IContentOperations

方法

void RegisterContent(Action setter)

void RegisterObjectSelection(Actionsetter)

ILibraryService

属性

IObjectCreateCriteria

属性

IObjectDragArgs

属性

IObjectOperations

方法

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

void InvokeOnSourcesChanged(Action handler)

void InvokeOnBeginDrag(Action handler);

void InvokeOnEndDrag(Action handler)

void NotifyObjectChanged(string sourceId, string objectReference)

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

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

void Focus(string sourceId, string objectReference)

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

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

IObjectRestriction

属性

IObjectSelectionDescription

属性

IObjectSource

属性

ISelectionArgs

属性