UiPath.Studio.Activities.Api.Settings

Dans cette section, vous trouverez davantage d'informations sur la création d'activités à l'aide de UiPath.Studio.Activities.Api.Settings.

IActivitiesSettingsService

Point d'entrée pour les fonctionnalités liées aux paramètres.

Héritage

Lecteur ParamètresIActivities > ServiceParamètresIActivities

Méthodes

void AddCategory(SettingsCategory category)

Ajoutez une catégorie de paramètres dans l'interface utilisateur des paramètres du projet.

Type de paramètre	Nom du paramètre	Description
SettingsCategory	Catégorie	La description de la page des paramètres.

void AddSection(SettingsCategory category, SettingsSection section)

Ajoutez une section à cette catégorie.

Type de paramètre	Nom du paramètre	Description
SettingsCategory	Catégorie
SettingsSection	Section	Si la clé de section ne commence pas par la clé de catégorie, la dernière est ajoutée comme préfixe de la première et la valeur SettingsElement.Key est mise à jour.

void AddSetting(SettingsEditorControlContainer parent, SettingDescriptionBase setting)

Génère un éditeur de paramètres par défaut en fonction du paramètre et le transmet à AddSetting(SettingsEditorControlContainer).

Type de paramètre	Nom du paramètre	Description
SettingsEditorControlContainer	Parent	La CatégorieParamètres ou la SectionParamètres dans laquelle la commande de paramètre générée est ajoutée.
SettingDescriptionBase	Paramètre	La description du paramètre utilisée pour générer une commande.

void AddSetting(SettingsEditorControlContainer parent, SettingsEditorControl setting)

Ajouter une commande de paramètres

Type de paramètre	Nom du paramètre	Description
SettingsEditorControlContainer	Parent	La CatégorieParamètres ou la SectionParamètres dans laquelle la commande de paramètre générée est ajoutée.
SettingsEditorControl	Paramètre	La description du paramètre utilisée pour générer une commande.

bool TrySetValue (string key, string value)

Définit et enregistre une valeur de paramètre.

Type de paramètre	Nom du paramètre	Description
string	touche	Clé du paramètre.
string	valeur	Valeur du paramètre.

ModernClassicSettings

Remarque :

Cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v21.10.

Définit la façon dont un package d'activités préfère gérer les activités Modern et Classic. S’il est défini sur UseGlobalSetting, il différendra le comportement vers le paramètre global de Studio. Le fait de le définir explicitement sur UseModern ou UseClassic entraînera le remplacement du paramètre pour le package en question.

Constantes

Saisie de texte	Nom	Description
string	UseGlobalSetting	Diffère la décision au paramètre Studio global.
string	UseModern	Définit les activités modernes comme activités par défaut.
string	UseClassic	Définit les activités classiques comme activités par défaut.

MultipleValuesSelectorDescription

Paramètre qui permet de sélectionner plusieurs valeurs à partir d'une collection prédéfinie de valeurs.

Héritage

SettingsElement > SettingDescriptionBase > MultipleValuesSelectorDescription

Propriétés

Saisie de texte	Nom	Description
string	Values	Valeurs possibles à sélectionner.
string	Valeurs par défaut	Sélection par défaut.

SettingDescriptionBase

Formatez une valeur à afficher.

Héritage

SettingsElement > SettingDescriptionBase

Propriétés

Saisie de texte	Nom	Description
string	Description	Explication du paramètre.
Bool	EstEnLectureSeule	Si le paramètre est défini sur true, la valeur ne peut être ni modifiée ni conservée.
Bool	IsDesignTime	Renvoie truesi invoqué au moment de la conception. Nécessite Studio 2021.10 ou une version ultérieure.
string	Label	Libellé à utiliser pour ce paramètre.
Bool	RequiresPackageReload	S'il est défini sur true, la modification de ce paramètre nécessite un rechargement du package. Nécessite Studio 2021.10 ou une version ultérieure.

SettingDescriptionBase

Description du paramètre qui s'applique à un certain type.

Héritage

SettingsElement > SettingDescriptionBase > SettingDescriptionBase

Type générique T

