sdk
latest
false
Importante :
Este contenido se ha localizado parcialmente a partir de un sistema de traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.
UiPath logo, featuring letters U and I in white

Guía del desarrollador

Última actualización 25 de oct. de 2024

UiPath.Studio.Activities.Api.Settings

En esta sección puedes encontrar más información sobre cómo crear actividades usando UiPath.Studio.Activities.Api.Settings.

IActivitiesSettingsService

Punto de entrada para funciones relacionadas con la configuración.

Herencia

IActivitiesSettingsReader > IActivitiesSettingsService

Métodos

void AddCategory(SettingsCategory category)

Añade una categoría de configuración en la interfaz de usuario de configuración del proyecto.

Tipo de parámetro

Nombre del parámetro

Descripción

SettingsCategory

Categoría

La descripción de la página de configuración.

void AddSection(SettingsCategory category, SettingsSection section)

Añade una sección a esta categoría.

Tipo de parámetro

Nombre del parámetro

Descripción

SettingsCategory

Categoría

 

SettingsSection

Sección

Si la clave de sección no comienza con la clave de categoría, esta última se añade como prefijo de la primera y se actualiza el valor SettingsElement.Key .

void AddSetting(SettingsEditorControlContainer parent, SettingDescriptionBase setting)

Genera un editor de configuración predeterminado basado en la configuración y lo pasa a AddSetting (SettingsEditorContainer).

Tipo de parámetro

Nombre del parámetro

Descripción

SettingsEditorControlContainer

Principal

La CategoríaDeAjustes o la SecciónDeAjustes donde se adjunta el control de configuración generado.

SettingDescriptionBase

Configuración

La descripción del ajuste que se utiliza para generar un control.

void AddSetting(SettingsEditorControlContainer parent, SettingsEditorControl setting)

Añadir un control de configuración

Tipo de parámetro

Nombre del parámetro

Descripción

SettingsEditorControlContainer

Principal

La CategoríaDeAjustes o la SecciónDeAjustes donde se adjunta el control de configuración generado.

SettingsEditorControl

Configuración

La descripción del ajuste que se utiliza para generar un control.

bool TrySetValue (string key, string value)

Establece y guarda un valor de configuración.

Tipo de parámetro

Nombre del parámetro

Descripción

String

clave

La clave del entorno.

String

valor

El valor de la configuración.

ModernClassicSettings

Nota: esta característica se introdujo en UiPath.Studio.Activities.Api v21.10.

Define cómo un paquete de actividades prefiere manejar las actividades modernas frente a las clásicas. Si se establece en UseGlobalSetting, aplazará el comportamiento a la configuración global de Studio. Tenerlo explícitamente configurado como UseModern o UseClassic hará que la configuración se sobrescriba para el paquete en particular.

Constantes

Tipo

Nombre

Descripción

String

UseGlobalSetting

Difiere la decisión a la configuración global de Studio.

String

UseModern

Hace que las actividades modernas sean las predeterminadas.

String

UseClassic

Hace que las actividades clásicas sean las predeterminadas.

MultipleValuesSelectorDescription

Un ajuste que permite seleccionar múltiples valores de una colección predefinida de valores.

Herencia

SettingsElement > SettingDescriptionBase > MultipleValuesSelectorDescription

Propiedades

Tipo

Nombre

Descripción

String

Valores

Valores posibles para seleccionar.

String

Valores predeterminados

Selección predeterminada.

SettingDescriptionBase

Aplicar formato a un valor para mostrar.

Herencia

SettingsElement > SettingDescriptionBase

Propiedades

Tipo

Nombre

Descripción

String

Descripción

Una explicación del entorno.

Booleano

EsDeSoloLectura

Si se establece en true, el valor no se puede editar ni conservar.

Booleano

IsDesignTime

Devuelve truesi se invoca en el tiempo de diseño. Requiere Studio 2021.10 o posterior.

String

Etiqueta

La etiqueta que se utilizará para esta configuración.

Booleano

