sdk

latest

false

Importante :

A tradução automática foi aplicada parcialmente neste conteúdo.

Guia do desenvolvedor

Last updated 25 de out de 2024

UiPath.Studio.Activities.Api.ObjectLibrary

Nesta seção, você pode encontrar mais informações sobre como criar atividades usando o UiPath.Studio.Activities.Api.ObjectLibrary.

ActivityCreationObjectData

Observação: essa funcionalidade foi introduzida na versão 22.4 do UiPath.Studio.Activities.Api.

Modelo usado pelo Repositório de Objetos para interação com o IActivityFactoryRepository. O modelo está disponível para RegisterArgs.FactoryV3 e posterior.

Propriedades

Tipo	Name	Description
String	Id	O ID de origem.
String	Referência	A referência do objeto.

IContentComputeArgs

Observação: essa funcionalidade foi introduzida na versão 21.4 do UiPath.Studio.Activities.Api.

Propriedades

Tipo	Name	Description
String	SourceId	ID de Origem
String	ObjectReference	Referência do Objeto
String	ContentName	Nome do conteúdo

IContentDescription

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Interface do manipulador de conteúdo.

Propriedades

Tipo	Name	Description
String	ContentName	Nome do conteúdo.
String	NomeDeExibição	Nome de exibição localizado.
String	Description	Descrição localizada.
String	DisplayColor	Cor do conteúdo (para os botões de edição de objeto).
byte[]	Ícone	Ícone do conteúdo.
String	SelectionName	Nome da seleção correspondente a este conteúdo registrado usando IObjectSelectionDescription.
Func<IContentEditArgs, Task<bool?>>	OnEdit	Editar gerenciador.
Func<IContentHighlightArgs, Task>	OnHighlight	Habilita a funcionalidade para destacar o elemento no aplicativo de destino.
Bool	NeedsParentValidation	Se for definido como `true` , especifica que este conteúdo precisa de um pai específico para adicionar e mover operações.

Métodos

void RegisterParentValidation(Action<IObjectRestriction> setter)

Usado para validar objetos pai ao adicionar e mover quando AttendsParentValidation é verdadeiro.

Tipo de parâmetro	Nome do parâmetro	Description
Action<IObjectRestriction>	setter

IContentEditArgs

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Propriedades

Tipo	Name	Description
String	SourceId	ID de Origem
String	ObjectReference	Referência do Objeto
String	ContentName	Nome do conteúdo

IContentHighlightArgs

Observação: essa funcionalidade foi introduzida na versão 21.4 do UiPath.Studio.Activities.Api.

Propriedades

Tipo	Name	Description
String	SourceId	ID de Origem
String	ObjectReference	Referência do Objeto
String	ContentName	Nome do conteúdo

IContentOperations

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

API de operações do Designer.

Métodos

void RegisterContent(Action<IContentDescription> setter)

Registra um manipulador de conteúdo para um nome de conteúdo específico

Tipo de parâmetro	Nome do parâmetro
Action<IContentDescription>	setter

void RegisterObjectSelection(Action<IObjectSelectionDescription>setter)

Registra um gerenciador para indicar objetos.

Tipo de parâmetro	Nome do parâmetro
Action<IObjectSelectionDescription>	setter

ILibraryService

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

API para manipular objetos de biblioteca.

Propriedades

Tipo	Name	Description
IContentOperations	Content
IObjectOperations	Objects
Bool	DesignTimeEnforced	Se definido como `true`, o uso de objetos do Repositório de Objetos é imposto.

IObjectCreateCriteria

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Propriedades

Tipo	Name
String	SourceId
String	ObjectRef
String	ParentRef
String	Name
String	Description
String	Tipo
String	TaxonomyType
IReadOnlyList<string>	Content
IReadOnlyList<byte[]>	Imagens

IObjectDragArgs

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Propriedades

Tipo	Name
String	Tipo de Objeto
IReadOnlyList<string>	Content

IObjectOperations

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Métodos

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

Tipo de parâmetro	Nome do parâmetro
Action<IObjectCreateCriteria>	criteriaSetter

void InvokeOnSourcesChanged(Action<ISourcesChangedArgs> handler)

Tipo de parâmetro	Nome do parâmetro
Action<ISourcesChangedArgs>	handler

void InvokeOnBeginDrag(Action<IObjectDragArgs> handler);

Tipo de parâmetro	Nome do parâmetro
Action<IObjectDragArgs>	handler

void InvokeOnEndDrag(Action handler)

Tipo de parâmetro	Nome do parâmetro
Ação	handler

void NotifyObjectChanged(string sourceId, string objectReference)

Tipo de parâmetro	Nome do parâmetro
String	sourceId
String	objectReference

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

Tipo de parâmetro	Nome do parâmetro
String	sourceId
IReadOnlyList<string>	objectReferences

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

Tipo de parâmetro	Nome do parâmetro
String	sourceId
IReadOnlyList<string>	objectReferences

void Focus(string sourceId, string objectReference)

Tipo de parâmetro	Nome do parâmetro
String	sourceId
String	objectReference

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

Tipo de parâmetro	Nome do parâmetro
String	objectReference
Bool	addingToLibrary

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

Tipo de parâmetro	Nome do parâmetro
String	objectReference
Bool	isReindicating

IObjectRestriction

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Propriedades

Tipo	Name	Description
String	Tipo de Objeto	O tipo de objeto ao qual esta restrição se aplica. Se `null`, ele se aplica a todos.
IReadOnlyList<string>	RequiredContent	Usado para validar se o objeto contém um dos nomes de conteúdo especificados.

IObjectSelectionDescription

Observação: essa funcionalidade foi introduzida na versão 21.4 do UiPath.Studio.Activities.Api.

Permite indicar na tela a partir de um objeto do Repositório de Objetos.

Propriedades

Tipo	Name	Description
String	SelectionName	Nome da seleção.
String	NomeDeExibição	Nome de exibição localizado para o botão Indicar .
String	Description	Descrição localizada.
String	DisplayColor	Cor de conteúdo dos botões Editar Objeto .
byte[]	Ícone	Ícone do conteúdo.
String	RecordDisplayName	Nome de exibição localizado para o botão Gravar .
Bool	SupportsObjectRecorderHighlight	Retorna `true` se o realce do elemento for compatível. Requer o Studio 2021.10 ou posterior.
Bool	SupportsObjectRecorderCurrentElements	Retorna `true` se os elementos forem listados durante a gravação. Requer o Studio 2021.10 ou posterior.
IReadOnlyList<string>	Tipos de objeto compatíveis	Retorna uma lista de objetos que podem ser gravados.
Func<ISelectionArgs, Task<bool?>>	OnIndicate	Permite a injeção de uma função que pode ser chamada ao clicar em Indicar na tela .
Func<object>	GetObjectRecorderFactory	Retorna a função que permite a gravação de objetos do Repositório de Objetos.
Func<object>	GetAutoCaptureElementsFactory	Retorna a função que permite acionar a funcionalidade Capturar Tudo a partir do Repositório de Objetos. Requer o Studio 2021.10 ou posterior.