Zum Hauptinhalt springen

Plugin-Schnittstelle - Designer-Befehle

Plugin-Schnittstelle - Designer-Befehle Befehle der Plugin-Schnittstelle für den Designer

Über die Plugin-Schnittstelle können Befehle an den Designer gesendet werden. Diese Befehle lösen im verbundenen Designer bestimmte Aktionen aus.

Überblick

  1. Designer.Auth
  2. Designer.GetInfo
  3. Designer.Forms.*
    1. Designer.Forms.Open
    2. Designer.Forms.Export
    3. Designer.Forms.Import
    4. Designer.Forms.GetCount
    5. Designer.Forms.GetObject
    6. Designer.Forms.Selection.Get
    7. Designer.Forms.Selection.New
    8. Designer.Forms.Selection.GetCount
    9. Designer.Forms.Selection.GetObject
    10. Designer.Forms.Selection.GetPreview
    11. Designer.Forms.Selection.Menu.AddItem
    12. Designer.Forms.Selection.Menu.<Name>.Change
    13. Designer.Forms.Selection.Menu.<Name>.Remove
  4. Designer.MenuEditor.Open
  5. Designer.Editor.*
    1. Designer.Editor.Open
    2. Designer.Editor.Compile
    3. Designer.Editor.Document.Menu.AddItem
    4. Designer.Editor.Document.Menu.<Name>.Change
    5. Designer.Editor.Document.Menu.<Name>.Remove
  6. Designer.Menu.*
    1. Designer.Menu.File.New.Frame.Exec
    2. Designer.Menu.File.New.AppFrame.Exec
    3. Designer.Menu.File.New.MdiFrame.Exec
    4. Designer.Menu.File.New.TrayFrame.Exec
    5. Designer.Menu.File.New.PrintDoc.Exec
    6. Designer.Menu.File.New.PrintDocRecord.Exec
    7. Designer.Menu.File.New.PrintForm.Exec
    8. Designer.Menu.File.New.PrintFormList.Exec
    9. Designer.Menu.File.New.Menu.Exec
    10. Designer.Menu.File.Open.Exec
    11. Designer.Menu.File.Reopen.Exec
    12. Designer.Menu.File.Save.Exec
    13. Designer.Menu.File.SaveAs.Exec
    14. Designer.Menu.File.ReadWrite.Exec
    15. Designer.Menu.File.Close.Exec
    16. Designer.Menu.File.CloseAll.Exec
    17. Designer.Menu.File.Import.Exec
    18. Designer.Menu.File.Export.Exec
    19. Designer.Menu.File.Menu.Exec
    20. Designer.Menu.File.Test.Exec
    21. Designer.Menu.File.MainProc.Exec
    22. Designer.Menu.File.Config.Exec
    23. Designer.Menu.File.Exit.Exec
    24. Designer.Menu.Extras.Dictionary.Exec
    25. Designer.Menu.Extras.RecordManagement.Exec
    26. Designer.Menu.Extras.BlobManagement.Exec
    27. Designer.Menu.Extras.UserManagement.Exec
    28. Designer.Menu.Extras.Resource.Exec
    29. Designer.Menu.Extras.ViewAppLog.Exec
    30. Designer.Menu.Plugins.AddItem
    31. Designer.Menu.Plugins.<Name>.Change
    32. Designer.Menu.Plugins.<Name>.Remove
  7. Designer.Storage.*
    1. Designer.Storage.Create
    2. Designer.Storage.Load
    3. Designer.Storage.NewObject
    4. Designer.Storage.<StorageName>.Save
    5. Designer.Storage.<StorageName>.Unload
    6. Designer.Storage.<ObjectName>.DeleteObject
    7. Designer.Storage.<ObjectName>.RenameObject
    8. Designer.Storage.<ObjectName>.WriteKey
    9. Designer.Storage.<ObjectName>.ReadKey
    10. Designer.Storage.<ObjectName>.ReadNames
    11. Designer.Storage.LastLockingInfo
    12. Designer.Storage.<ObjectName>.ExportFile
    13. Designer.Storage.<ObjectName>.ExportStream
    14. Designer.Storage.ImportFile
    15. Designer.Storage.ImportStream
  8. Designer.Plugins.Shutdown
  9. Designer.LastXmlError

Designer-Befehle

Es ist möglich auf die Antwort eines gesendeten Befehls zu warten (synchrone Ausführung). Dies ist die Voraussetzung, damit angeforderte Daten auch vom Designer an das Plugin zurückgesendet werden können. Für die Abfrage des Resultates der Ausführung kann das Argument ExecResult übergeben werden.

Nachdem die Antwort empfangen wurde, enthält ExecResult einen numerischen Wert, der entweder 0 ist (Ausführung erfolgreich) oder negativ (in Abhängigkeit vom Befehl). Existiert der Befehl nicht, wird _ErrUnavailable zurückgegeben.

Folgende Befehle können gesendet werden:

Designer.Auth​

Dieser Befehl wird vom Designer gesendet um die Plugin-Anwendung aufzufordern, sich zu authentifizieren, nachdem diese sich mit dem Designer verbunden hat.

<serial> | CMD Designer.Auth (Area=<Datenbankname>, User=<Benutzername>) PluginName=?, Password=?
  • Serial: = Fortlaufende Nachrichtenkennung. Diese muss bei der Antwort angegeben werden, um sie zuzuordnen.
  • Area: = Name der Datenbank, die im Designer geöffnet ist.
  • User: = Name des Benutzers, der im Designer angemeldet ist.
  • PluginName: = Deskriptiver Name für das Plugin. Muss von der Plugin-Anwendung zurückgeliefert werden. Der Name darf nicht leer sein, sonst schlägt die Authentifikation fehl.
  • Password: = Plugin-Kennwort. Dieses muss beim Benutzer <Benutzername> in der Benutzerverwaltung hinterlegt werden.

