sdk
latest
false
Developer Guide
Last updated Mar 23, 2024

UiPath.Studio.Activities.Api.ObjectLibrary

In this section you can find more information on how to build activities using UiPath.Studio.Activities.Api.ObjectLibrary.

ActivityCreationObjectData

Note: This feature was introduced in UiPath.Studio.Activities.Api v22.4.

Model that is used by the Object Repository for interaction with IActivityFactoryRepository. The model is available for RegisterArgs.FactoryV3 and later.

Properties

Type

Name

Description

string

Id

The source ID.

string

Reference

The object reference.

IContentComputeArgs

Note: This feature was introduced in UiPath.Studio.Activities.Api v21.4.

Properties

Type

Name

Description

string

SourceId

Source ID

string

ObjectReference

Object reference

string

ContentName

Content name

IContentDescription

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Content handler interface.

Properties

Type

Name

Description

string

ContentName

Content name.

string

DisplayName

Localized display name.

string

Description

Localized description.

string

DisplayColor

Content color (for the edit object buttons).

byte[]

Icon

Content icon.

string

SelectionName

Selection name corresponding to this content registered using IObjectSelectionDescription.

Func<IContentEditArgs, Task<bool?>>

OnEdit

Edit handler.

Func<IContentHighlightArgs, Task>

OnHighlight

Enables functionality to highlight the element in the target application.

bool

NeedsParentValidation

If set to true it specifies that this content needs a specific parent on add and move operations.

Methods

void RegisterParentValidation(Action<IObjectRestriction> setter)

Used to validate parent objects on add and move when NeedsParentValidation is true.

Parameter Type

Parameter Name

Description

Action<IObjectRestriction>

setter

 

IContentEditArgs

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Properties

Type

Name

Description

string

SourceId

Source ID

string

ObjectReference

Object reference

string

ContentName

Content name

IContentHighlightArgs

Note: This feature was introduced in UiPath.Studio.Activities.Api v21.4.

Properties

Type

Name

Description

string

SourceId

Source ID

string

ObjectReference

Object reference

string

ContentName

Content name

IContentOperations

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Designer operations API.

Methods

void RegisterContent(Action<IContentDescription> setter)

Registers a content handler for a specific content name

Parameter Type

Parameter Name

Action<IContentDescription>

setter

void RegisterObjectSelection(Action<IObjectSelectionDescription>setter)

Registers a handler for indicating objects.

Parameter Type

Parameter Name

Action<IObjectSelectionDescription>

setter

ILibraryService

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

API for manipulating library objects.

Properties

Type

Name

Description

Content

 

Objects

 

bool

DesignTimeEnforced

If set to true, the use of objects from the Object Repository is enforced.

IObjectCreateCriteria

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Properties

Type

Name

string

SourceId

string

ObjectRef

string

ParentRef

string

Name

string

Description

string

Type

string

TaxonomyType

IReadOnlyList<string>

Content

IReadOnlyList<byte[]>

Images

IObjectDragArgs

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Properties

Type

Name

string

ObjectType

IReadOnlyList<string>

Content

IObjectOperations

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Methods

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

Parameter Type

Parameter Name

Action<IObjectCreateCriteria>

criteriaSetter

void InvokeOnSourcesChanged(Action<ISourcesChangedArgs> handler)

Parameter Type

Parameter Name

Action<ISourcesChangedArgs>

handler

void InvokeOnBeginDrag(Action<IObjectDragArgs> handler);

Parameter Type

Parameter Name

Action<IObjectDragArgs>

handler

void InvokeOnEndDrag(Action handler)

Parameter Type

Parameter Name

Action

handler

void NotifyObjectChanged(string sourceId, string objectReference)

Parameter Type

Parameter Name

string

sourceId

string

objectReference

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

Parameter Type

Parameter Name

string

sourceId

IReadOnlyList<string>

objectReferences

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

Parameter Type

Parameter Name

string

sourceId

IReadOnlyList<string>

objectReferences

void Focus(string sourceId, string objectReference)

Parameter Type

Parameter Name

string

sourceId

string

objectReference

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

Parameter Type

Parameter Name

string

objectReference

bool

addingToLibrary

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

Parameter Type

Parameter Name

string

objectReference

bool

isReindicating

IObjectRestriction

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Properties

Type

Name

Description

string

ObjectType

The type of object this restriction applies to. If null, it applies to all.

IReadOnlyList<string>

RequiredContent

Used to validate if the object contains one of the specified content names.

IObjectSelectionDescription

Note: This feature was introduced in UiPath.Studio.Activities.Api v21.4.

Allows indicating on screen from an Object Repository object.

Properties

Type

Name

Description

string

SelectionName

Selection name.

string

DisplayName

Localized display name for the Indicate button.

string

Description

Localized description.

string

DisplayColor

Content color for the Edit Object buttons.

byte[]

Icon

Content icon.

string

RecordDisplayName

Localized display name for the Record button.

bool

SupportsObjectRecorderHighlight

Returns true if element highlighting is supported. Requires Studio 2021.10 or later.

bool

SupportsObjectRecorderCurrentElements

Returns true if elements are listed during recording. Requires Studio 2021.10 or later.

IReadOnlyList<string>

SupportedObjectTypes

Returns a list of objects that can be recorded.

Func<ISelectionArgs, Task<bool?>>

OnIndicate

Allows the injection of a function that can be called when Indicate on screen was clicked.

Func<object>

GetObjectRecorderFactory

Returns the function that allows the recording of objects from the Object Repository.

Func<object>

GetAutoCaptureElementsFactory

Returns the function that allows triggering the Capture All feature from the Object Repository. Requires Studio 2021.10 or later.

IObjectSource

Note: This feature was introduced in UiPath.Studio.Activities.Api v20.4.

Properties

Type

Name

string

Id

string

Url

bool

CanWrite

ISelectionArgs

Note: This feature was introduced in UiPath.Studio.Activities.Api v21.4.

Properties

Type

Name

string

SourceId

string

ObjectReference

string

SelectionName

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.