RequiresPackageReload

Si se establece en true, es necesario volver a cargar el paquete para cambiar esta configuración. Requiere Studio 2021.10 o posterior.

SettingDescriptionBase <T>

Una descripción de configuración que se aplica a un tipo concreto.

Herencia

SettingsElement > SettingDescriptionBase > SettingDescriptionBase<T>

Tipo genérico

El tipo de ajuste al que se aplica esta descripción.

Propiedades

Tipo

Nombre

Descripción

Func<T, string>

GetDisplayValue

Función que debe devolver un valor de visualización con formato para un tipo determinado.

SettingsControlBase

Un elemento de configuración que forma parte de la interfaz de usuario.

Herencia

SettingsElement > SettingsControlBase

Propiedades

Tipo

Nombre

Descripción

Booleano

IsDesignTime

Devuelve true cuando se invoca en el tiempo de diseño. Requiere Studio 2021.10 o posterior.

Booleano

RequiresPackageReload

Si se establece en true, cambiar esta configuración requiere volver a cargar el paquete. Esto solo se aplica a la configuración de tiempo de diseño. Requiere Studio 2021.10 o posterior.

SettingsEditorControlBase

Editor de ajustes. Aparece como una etiqueta con un control asociado. Se puede pasar una instancia de esto a SettingsSection.AddSetting (SettingsEditorControl).

Herencia

SettingsElement > SettingsControlBase > SettingsEditorControlBase

Propiedades

Tipo

Nombre

Descripción

ControlDescriptionBase

Control

El control que se utilizará para esta configuración.

String

Descripción

(Opcional) Un texto explicativo más largo para esta configuración, mostrado como información sobre herramientas.

String

Etiqueta

(Opcional) La etiqueta del editor de configuración. Este puede ser un texto de reducción.

SettingsEditorControlContainer

Un elemento de la interfaz de usuario de configuración que puede alojar editores.

Herencia

SettingsElement > SettingsControlBase > SettingsEditorControlContainer

SettingsElement

Clase base para elementos de configuración con claves asociadas.

Propiedades

Tipo

Nombre

Descripción

String

Clave

La clave única asociada con esta configuración. Utilizado para almacenamiento / recuperación.

SettingsCategory

Una categoría de configuración.

Herencia

Propiedades

Tipo

Nombre

Descripción

String

Descripción

(Opcional) Se muestra debajo del título y explica el propósito de esta página.

String

Encabezado

El encabezado de la categoría.

Booleano

IsHidden

Si se establece en true, la categoría no se mostrará en el cuadro de diálogo Configuración del proyecto. Requiere Studio 2020.4 o posterior.

Observaciones

Añade una categoría en la configuración del proyecto de actividades.



SettingsSection

Un cuadro de grupo de configuración que contiene los controles relacionados.

Propiedades

Tipo

Nombre

Descripción

String

Descripción

(Opcional) Se muestra debajo del título, una explicación del propósito de esta sección.

Booleano

IsExpanded

Si se establece en true, la sección se expande de forma predeterminada.

String

Título

El título de la sección.

Observaciones

Añade un cuadro de grupo de configuración a la configuración del proyecto de actividades.

docs image

SingleValueEditorDescription

Una entrada de configuración que permite editar un único valor de tipo T. Se crea un editor predeterminado basado en T.

Herencia

Tipo genérico

El tipo de ajuste al que se aplica esta descripción.

Propiedades

Tipo

Nombre

Descripción

T

ValorPredeterminado

El valor predeterminado de esta configuración.

Func<T, string>

Validar

Validar un valor (se aplica a los editores que permiten la entrada de texto Free ).

SingleValueSelectorDescription

Un ajuste que permite seleccionar un único valor de una colección predefinida de valores.

Propiedades

Tipo

Nombre

Descripción

string[]

Valor

Valores posibles para seleccionar.

¿Te ha resultado útil esta página?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Uipath Logo White
Confianza y seguridad
© 2005-2024 UiPath. Todos los derechos reservados.