Auf dieses Kommando muss vom Plugin-Client innerhalb von 5 Sekunden wie folgt geantwortet werden:

<serial> | RET [PluginName="<Plugin-Name>", Password="<Plugin-Kennwort>"]

Unabhängig davon, ob die Authentifizierung fehlschlagt oder nicht, sendet der Designer den Befehl

CMD Designer.Auth (Area=<Datenbankname>, User=<Benutzername>, AccessGranted=<true|false>) [ExecResult=?]

Das Argument AccessGranted gibt Aufschluss darüber, ob die Anmeldung erfolgreich war oder nicht. Im letzteren Fall wird die Verbindung vom Designer terminiert.

info

Dieser Befehl wird vom Designer an das Plugin versendet.

Designer.GetInfo​

Dieser Befehl liefert Informationen zum Designer. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.GetInfo () [Version=?, VersionNum=?, ExecResult=?]
  • Version: = Designer-Version z. B. "5.8.01a"
  • VersionNum: = Version als numerischer Wert um Versionsvergleiche einfach durchführen zu können (z. B. 0x05080101 = 05.08.01a).

Designer.Forms.*​

Designer.Forms.Open​

Dieser Befehl öffnet eine Designform im Designer. Wenn sie bereits offen ist, wird sie aktiviert.

CMD Designer.Forms.Open (Name="<Designform-Name>", ReadOnly=<true|false>, Type=<Designform-Type>) [ExecResult=?]

Designer.Forms.Export​

Dieser Befehl liefert ein im Designer geöffnetes Formular als Datenstrom in einem vorgegebenen Format. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Export (FormName="<Form-Name>", Type=<Form-Typ>, FileName="<File-Name>", FileFormat="<Format>") [ExecResult=?]
  • FormName: = Name des im Designer geöffneten Formulars. Fehlt das Argument oder ist es leer, wird das aktive Formular referenziert.
  • Type: = Typ der Designform ( 0 = Frame , 1 = PrintForm , 2 = PrintFormList , 3 = PrintDoc , 4 = PrintDocRecord ) (optional; default = 0 ).
  • FileName: = Pfad und Name der Datei, die erstellt werden soll.
  • FileFormat: = Format der Datei ( vs-resource (default) = vectorsoft resource format, xml = XML-Format).

Designer.Forms.Import​

Dieser Befehl importiert eine Ressource im vectorsoft resource format und öffnet das Formular im Designer. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Import (FileName="<File-Name>") [ExecResult=?]
  • FileName: = Pfad und Name der Datei, die importiert und geöffnet werden soll.

Designer.Forms.GetCount​

Dieser Befehl ermittelt die Anzahl der im Designer geöffneten Design-Forms. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.GetCount () [Count=?, ExecResult=?]
  • Count: = Anzahl der geöffneten Design-Forms.

Designer.Forms.GetObject​

Dieser Befehl ermittelt Informationen über eine im Designer geöffnete Design-Form. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.GetObject (FormName="<Form-Name>", Type=<Form-Typ>) [Name=?, Class=?, Caption=?, State=?, ExecResult=?]
  • FormName: = Name des im Designer geöffneten Formulars. Fehlt das Argument oder ist es leer, wird das aktive Formular referenziert.
  • Type: = Typ der Designform ( 0 = Frame , 1 = PrintForm , 2 = PrintFormList , 3 = PrintDoc , 4 = PrintDocRecord ) (optional; default = 0 ).
  • Name: = Names der Design-Form.
  • Class: = Objekttyp (Wert einer _WinType -Konstanten).
  • Caption: = Wert der Eigenschaft Caption der Design-Form als Base64-kodierte Zeichenkette.
  • State: = Status der Design-Form ( new = neu angelegt und noch nicht gespeichert, read-only = nur-lesend geöffnet, modified = gespeichert und geändert, saved = gespeichert und nicht geändert).

Designer.Forms.Selection.Get​

Dieser Befehl ermittelt das bzw. die im Designer selektierten Objekte als Base64 kodierten Datenstrom. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Selection.Get (FormName="<Form-Name>", Type=<Form-Typ>) [Content=?, ExecResult=?]
  • FormName: = Name des im Designer geöffneten Formulars. Fehlt das Argument oder ist es leer, wird das aktive Formular referenziert.
  • Type: = Typ der Designform ( 0 = Frame , 1 = PrintForm , 2 = PrintFormList , 3 = PrintDoc , 4 = PrintDocRecord ) (optional; default = 0 ).
  • Content: = Base64 kodierter Datenstrom der selektierten Objekte.

Designer.Forms.Selection.New​

Dieser Befehl erstellt die, in einem zuvor mit Designer.Foms.Selection.Get ermittelten, Objekte im Designer und selektiert diese. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Selection.New (FormName="<Form-Name>", Type=<Form-Typ>, Content="<Base64 kodierter Datenstrom>") [ExecResult=?]
  • FormName: = Name des im Designer geöffneten Formulars. Fehlt das Argument oder ist es leer, wird das aktive Formular referenziert.
  • Type: = Typ der Designform ( 0 = Frame , 1 = PrintForm , 2 = PrintFormList , 3 = PrintDoc , 4 = PrintDocRecord ) (optional; default = 0 ).
  • Content: = Base64 kodierter Datenstrom der selektierten Objekte.

