UiPath.Studio.Activities.Api.Settings

In diesem Abschnitt finden Sie weitere Informationen zum Erstellen von Aktivitäten mit UiPath.Studio.Activities.Api.Settings.

IActivitiesSettingsService

Einstiegspunkt für einstellungsbezogene Funktionen.

Vererbung

IActivitiesSettingsReader > IActivitiesSettingsService

Methoden

void AddCategory(SettingsCategory category)

Fügen Sie eine Einstellungskategorie in der Benutzeroberfläche der Projekteinstellungen hinzu.

Parametertyp	Parametername	Beschreibung
SettingsCategory	Kategorie	Die Beschreibung der Einstellungsseite.

void AddSection(SettingsCategory category, SettingsSection section)

Fügen Sie dieser Kategorie einen Abschnitt hinzu.

Parametertyp	Parametername	Beschreibung
SettingsCategory	Kategorie
SettingsSection	Abschnitt	Wenn der Abschnittsschlüssel nicht mit dem Kategorieschlüssel beginnt, wird der letztere als Präfix des ersteren hinzugefügt und der Wert von SettingsElement.Key wird aktualisiert.

void AddSetting(SettingsEditorControlContainer parent, SettingDescriptionBase setting)

Generiert einen standardmäßigen Einstellungs-Editor basierend auf der Einstellung und übergibt ihn an AddSetting(SettingsEditorControlContainer).

Parametertyp	Parametername	Beschreibung
SettingsEditorControlContainer	Übergeordnetes Element	Die SettingsCategory oder SettingsSection, in die das generierte Einstellungssteuerelement angefügt wird.
SettingDescriptionBase	Einstellung	Die Beschreibung der Einstellung, die zum Generieren eines Steuerelements verwendet wird.

void AddSetting(SettingsEditorControlContainer parent, SettingsEditorControl setting)

Einstellungssteuerelement hinzufügen

Parametertyp	Parametername	Beschreibung
SettingsEditorControlContainer	Übergeordnetes Element	Die SettingsCategory oder SettingsSection, in die das generierte Einstellungssteuerelement angefügt wird.
SettingsEditorControl	Einstellung	Die Beschreibung der Einstellung, die zum Generieren eines Steuerelements verwendet wird.

bool TrySetValue (string key, string value)

Legt einen Einstellungswert fest und speichert ihn.

Parametertyp	Parametername	Beschreibung
string	Schlüssel	Der Schlüssel der Einstellung.
string	Wert	Der Wert der Einstellung.

ModernClassicSettings

Hinweis:

Diese Funktion wurde in UiPath.Studio.Activities.Api v21.10 eingeführt.

Definiert, wie ein Aktivitätspaket moderne Aktivitäten im Vergleich zu klassischen Aktivitäten behandeln möchte. Wenn UseGlobalSetting festgelegt ist, wird das Verhalten auf die globale Studio-Einstellung übertragen. Wenn Sie ihn explizit auf UseModern oder UseClassic festlegen, wird die Einstellung für das jeweilige Paket überschrieben.

Konstanten

Typ	Name	Beschreibung
string	UseGlobalSetting	Verschiebt die Entscheidung auf die globale Studio-Einstellung.
string	UseModern	Macht die modernen Aktivitäten als Standard.
string	UseClassic	Macht die klassischen Aktivitäten zum Standard.

MultipleValuesSelectorDescription

Eine Einstellung, die die Auswahl mehrerer Werte aus einer vordefinierten Sammlung von Werten ermöglicht.

Vererbung

SettingsElement > SettingDescriptionBase > MultipleValuesSelectorDescription

Eigenschaften

Typ	Name	Beschreibung
string	Values	Mögliche Werte zur Auswahl.
string	Standardwerte	Standardauswahl.

SettingDescriptionBase

Formatieren Sie einen Wert für die Anzeige.

Vererbung

SettingsElement > SettingDescriptionBase

Eigenschaften

Typ	Name	Beschreibung
string	Beschreibung	Eine Erklärung der Einstellung.
Bool	IstSchreibgeschützt	Wenn truefestgelegt ist, kann der Wert weder bearbeitet noch beibehalten werden.
Bool	IsDesignTime	Gibt truezurück, wenn zur Entwurfszeit aufgerufen. Erfordert Studio 2021.10 oder höher.
string	Label	Die für diese Einstellung zu verwendende Bezeichnung.
Bool	RequiresPackageReload	Wenn auf truefestgelegt, erfordert das Ändern dieser Einstellung ein Neuladen des Pakets. Erfordert Studio 2021.10 oder höher.

SettingDescriptionBase

Eine Einstellungsbeschreibung, die für einen bestimmten Typ gilt.

