Parameter userParameter

userParameter ist ein hilfreicher Parameter für das Programmieren von Editorerweiterungen.  Er ermöglicht Ihnen, dem Editor für unterschiedliche Geltungsbereiche verschiedene Einstellungen zuzuordnen, ähnlich wie bei den Editorparametern.

Verfügbarkeit

Befehl query
Befehl set

Geltungsbereich

userParameter.view. gilt für die aktuelle Sicht.
userParameter.document. gilt für das Dokument der aktuellen Sicht.
userParameter hat einen globalen Geltungsbereich.

Syntax

query userParameter.[ view. | document. ] Name
set userParameter.[ view. | document. ] Name [ Wert ] 

Parameter

view. Mit dem Qualifikationsmerkmal view. geben Sie an, dass der Benutzerparameter für die aktuelle Sicht Gültigkeit hat.
document. Mit dem Qualifikationsmerkmal document. geben Sie an, dass der Benutzerparameter für das Dokument der aktuellen Sicht Gültigkeit hat.
Name Mit dem Parameter Name können Sie den Namen des Benutzerparameters angeben.
Wert Mit dem Parameter Wert können Sie den Wert des Benutzerparameters angeben.  Für Wert gibt es keine Einschränkungen.  Wird kein Wert für den Befehl set userParameter angegeben, wird die Benutzerparametereinstellung für den angegebenen Geltungsbereich (Sicht, Dokument oder global) entfernt.  der Wert für den übergeordneten Geltungsbereich dieses Benutzerparameters, falls definiert, wird zurückgeschrieben.

Beschreibung

Benutzerparametereinstellungen mit globalem Geltungsbereich werden im Profil mit den Editorstandardwerten gespeichert (siehe Editorparameter defaultProfile).  Benutzerparametereinstellungen, die für das Dokument gültig sind und die globalen Einstellungen für ein bestimmtes Dokument überschreiben, werden im zugeordneten Dokument gespeichert.  Benutzerparametereinstellungen, die für die Sicht gültig sind und die Dokumenteinstellungen für eine bestimmte Dokumentsicht überschreiben, werden in der zugeordneten Sicht gespeichert.

Der Befehl query userParameter gibt die Einstellung des Benutzerparameters für den angegebenen Geltungsbereich, falls verfügbar, zurück; andernfalls wird die Einstellung für den übergeordneten Geltungsbereich zurückgegeben.

Beispiele

query userParameter.MeinParameter
query userParameter.document.MeinParameter
query userParameter.view.MeinParameter
set userParameter.myParameter Global Einstellung
set userParameter.document.MeinParameter Document Wert
set userParameter.view.MeinParameter 42
set userParameter.MeinParameter 

Zugehöriger Verweis
Befehl query
Befehl set
Parameter defaultProfile