Designer.Forms.Selection.GetCount​

Dieser Befehl ermittelt die Anzahl der selektierten Objekte im Designer. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Selection.GetCount (FormName="<Form-Name>", Type=<Form-Typ>) [Count=?, ExecResult=?]
  • FormName: = Name des im Designer geöffneten Formulars. Fehlt das Argument oder ist es leer, wird das aktive Formular referenziert.
  • Type: = Typ der Designform ( 0 = Frame , 1 = PrintForm , 2 = PrintFormList , 3 = PrintDoc , 4 = PrintDocRecord ) (optional; default = 0 ).
  • Count: = Anzahl der selektierten Objekte.

Designer.Forms.Selection.GetObject​

Dieser Befehl ermittelt Informationen über ein im Designer selektiertes Objekt. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Selection.GetObject (FormName="<Form-Name>", Type=<Form-Typ>, Index=<Nummer des Objektes>) [Name=?, Class=?, Caption=?, ExecResult=?]
  • FormName: = Name des im Designer geöffneten Formulars. Fehlt das Argument oder ist es leer, wird das aktive Formular referenziert.
  • Type: = Typ der Designform ( 0 = Frame , 1 = PrintForm , 2 = PrintFormList , 3 = PrintDoc , 4 = PrintDocRecord ) (optional; default = 0 ).
  • Index: = Eins-basierter Index des gewünschten Objektes in der Selektion.
  • Name: = Names des Objektes.
  • Class: = Objekttyp (Wert einer _WinType -Konstante).
  • Caption: = Wert der Eigenschaft Caption des Objektes als Base64-kodierte Zeichenkette.

Designer.Forms.Selection.GetPreview​

Dieser Befehl erstellt ein Vorschaubild des bzw. der selektierten Objekte und liefert die Daten im PNG-Format als Base64 kodierten Datenstrom. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

Das erstellte PNG hat eine maximale Größe von 256x256 Pixeln.

CMD Designer.Forms.Selection.GetPreview (FormName="<Form-Name>", Type=<Form-Typ>, Index=<Nummer des Objektes>, Width=<Breite>, Height=<Höhe>) [Content=?, ExecResult=?]
  • FormName: = Name des im Designer geöffneten Formulars. Fehlt das Argument oder ist es leer, wird das aktive Formular referenziert.
  • Type: = Typ der Designform ( 0 = Frame , 1 = PrintForm , 2 = PrintFormList , 3 = PrintDoc , 4 = PrintDocRecord ) (optional; default = 0 ).
  • Content: = Daten im PNG-Format als Base64 kodierter Datenstrom.
  • Width: = Breite des Bildes in Pixel. (Ab Version 5.8.04; optional; default = 0 )
  • Height: = Höhe des Bildes in Pixel. (Ab Version 5.8.04; optional; default = 0 )

Ist Width oder Height auf -1 gesetzt, wird ein Vorschaubild erzeugt, welches die Größe des bzw. der selektierten Objekte besitzt. Ist andernfalls eines der beiden Argumente 0 oder nicht gesetzt, wird ein Vorschaubild mit 256 x 256 Pixel erzeugt.

Designer.Forms.Selection.Menu.AddItem​

Dieser Befehl generiert einen Menüpunkt im Kontextmenü des selektierten bzw. der selektierten Objekte im Designer. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Selection.Menu.AddItem (Name="<Name>", Separator=<true|false>, Caption="<Anzeige-Text>", Icon="<Icon-Name>", ImageTile=<Icon-Nummer>, Checked=<true|false>, Disabled=<true|false>) [ExecResult=?]
  • Name: = Name für den Menüpunkt. Dieser Name wird in Befehlen und Ereignissen verwendet, die den Menüpunkt betreffen.
  • Separator: = Bei Angabe von true wird ein Separator erstellt. Bei false finden die weiteren Argumente Anwendung.
  • Caption: = Anzeigetext für den Menüpunkt.
  • Icon: = Name eines benutzerdefinierten Icons, dass vor dem Text angezeigt wird. Es kann sich um ein externes oder ein internes Icon handeln (siehe Icon ).
  • ImageTile: = Nummer eines vordefinierten CONZEPT 16 Symbols.
  • Checked: = Bei Angabe von true wird der Menüpunkt mit einem Häkchen versehen.
  • Disabled: = Bei Angabe von true wird der Menüpunkt inaktiv und ist nicht mehr anwählbar.
info

Menüpunkte werden in alphabetischer Reihenfolge des Namens im Menü hinzugefügt. Soll eine bestimmte Sortierung erreicht werden, kann mit einem Präfix gearbeitet werden.

Beispiel:

CMD Designer.Forms.Selection.Menu.AddItem (Name="Name3",Caption="Menüpunkt 1") []
CMD Designer.Forms.Selection.Menu.AddItem (Name="Name2",Caption="Menüpunkt 2") []
CMD Designer.Forms.Selection.Menu.AddItem (Name="Name1",Caption="Menüpunkt 3") []

Die sichtbare Reihenfolge der Menüpunkte im Menü ist:

  • Menüpunkt 3
  • Menüpunkt 2
  • Menüpunkt 1
CMD Designer.Forms.Selection.Menu.AddItem (Name="01Name",Caption="Menüpunkt 1") []
CMD Designer.Forms.Selection.Menu.AddItem (Name="02Name",Caption="Menüpunkt 2") []
CMD Designer.Forms.Selection.Menu.AddItem (Name="03Name",Caption="Menüpunkt 3") []