Vererbung

SettingsElement > SettingDescriptionBase > SettingDescriptionBase

Generischer Typ T

Der Typ der Einstellung, für die diese Beschreibung gilt.

Eigenschaften

Typ	Name	Beschreibung
Func<T, string>	GetDisplayValue	Funktion, die einen formatierten Anzeigewert für einen bestimmten Typ zurückgeben muss.

SettingsControlBase

Ein Einstellungselement, das Teil der UI ist.

Vererbung

SettingsElement > SettingsControlBase

Eigenschaften

Typ	Name	Beschreibung
Bool	IsDesignTime	Gibt true zurück, wenn zur Entwurfszeit aufgerufen. Erfordert Studio 2021.10 oder höher.
Bool	RequiresPackageReload	Wenn truefestgelegt ist, erfordert das Ändern dieser Einstellung ein Neuladen des Pakets. Dies gilt nur für Entwurfszeiteinstellungen. Erfordert Studio 2021.10 oder höher.

SettingsEditorControlBase

Einstellungs-Editor. Es wird als Beschriftung mit einem zugeordneten Steuerelement angezeigt. Eine Instanz davon kann an SettingsSection.AddSetting(SettingsEditorControl) übergeben werden.

Vererbung

SettingsElement > SettingsControlBase > SettingsEditorControlBase

Eigenschaften

Typ	Name	Beschreibung
ControlDescriptionBase	Steuerung	Das für diese Einstellung zu verwendende Steuerelement.
string	Beschreibung	(Optional) Ein längerer erläuternder Text für diese Einstellung, der als Tooltip angezeigt wird.
string	Label	(Optional) Die Bezeichnung des Einstellungs-Editors. Dies kann ein Markdown-Text sein.

SettingsEditorControlContainer

Ein UI-Element für Einstellungen, das Editoren hosten kann.

Vererbung

SettingsElement > SettingsControlBase > SettingsEditorControlContainer

SettingsElement

Basisklasse für Einstellungselemente mit zugehörigen Schlüsseln.

Eigenschaften

Typ	Name	Beschreibung
string	Schlüssel	Der eindeutige Schlüssel, der dieser Einstellung zugeordnet ist. Wird zum Speichern/Abrufen verwendet.

SettingsCategory

Eine Einstellungskategorie.

Vererbung

SettingsControlBase > SettingsEditorControlContainer > SettingsCategory

Eigenschaften

Typ	Name	Beschreibung
string	Beschreibung	(Optional) Wird unter dem Titel angezeigt, erklärt den Zweck dieser Seite.
string	Kopfzeile	Der Kategorieheader.
Bool	IsHidden	Wenn truefestgelegt ist, wird die Kategorie nicht im Dialogfeld Projekteinstellungen angezeigt. Erfordert Studio 2020.4 oder höher.

Bemerkungen

Fügt eine Kategorie in den Projekteinstellungen für Aktivitäten hinzu.

SettingsSection

Ein Einstellungsgruppenfeld mit zugehörigen Steuerelementen.

Vererbung

SettingsElement > SettingsControlBase > SettingsEditorControlContainer > SettingsSection

Eigenschaften

Typ	Name	Beschreibung
string	Beschreibung	(Optional) Wird unter dem Titel angezeigt, eine Erklärung des Zwecks dieses Abschnitts.
Bool	IsExpanded	Wenn auf truefestgelegt, wird der Abschnitt standardmäßig erweitert.
string	Titel	Der Abschnittstitel.

Bemerkungen

Fügt den Projekteinstellungen von Aktivitäten ein Einstellungsgruppenfeld hinzu.

SingleValueEditorDescription

Ein Einstellungseintrag, der die Bearbeitung eines einzelnen Werts vom Typ T ermöglicht. Ein Standard-Editor wird basierend auf T erstellt.

Vererbung

SettingsElement > SettingDescriptionBase > SettingDescriptionBase > SingleValueEditorDescription

Generischer Typ T

Der Typ der Einstellung, für die diese Beschreibung gilt.

Eigenschaften

Typ	Name	Beschreibung
T	Standardwert	Der Standardwert dieser Einstellung.
Func<T, string>	Überprüfen	Einen Wert validieren (gilt für Editoren, die Free zulassen).

SingleValueSelectorDescription

Eine Einstellung, die die Auswahl eines einzelnen Werts aus einer vordefinierten Sammlung von Werten ermöglicht.

Vererbung

SettingsElement > SettingDescriptionBase > SettingDescriptionBase > SingleValueEditorDescription > SingleValueSelectorDescription

Eigenschaften

Typ	Name	Beschreibung
string[]	Wert	Mögliche Werte zur Auswahl.