UiPath.Studio.Activities.Api.Settings

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

IActivitiesSettingsService

Ponto de entrada para funcionalidades relacionadas a configurações.

Herança

IActivitiesSettingsReader > IActivitiesSettingsService

Métodos

void AddCategory(SettingsCategory category)

Adicione uma categoria de configurações na interface gráfica de configurações do projeto.

Tipo de parâmetro	Nome do parâmetro	Description
SettingsCategory	categoria	A descrição da página de configurações.

void AddSection(SettingsCategory category, SettingsSection section)

Adicione uma seção a esta categoria.

Tipo de parâmetro	Nome do parâmetro	Description
SettingsCategory	categoria
SettingsSection	Seção	Se a chave da seção não começar com a chave de categoria, a última será adicionada como prefixo da primeira e o valor de SettingsElement.Key será atualizado.

void AddSetting(SettingsEditorControlContainer parent, SettingDescriptionBase setting)

Gera um Editor de Configurações padrão com base na Configuração e o passa para AddSetting(SettingsEditorControlContainer).

Tipo de parâmetro	Nome do parâmetro	Description
SettingsEditorControlContainer	Pai	A CategoriaDeConfigurações ou SeçãoDeConfigurações em que o controle de configuração gerado é anexado.
SettingDescriptionBase	Configuração	A descrição da configuração que é usada para gerar um controle.

void AddSetting(SettingsEditorControlContainer parent, SettingsEditorControl setting)

Adicionar um controle de configurações

Tipo de parâmetro	Nome do parâmetro	Description
SettingsEditorControlContainer	Pai	A CategoriaDeConfigurações ou SeçãoDeConfigurações em que o controle de configuração gerado é anexado.
SettingsEditorControl	Configuração	A descrição da configuração que é usada para gerar um controle.

bool TrySetValue (string key, string value)

Define e salva um valor de configuração.

Tipo de parâmetro	Nome do parâmetro	Description
String	chave	A chave da configuração.
String	Value	O valor da configuração.

ModernClassicSettings

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

Define como um pacote de atividades prefere lidar com atividades Modernas vs Clássicas. Se definido como UseGlobalSetting, adiará o comportamento para a configuração global do Studio. Tê-lo definido explicitamente como UseModern ou UseClassic resultará na configuração sendo substituída para o pacote específico.

Constantes

Tipo	Name	Description
String	UseGlobalSetting	Adia a decisão para a configuração global do Studio.
String	UseModern	Torna as atividades modernas o padrão.
String	UseClassic	Torna as atividades clássicas o padrão.

MultipleValuesSelectorDescription

Uma configuração que permite selecionar vários valores de uma coleção predefinida.

Herança

SettingsElement > SettingDescriptionBase > MultipleValuesSelectorDescription

Propriedades

Tipo	Name	Description
String	Valores	Possíveis valores a serem selecionados.
String	Valores padrão	Seleção padrão.

SettingDescriptionBase

Formata um valor para exibição.

Herança

SettingsElement > SettingDescriptionBase

Propriedades

Tipo	Name	Description
String	Description	Uma explicação da configuração.
Bool	ÉSomenteLeitura	Se definido como true, o valor não é editável nem persistente.
Bool	IsDesignTime	Retorna truese invocado no momento do design. Requer o Studio 2021.10 ou posterior.
String	Label	O rótulo a ser usado para esta configuração.
Bool	RequiresPackageReload	Se definido como true, alterar essa configuração exigirá o recarregamento do pacote. Requer o Studio 2021.10 ou posterior.

SettingDescriptionBase <T>

Uma descrição de configuração que se aplica a um determinado tipo.

Herança

SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T>

Genérico Tipo T

O tipo de configuração para a qual esta descrição se aplica.

Propriedades

Tipo	Name	Description
Func<T, string>	GetDisplayValue	Função que precisa retornar um valor de exibição formatado para um determinado tipo.

SettingsControlBase

Um elemento de configurações que faz parte da interface gráfica.

Herança

SettingsElement > SettingsControlBase

Propriedades

Tipo	Name	Description
Bool	IsDesignTime	Retorna true quando invocado no momento do design. Requer o Studio 2021.10 ou posterior.
Bool	RequiresPackageReload	Se definido como true, alterar essa configuração exigirá recarregamento do pacote Isso se aplica apenas às configurações de tempo de design. Requer o Studio 2021.10 ou posterior.

SettingsEditorControlBase

Editor de configurações. Ele é exibido como um rótulo a um controle associado. Uma instância disso pode ser passada para SettingsSection.AddSetting(SettingsEditorControl).

Herança

SettingsElement > SettingsControlBase > SettingsEditorControlBase

Propriedades

Tipo	Name	Description
ControlDescriptionBase	Controle	O controle a ser usado para essa configuração.
String	Description	(Opcional) Um texto explicativo mais longo para essa configuração, exibido como uma dica de ferramenta.
String	Label	(Opcional) O rótulo do editor de configurações. Pode ser um texto de markdown.

SettingsEditorControlContainer

Um elemento de interface gráfica de configurações que pode hospedar editores.

Herança

SettingsElement > SettingsControlBase > SettingsEditorControlContainer

SettingsElement

Classe base para elementos de configurações com chaves associadas.

Propriedades

Tipo	Name	Description
String	Chave	A chave exclusiva associada a esta configuração. Usado para armazenamento/recuperação.

SettingsCategory

Uma categoria de configurações.

Herança

SettingsControlBase > SettingsEditorControlContainer > SettingsCategory

Propriedades

Tipo	Name	Description
String	Description	(Opcional) Exibido abaixo do título, explica o propósito da página.
String	Cabeçalho	O cabeçalho da categoria.
Bool	IsHidden	Se definida como true, a categoria não será exibida na caixa de diálogo Configurações do Projeto. Requer o Studio 2020.4 ou posterior.

Considerações

Adiciona uma categoria nas configurações do projeto de atividades.

SettingsSection

Uma caixa de grupo de configurações contendo controles relacionados.

Herança

SettingsElement > SettingsControlBase > SettingsEditorControlContainer > SettingsSection

Propriedades

Tipo	Name	Description
String	Description	(Opcional) Exibido abaixo do título, uma explicação do propósito dessa seção.
Bool	IsExpanded	Se definida como true, a seção é expandida por padrão.
String	Título	O título da seção.

Considerações

Adiciona uma caixa de grupo de configurações às configurações do projeto de atividades.

SingleValueEditorDescription

Uma entrada de configuração que permite editar um único valor do tipo T. Um editor padrão é criado com base em T.

Herança

SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T> > SingleValueEditorDescription

Genérico Tipo T

O tipo de configuração para a qual esta descrição se aplica.

Propriedades

Tipo	Name	Description
D	ValorPadrão	O valor padrão dessa configuração.
Func<T, string>	Validar	Valide um valor (aplica-se a editores que permitem a entrada Free texto livre).

SingleValueSelectorDescription

Uma configuração que permite selecionar um único valor de uma coleção predefinida de valores.

Herança

SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T> > SingleValueEditorDescription > SingleValueSelectorDescription

Propriedades

Tipo	Name	Description
string[]	Valor	Possíveis valores a serem selecionados.