Die sichtbare Reihenfolge der Menüpunkte im Menü ist:

  • Menüpunkt 1
  • Menüpunkt 2
  • Menüpunkt 3

Designer.Forms.Selection.Menu.<Name>.Change​

Mit diesem Befehl kann ein zuvor unter dem Namen <Name> angelegter Menüpunkt geändert werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Selection.Menu.<Name>.Change (Separator=<true|false>, Caption="<Anzeige-Text>", Icon="<Icon-Name>", ImageTile=<Icon-Nummer>, Checked=<true|false>, Disabled=<true|false>) [ExecResult=?]
  • Name: = Name des zu ändernden Menüpunktes.
  • Separator: = Bei Angabe von true wird ein Separator erstellt. Bei false finden die weiteren Argumente Anwendung.
  • Caption: = Anzeigetext für den Menüpunkt.
  • Icon: = Name eines benutzerdefinierten Icons, dass vor dem Text angezeigt wird. Es kann sich um ein externes oder ein internes Icon handeln (siehe Icon ).
  • ImageTile: = Nummer eines vordefinierten CONZEPT 16 Symbols.
  • Checked: = Bei Angabe von true wird der Menüpunkt mit einem Häkchen versehen.
  • Disabled: = Bei Angabe von true wird der Menüpunkt inaktiv und ist nicht mehr anwählbar.

Designer.Forms.Selection.Menu.<Name>.Remove​

Mit diesem Befehl kann ein zuvor unter dem Namen <Name> angelegter Menüpunkt wieder entfernt werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Forms.Selection.Menu.<Name>.Remove () [ExecResult=?]
  • Name: = Name des zu löschenden Menüpunktes.

Designer.MenuEditor.Open​

Dieser Befehl öffnet ein Menü im Menü-Editor.

CMD Designer.MenuEditor.Open (Name="<Menü-Name>", ReadOnly=<true|false>) [ExecResult=?]
  • Name: = Name des zu öffnenden Menüs.
  • ReadOnly: = true , wenn das Menü im ReadOnly-Modus geöffnet werden soll, sonst false (optional; default = false ).

Designer.Editor.*​

Designer.Editor.Open​

Dieser Befehl öffnet ein Dokument im Editor.

CMD Designer.Editor.Open (Name="<Dokument-Name>", ReadOnly=<true|false>, Type=<Dokument-Type>) [ExecResult=?]
  • Name: = Name des zu öffnenden Dokumentes.
  • ReadOnly: = true , wenn das Dokument im ReadOnly-Modus geöffnet werden soll, sonst false (optional; default = false ).
  • Type: = Typ des Dokumentes ( 0 = Prozedur, 1 = Text) (optional; default = 0 ).

Designer.Editor.Compile​

Dieser Befehl übersetzt eine Prozedur im Editor.

CMD Designer.Editor.Compile (Name="<Dokument-Name>") [ExecResult=?]
  • Name: = Name des zu übersetzenden Dokumentes.

Designer.Editor.Document.Menu.AddItem​

Dieser Befehl generiert einen Menüpunkt im Kontextmenü des aktiven Dokumentes im Editor. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD  Designer.Editor.Document.Menu.AddItem (Name="<Name>", Separator=<true|false>, Caption="<Anzeige-Text>", Icon="<Icon-Name>", ImageTile=<Icon-Nummer>, Checked=<true|false>, Disabled=<true|false>) [ExecResult=?]
  • Name: = Name für den Menüpunkt. Dieser Name wird in Befehlen und Ereignissen verwendet, die den Menüpunkt betreffen.
  • Separator: = Bei Angabe von true wird ein Separator erstellt. Bei false finden die weiteren Argumente Anwendung.
  • Caption: = Anzeigetext für den Menüpunkt.
  • Icon: = Name eines benutzerdefinierten Icons, dass vor dem Text angezeigt wird. Es kann sich um ein externes oder ein internes Icon handeln (siehe Icon ).
  • ImageTile: = Nummer eines vordefinierten CONZEPT 16 Symbols.
  • Checked: = Bei Angabe von true wird der Menüpunkt mit einem Häkchen versehen.
  • Disabled: = Bei Angabe von true wird der Menüpunkt inaktiv und ist nicht mehr anwählbar.
info

Menüpunkte werden in alphabetischer Reihenfolge des Namens im Menü hinzugefügt. Soll eine bestimmte Sortierung erreicht werden, kann mit einem Präfix gearbeitet werden. (Beispiel siehe Designer.Forms.Selection.Menu.AddItem )

Designer.Editor.Document.Menu.<Name>.Change​

Mit diesem Befehl kann ein zuvor unter dem Namen <Name> angelegter Menüpunkt geändert werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Editor.Document.Menu.<Name>.Change (Separator=<true|false>, Caption="<Anzeige-Text>", Icon="<Icon-Name>", ImageTile=<Icon-Nummer>, Checked=<true|false>, Disabled=<true|false>) [ExecResult=?]
  • Name: = Name des zu ändernden Menüpunktes.
  • Separator: = Bei Angabe von true wird ein Separator erstellt. Bei false finden die weiteren Argumente Anwendung.
  • Caption: = Anzeigetext für den Menüpunkt.
  • Icon: = Name eines benutzerdefinierten Icons, dass vor dem Text angezeigt wird. Es kann sich um ein externes oder ein internes Icon handeln (siehe Icon ).
  • ImageTile: = Nummer eines vordefinierten CONZEPT 16 Symbols.
  • Checked: = Bei Angabe von true wird der Menüpunkt mit einem Häkchen versehen.
  • Disabled: = Bei Angabe von true wird der Menüpunkt inaktiv und ist nicht mehr anwählbar.