Le type de paramètre auquel cette description s'applique.

Propriétés

Saisie de texte	Nom	Description
Func<T, string>	GetDisplayValue	Fonction qui doit renvoyer une valeur d'affichage formatée pour un type donné.

SettingsControlBase

Un élément de paramètres qui fait partie de l'interface utilisateur.

Héritage

SettingsElement > SettingsControlBase

Propriétés

Saisie de texte	Nom	Description
Bool	IsDesignTime	Renvoie true lorsqu'il est invoqué au moment de la conception. Nécessite Studio 2021.10 ou une version ultérieure.
Bool	RequiresPackageReload	S'il est défini sur true, la modification de ce paramètre nécessite un rechargement du package. Cela ne s'applique qu'aux paramètres de phase de conception. Nécessite Studio 2021.10 ou une version ultérieure.

SettingsEditorControlBase

Éditeur de paramètres. Il apparaît sous la forme d'un libellé avec une commande associée. Une instance de ceci peut être transmise à SettingsSection.AddSetting(SettingsEditorControl).

Héritage

SettingsElement > SettingsControlBase > SettingsEditorControlBase

Propriétés

Saisie de texte	Nom	Description
ControlDescriptionBase	Contrôle	Commande à utiliser pour ce paramètre.
string	Description	(Facultatif) Un texte explicatif plus long pour ce paramètre, affiché sous forme d'info-bulle.
string	Label	(Facultatif) Le libellé de l'éditeur de paramètres. Il peut s'agir d'un texte Markdown.

SettingsEditorControlContainer

Un élément d'IU de paramètres qui peut héberger des éditeurs.

Héritage

SettingsElement > SettingsControlBase > SettingsEditorControlContainer

SettingsElement

Classe de base pour les éléments de paramètres avec les clés associées.

Propriétés

Saisie de texte	Nom	Description
string	Clé (Key)	La clé unique associée à ce paramètre. Utilisé pour le stockage/la récupération.

SettingsCategory

Une catégorie de paramètres.

Héritage

SettingsControlBase > SettingsEditorControlContainer > SettingsCategory

Propriétés

Saisie de texte	Nom	Description
string	Description	(Facultatif) Affiché sous le titre, explique la fonction de cette page.
string	En-tête	L'en-tête de catégorie.
Bool	IsHidden	Si le paramètre est défini sur true, la catégorie ne s'affichera pas dans la boîte de dialogue Paramètres du projet (Project Settings). Nécessite Studio 2020.4 ou une version ultérieure.

Remarques

Ajoute une catégorie dans les paramètres du projet d'activités.

SettingsSection

Une zone de groupe de paramètres contenant des commandes associées.

Héritage

SettingsElement > SettingsControlBase > SettingsEditorControlContainer > SettingsSection

Propriétés

Saisie de texte	Nom	Description
string	Description	(Facultatif) Affiché sous le titre, une explication sur l'objectif de cette section.
Bool	IsExpanded	Si elle est définie sur true, la section est développée par défaut.
string	Titre	Le titre de la section.

Remarques

Ajoute une zone de groupe de paramètres aux paramètres du projet d'activités.

SingleValueEditorDescription

Une entrée de paramètre qui permet de modifier une seule valeur de type T. Un éditeur par défaut est créé sur la base de T.

Héritage

SettingsElement > SettingDescriptionBase > SettingDescriptionBase > SingleValueEditorDescription

Type générique T

Le type de paramètre auquel cette description s'applique.

Propriétés

Saisie de texte	Nom	Description
T	ValeurParDéfaut	La valeur par défaut de ce paramètre.
Func<T, string>	Valider	Valider une valeur (s'applique aux éditeurs qui autorisent la saisie de texte Free ).

SingleValueSelectorDescription

Paramètre qui permet de sélectionner une valeur unique dans une collection prédéfinie de valeurs.

Héritage

SettingsElement > SettingDescriptionBase > SettingDescriptionBase > SingleValueEditorDescription > SingleValueSelectorDescription

Propriétés

Saisie de texte	Nom	Description
string[]	Valeur (Value)	Valeurs possibles à sélectionner.