Designer.Editor.Document.Menu.<Name>.Remove​

Mit diesem Befehl kann ein zuvor unter dem Namen <Name> angelegter Menüpunkt wieder entfernt werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Editor.Document.Menu.<Name>.Remove () [ExecResult=?]
  • Name: = Name des zu löschenden Menüpunktes.

Designer.Menu.*​

Designer.Menu.File.New.Frame.Exec​

Führt den Menübefehl 'Datei / Neu / Frame' aus.

CMD Designer.Menu.File.New.Frame.Exec () [ExecResult=?]

Designer.Menu.File.New.AppFrame.Exec​

Führt den Menübefehl 'Datei / Neu / AppFrame' aus.

CMD Designer.Menu.File.New.AppFrame.Exec () [ExecResult=?]

Designer.Menu.File.New.MdiFrame.Exec​

Führt den Menübefehl 'Datei / Neu / MdiFrame' aus.

CMD Designer.Menu.File.New.MdiFrame.Exec () [ExecResult=?]

Designer.Menu.File.New.TrayFrame.Exec​

Führt den Menübefehl 'Datei / Neu / TrayFrame' aus.

CMD Designer.Menu.File.New.TrayFrame.Exec () [ExecResult=?]

Designer.Menu.File.New.PrintDoc.Exec​

Führt den Menübefehl 'Datei / Neu / PrintDoc' aus.

CMD Designer.Menu.File.New.PrintDoc.Exec () [ExecResult=?]

Designer.Menu.File.New.PrintDocRecord.Exec​

Führt den Menübefehl 'Datei / Neu / PrintDocRecord' aus.

CMD Designer.Menu.File.New.PrintDocRecord.Exec () [ExecResult=?]

Designer.Menu.File.New.PrintForm.Exec​

Führt den Menübefehl 'Datei / Neu / PrintForm' aus.

CMD Designer.Menu.File.New.PrintForm.Exec () [ExecResult=?]

Designer.Menu.File.New.PrintFormList.Exec​

Führt den Menübefehl 'Datei / Neu / PrintFormList' aus.

CMD Designer.Menu.File.New.PrintFormList.Exec () [ExecResult=?]

Designer.Menu.File.New.Menu.Exec​

Führt den Menübefehl 'Datei / Neu / Menü...' aus.

CMD Designer.Menu.File.New.Menu.Exec () [ExecResult=?]

Designer.Menu.File.Open.Exec​

Führt den Menübefehl 'Datei / Öffnen' aus.

CMD Designer.Menu.File.Open.Exec () [ExecResult=?]

Designer.Menu.File.Reopen.Exec​

Führt den Menübefehl 'Datei / Wiederherstellen' aus.

CMD Designer.Menu.File.Reopen.Exec () [ExecResult=?]

Designer.Menu.File.Save.Exec​

Führt den Menübefehl 'Datei / Speichern' aus.

CMD Designer.Menu.File.Save.Exec () [ExecResult=?]

Designer.Menu.File.SaveAs.Exec​

Führt den Menübefehl 'Datei / Speichern unter' aus.

CMD Designer.Menu.File.SaveAs.Exec () [ExecResult=?]

Designer.Menu.File.ReadWrite.Exec​

Führt den Menübefehl 'Datei / Bearbeitungsmodus' aus.

CMD Designer.Menu.File.ReadWrite.Exec () [ExecResult=?]

Designer.Menu.File.Close.Exec​

Führt den Menübefehl 'Datei / Schließen' aus.

CMD Designer.Menu.File.Close.Exec () [ExecResult=?]

Designer.Menu.File.CloseAll.Exec​

Führt den Menübefehl 'Datei / Alle schließen' aus.

CMD Designer.Menu.File.CloseAll.Exec () [ExecResult=?]

Designer.Menu.File.Import.Exec​

Führt den Menübefehl 'Datei / Importieren...' aus.

CMD Designer.Menu.File.Import.Exec () [ExecResult=?]

Designer.Menu.File.Export.Exec​

Führt den Menübefehl 'Datei / Exportieren...' aus.

CMD Designer.Menu.File.Export.Exec () [ExecResult=?]

Designer.Menu.File.Menu.Exec​

Führt den Menübefehl 'Datei / Menü editieren...' aus.

CMD Designer.Menu.File.Menu.Exec () [ExecResult=?]

Designer.Menu.File.Test.Exec​

Führt den Menübefehl 'Datei / Test' aus.

CMD Designer.Menu.File.Test.Exec () [ExecResult=?]

Designer.Menu.File.MainProc.Exec​

Führt den Menübefehl 'Datei / Start-Prozedur ausführen' aus.

CMD Designer.Menu.File.MainProc.Exec () [ExecResult=?]

Designer.Menu.File.Config.Exec​

Führt den Menübefehl 'Datei / Einstellungen...' aus.

CMD Designer.Menu.File.Config.Exec () [ExecResult=?]

Designer.Menu.File.Exit.Exec​

Führt den Menübefehl 'Datei / Beenden' aus.

CMD Designer.Menu.File.Exit.Exec () [ExecResult=?]

Designer.Menu.Extras.Dictionary.Exec​

Führt den Menübefehl 'Extras / Datenstruktureditor...' aus.

CMD Designer.Menu.Extras.Dictionary.Exec () [ExecResult=?]

Designer.Menu.Extras.RecordManagement.Exec​

Führt den Menübefehl 'Extras / Datensatzverwaltung...' aus.

CMD Designer.Menu.Extras.RecordManagement.Exec () [ExecResult=?]

Designer.Menu.Extras.BlobManagement.Exec​

Führt den Menübefehl 'Extras / BLOb-Verwaltung...' aus.

CMD Designer.Menu.Extras.BlobManagement.Exec () [ExecResult=?]

Designer.Menu.Extras.UserManagement.Exec​

Führt den Menübefehl 'Extras / Benutzerverwaltung...' aus.

CMD Designer.Menu.Extras.UserManagement.Exec () [ExecResult=?]

Designer.Menu.Extras.Resource.Exec​

Führt den Menübefehl 'Extras / Ressourcenverwaltung...' aus.

CMD Designer.Menu.Extras.Resource.Exec () [ExecResult=?]

Designer.Menu.Extras.ViewAppLog.Exec​

Führt den Menübefehl 'Extras / Anwendungsprotokoll öffnen' aus.

CMD Designer.Menu.Extras.ViewAppLog.Exec () [ExecResult=?]

Designer.Menu.Plugins.AddItem​

Dieser Befehl generiert einen Menüpunkt im Plugin-Menü im Hauptmenü des Designers. Der Menüpunkt wird im Menü "Plugins" des Designers erstellt. Jedes Plugin erhält dort automatisch ein eigenes Untermenü mit dem Anzeigename der Plugin-Anwendung, der bei der Authentifizierung übergeben wird. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Menu.Plugins.AddItem (Name="<Name>", Separator=<true|false>, Caption="<Anzeige-Text>", Icon="<Icon-Name>", ImageTile=<Icon-Nummer>, Checked=<true|false>, Disabled=<true|false>) [ExecResult=?]
  • Name: = Name für den Menüpunkt. Dieser Name wird in Befehlen und Ereignissen verwendet, die den Menüpunkt betreffen.
  • Separator: = Bei Angabe von true wird ein Separator erstellt. Bei false finden die weiteren Argumente Anwendung.
  • Caption: = Anzeigetext für den Menüpunkt.
  • Icon: = Name eines benutzerdefinierten Icons, dass vor dem Text angezeigt wird. Es kann sich um ein externes oder ein internes Icon handeln (siehe Icon ).
  • ImageTile: = Nummer eines vordefinierten CONZEPT 16 Symbols.
  • Checked: = Bei Angabe von true wird der Menüpunkt mit einem Häkchen versehen.
  • Disabled: = Bei Angabe von true wird der Menüpunkt inaktiv und ist nicht mehr anwählbar.
info

Menüpunkte werden in alphabetischer Reihenfolge des Namens im Menü hinzugefügt. Soll eine bestimmte Sortierung erreicht werden, kann mit einem Präfix gearbeitet werden. (Beispiel siehe Designer.Forms.Selection.Menu.AddItem )

Designer.Menu.Plugins.<Name>.Change​

Mit diesem Befehl kann ein zuvor unter dem Namen <Name> angelegter Menüpunkt geändert werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Menu.Plugins.<Name>.Change (Separator=<true|false>, Caption="<Anzeige-Text>", Icon="<Icon-Name>", ImageTile=<Icon-Nummer>, Checked=<true|false>, Disabled=<true|false>) [ExecResult=?]
  • Name: = Name des zu ändernden Menüpunktes.
  • Separator: = Bei Angabe von true wird ein Separator erstellt. Bei false finden die weiteren Argumente Anwendung.
  • Caption: = Anzeigetext für den Menüpunkt.
  • Icon: = Name eines benutzerdefinierten Icons, dass vor dem Text angezeigt wird. Es kann sich um ein externes oder ein internes Icon handeln (siehe Icon ).
  • ImageTile: = Nummer eines vordefinierten CONZEPT 16 Symbols.
  • Checked: = Bei Angabe von true wird der Menüpunkt mit einem Häkchen versehen.
  • Disabled: = Bei Angabe von true wird der Menüpunkt inaktiv und ist nicht mehr anwählbar.

Designer.Menu.Plugins.<Name>.Remove​

Mit diesem Befehl kann ein zuvor unter dem Namen <Name> angelegter Menüpunkt wieder entfernt werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Menu.Plugins.<Name>.Remove () [ExecResult=?]
  • Name: = Name des zu löschenden Menüpunktes.

Designer.Storage.*​

Die Storage-Befehle ermöglichen es einer Plugin-Anwendung Daten in einer Verzeichnisstruktur zu speichern und zu laden. Die Daten werden in einem speziell dafür vorgesehenen Bereich in der Datenbank auf Designer-Seite abgelegt.

Die oberste Ebene der Verzeichnisstruktur wird durch den Pfad Designer.Storage abgebildet. Plugin-Anwendungen können unter diesem Knoten einen Storage-Bereich anlegen, der anschließend über seinen Name referenzierbar ist.

Designer.Storage.Create​

Dieser Befehl erstellt einen Storage-Bereich im Designer und sperrt diesen für die weitere Verwendung. Die Erstellung schlägt fehl, wenn der Bereich bereits von einem Plugin gesperrt wurde. Der Bereich sollte von der Plugin-Anwendung mit dem Befehl Cmd.Designer.Storage.Unload entladen und entsperrt werden, wenn der Bereich nicht mehr benötigt wird oder die Plugin-Anwendung beendet wird. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Storage.Create (Name="<Storage-Name>", Overwrite=<true|false>) [ExecResult=?]
  • Name: = Name des Storage-Bereiches. Erlaubt sind alle Zeichen beginnend mit Space (ASCII-Wert 32) außer "*", "?", "", ".".
  • Overwrite: = Ist diese Argument true , wird der Bereich überschrieben sofern vorhanden. Default-Wert ist false .

Designer.Storage.Load​

Dieser Befehl lädt einen Storage-Bereich exklusiv oder lesend. Zum Entladen und Entsperren des Bereiches kann der Befehl Cmd.Designer.Storage.Unload verwendet werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Storage.Load (Name="<Storage-Name>", Create=<true|false>, ReadOnly=<true|false>) [ExecResult=?]
  • Name: = Name des Storage-Bereiches. Erlaubt sind alle Zeichen beginnend mit Space (ASCII-Wert 32) außer "*", "?", "", ".".
  • Create: = Ist dieses Argument true , wird der Bereich erstellt, wenn er nicht vorhanden ist.
  • ReadOnly: = Ist diese Argument true , wird der Bereich nur lesend geöffnet. Bei false wird der Bereich exklusiv geöffnet und kann von anderen Plugin-Anwendungen nur noch lesend geöffnet werden.

Designer.Storage.NewObject​

Dieser Befehl erstellt ein neues Storage-Objekt. Das Storage-Objekt speichert Daten in der Form "Key=Value". Auf diese Weise können dem Storage-Objekt beliebige Inhalte zugewiesen, gespeichert und auch wieder gelesen werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

info

Der Befehl kann nur durchgeführt werden, wenn der Bereich von der Plugin-Anwendung zuvor exklusiv gesperrt wurde.

CMD Designer.Storage.NewObject (Name="<Objekt-Name>") [ExecResult=?]
  • Name: = Name des Storage-Objektes.

Der Name kann auch Unterverzeichnisse enthalten, die vom Befehl automatisch erstellt werden, sofern nicht vorhanden.

Beispiel:

CMD Designer.Storage.NewObject (Name="MyObjectRoot.MyObject") []

Erstellt im Storage-Bereich das Verzeichnis MyObjectRoot und darunter das Objekt MyObject.

Designer.Storage.<StorageName>.Save​

Änderungen die durch Designer.Storage.NewObject, Designer.Storage.<ObjectName>.WriteKey, etc. am Storage-Bereich vorgenommen wurden, werden nicht automatisch in die Datenbank übertragen. Dieser Befehl überträgt den Storage-Bereich in die Datenbank. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Storage.<StorageName>.Save () [ExecResult=?]

Designer.Storage.<StorageName>.Unload​

Entlädt einen zuvor erstellten bzw. geladenen Storage-Bereich und entsperrt diesen. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Storage.<StorageName>.Unload () [ExecResult=?]

Designer.Storage.<ObjectName>.DeleteObject​

Dieser Befehl löscht ein Storage-Objekt, welches zuvor mit Designer.Storage.NewObject angelegt wurde. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

info

Für die Durchführung muss der Storage-Bereich exklusiv geöffnet worden sein.

CMD Designer.Storage.<ObjectName>.DeleteObject () [ExecResult=?]
  • ObjectName: = Name des Storage-Objektes.

Der Name kann auch Unterverzeichnisse enthalten.

Beispiel:

CMD Designer.Storage.MyObjects.MyObject.DeleteObject () []

Löscht das Storage-Objekt MyObject im Unterverzeichnis MyObjects.

Designer.Storage.<ObjectName>.RenameObject​

Dieser Befehl löscht ein Storage-Objekt, welches zuvor mit Designer.Storage.NewObject angelegt wurde. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

info

Für die Durchführung muss der Storage-Bereich exklusiv geöffnet worden sein.

CMD Designer.Storage.<ObjectName>.RenameObject (NameNew="<Name>") [ExecResult=?]
  • ObjectName: = Name des umzubenennenden Storage-Objektes. Der Name kann auch Unterverzeichnisse enthalten.
  • NameNew: = Neuer Name im selben Verzeichnis.

Designer.Storage.<ObjectName>.WriteKey​

Dieser Befehl schreibt beliebige Inhalte zusammen mit deren Schlüssel in ein Storage-Objekt. Über die Schlüssel können die Werte mit dem Befehl Designer.Storage.<ObjectName>.ReadKey wieder ausgelesen werden. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

info

Für die Durchführung muss der Storage-Bereich exklusiv geöffnet worden sein.

CMD Designer.Storage.<ObjectName>.WriteKey (<Key>=<Value>, <Key>=<Value>, <Key>=<Value>, ...) [ExecResult=?]
  • ObjectName: = Name des Storage-Objektes. Der Name kann auch Unterverzeichnisse enthalten.
  • Key: = Frei wählbarer Name, der mit <Value> assoziiert wird. Der Name kann auch Unterverzeichnisse enthalten.
  • Value: = Beliebige Daten der zulässigen Type (Zeichenkette, numerischer oder logischer Wert).

Beispiel:

CMD Designer.Storage.MyObjects.MyObject.WriteKey (Vorname="Bill", Nachname="Gates", Geburtsjahr=1955) []

Designer.Storage.<ObjectName>.ReadKey​

Dieser Befehl liefert zuvor mit Designer.Storage.<ObjectName>.WriteKey geschriebene Inhalte eines Storage-Objektes anhand der Schlüsselwerte. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Storage.<ObjectName>.ReadKey () [<Key>=?, <Key>=?, <Key>=?, ..., ExecResult=?]
  • ObjectName: = Name des Storage-Objektes. Der Name kann auch Unterverzeichnisse enthalten.
  • Key: = Schlüssel, dessen Inhalt gelesen werden soll.

Designer.Storage.<ObjectName>.ReadNames​

Dieser Befehl liest die Unterverzeichnisse von <ObjectName> und gibt sie in Form einer durch ? separierten Liste zurück. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Storage.<ObjectName>.ReadNames () [ExecResult=?]
  • ObjectName: = Name des Storage-Objektes. Der Name kann auch Unterverzeichnisse enthalten.

Designer.Storage.LastLockingInfo​

Dieser Befehl ermittelt Informationen zum sperrenden Objekt. Die Informationen werden aktualisiert, wenn die Befehle Designer.Storage.Create bzw. Designer.Storage.Load ausgeführt werden, und der zu verwendende Bereich bereits gesperrt ist. Dieses Kommando steht ab CONZEPT 16-Version 5.8.04 zur Verfügung.

CMD Designer.Storage.LastLockingInfo () [LockingPluginName=?, LockingUserName=?, LockingSysName=?, LockingUserID=?, ExecResult=?]
  • LockingPluginName: = Name des Plugins, dass den Bereich im Zugriff hat (sofern auf derselben Maschine).
  • LockingUserName: = Name des sperrenden Benutzers.
  • LockingSysName: = Name des Rechners, auf dem das Plugin läuft.
  • LockingUserID: = ID des sperrenden Benutzers.

Designer.Storage.<ObjectName>.ExportFile​

Der Befehl exportiert ein Storage-Objekt (samt evtl. vorhandener Unterobjekten) als XML-Dokument. Dieses Kommando steht ab CONZEPT 16-Version 5.8.04 zur Verfügung.

CMD Designer.Storage.<ObjectName>.ExportFile (FileName="<Dateiname>") [ExecResult=?]
  • ObjectName: = Name des zu exportierenden Storage-Objektes. Der Name kann Unterverzeichnisse enthalten.
  • FileName: = Vollständiger Pfad für die zu generierende XML-Datei.

Designer.Storage.<ObjectName>.ExportStream​

Der Befehl exportiert ein Storage-Objekt (samt evtl. vorhandener Unterobjekte) als Base64 kodierten Datenstrom.

CMD Designer.Storage.<ObjectName>.ExportStream () [Content=?, ExecResult=?]
  • ObjectName: = Name des zu exportierenden Storage-Objektes. Der Name kann Unterverzeichnisse enthalten.
  • Content: = Daten im XML-Format als Base64 kodierter Datenstrom.

Designer.Storage.<ObjectName>.ImportFile​

Der Befehl importiert eine XML-Datei als Storage-Objekt. Der Befehl kann nur durchgeführt werden, wenn der Storage-Bereich von der Plugin-Anwendung zuvor exklusiv gesperrt wurde.

CMD Designer.Storage.ImportFile (Name="<Storage Pfad>", NameNew="<Storage Name>", FileName="<Dateiname>") [ExecResult=?]
  • Name: = Pfad für das zu importierende Storage-Objekt.
  • NameNew: = Name für das Storage-Objekt. Fehlt dieses Argument oder ist es leer, wird der Name aus der XML-Datei ermittelt. (optional)
  • FileName: = Vollständiger Pfad mit Dateiname der zu importierenden XML-Datei.

Tritt ein Fehler bei der XML-Verarbeitung auf, kann der Befehl Designer.LastXmlError verwendet werden, um weitere Informationen zu erhalten.

Designer.Storage.<ObjectName>.ImportStream​

Der Befehl importiert XML aus einem Base64 kodierten Datenstrom. Der Befehl kann nur durchgeführt werden, wenn der Storage-Bereich von der Plugin-Anwendung zuvor exklusiv gesperrt wurde.

CMD Designer.Storage.ImportStream  (Name="<Storage Pfad>", NameNew="<Storage Name>", Content="<Base64 kodierter Datenstrom>") [ExecResult=?]
  • Name: = Pfad für das zu importierende Storage-Objekt.
  • NameNew: = Name für das Storage-Objekt. Fehlt dieses Argument oder ist es leer, wird der Name aus der XML-Datei ermittelt. (optional)
  • Content: = Daten im XML-Format als Base64 kodierter Datenstrom.

Tritt ein Fehler bei der XML-Verarbeitung auf, kann der Befehl Designer.LastXmlError verwendet werden, um weitere Informationen zu erhalten.

Designer.Plugins.Shutdown​

Dieser Befehl entfernt die Plugin-Anwendung aus dem Designer. Bestehende Referenzen wie Menüpunkte werden entfernt. Geöffnete Storage-Bereiche werden geschlossen und entsperrt. Die Socket-Verbindung wird abgebaut. Dieses Kommando steht ab API-Version 1.1 zur Verfügung.

CMD Designer.Plugins.Shutdown () [ExecResult=?]

Designer.LastXmlError​

Der Befehl liefert zusätzliche Informationen, wenn bei der XML-Verarbeitung durch Designer.Storage.ImportStream oder Designer.Storage.ImportFile ein Fehler auftrat. Dieses Kommando steht ab CONZEPT 16-Version 5.8.04 zur Verfügung.

CMD Designer.LastXmlError () [Error=?, ErrorText=?, ErrorLine=?, ErrorColum=?, ErrorLevel=?]
  • Error: = XML-spezifischer Fehlercode.
  • ErrorText: = XML-Fehlertext.
  • ErrorLine: = Zeilennummer, in der der Fehler auftrat (sofern vorhanden, sonst 0 ).
  • ErrorColumn: = Spalte, in der der Fehler auftrat (sofern vorhanden, sonst 0 ).
  • ErrorLevel: = Fehlereinstufung ("none"=kein Fehler, "warning"=Warnung, "error"=Fehler, "fatal"=Fataler Fehler).