Isom.Request.Wizard

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Request.Wizard

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Request.Wizard

Beschreibung

Dieses Fachobjekt unterstützt die Erstellung von Assistenten. Es bietet dazu z. B. Funktionen an, mit denen sich der textuelle Inhalt und die Funktionalität von Schaltflächen jedes Schritts in der Dialogfolge angeben lassen.

Gestartet wird die Anzeige des Assistenten mit der Funktion 'Run'. Als erster Parameter 'function' wird der Name einer Funktion übergeben, die aufgerufen wird, um das Aussehen des Assistenten und die möglichen nächsten Dialogschritte festzulegen. Der zweite Parameter 'wizardControlledWorkflow' ist ein Wahrheitswert und legt fest, wie die Abarbeitung der Dialogschrittschritte gesteuert wird. Ist der Parameter 'true', übernimmt der Assistent einige Aufgaben selbst, wie z. B. den Aufruf zur Anzeige des nächsten Dialogschritts. Ist er 'false', übernimmt der ISOM/L-Autor diese Aufgaben, was ihm eine größere Flexibilität ermöglicht. Durch diese Unterscheidung ergeben sich zwei Arten, wie ein Assistent definiert werden kann:



Funktionen

Isom.Request.Wizard.AddBoolean

Speichert einen Wahrheitswert im Assistenten.

objectbound Isom.Base.Boolean Isom.Request.Wizard.AddBoolean  ( Isom.Base.String  key,
Isom.Base.Boolean  value  )

Speichert einen Wahrheitswert im Assistenten.

Der Wert wird zusammen mit einem Schlüssel übergeben, der das Abrufen des Wahrheitswerts mit 'GetBoolean' erlaubt

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.AddBoolean("Key1", true); 
Parameter:
key  Schlüssel des Wahrheitswerts
value  Zu speichernder Wahrheitswert
Ausnahmebehandlung:
Falls einer der Parameter 'key' und 'value' ein Void-Objekt ist, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.AddMeasurement

Fügt dem beschriebenen Dialogschritt eine Gruppe von Messwerten im Nachrichtenfenster des Assistenten hinzu

objectbound Isom.Base.Boolean Isom.Request.Wizard.AddMeasurement  ( Isom.Base.String  key,
Isom.Diagnostics.Measurement  measurement  )

Fügt dem beschriebenen Dialogschritt eine Gruppe von Messwerten im Nachrichtenfenster des Assistenten hinzu

 Isom.Diagnostics.Measurement measurement = Isom.Diagnostics.Measurement.CreateMeasurement("XAngle"); 
 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.AddMeasurement("Measurement_01", measurement); 
Parameter:
key  Schlüssel
measurement  Messwerte
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Gibt es bereits eine Messwertgruppe mit dem Schlüssel, wird sie durch die übergebene Gruppe ersetzt
Rückgabe:
'true'
Isom.Request.Wizard.AddMessage

Fügt einen Text zum beschriebenen Dialogschritt hinzu

objectbound Isom.Base.Boolean Isom.Request.Wizard.AddMessage  ( Isom.Base.String  key,
Isom.Base.String  message  )

Fügt einen Text zum beschriebenen Dialogschritt hinzu

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.AddMessage("MSG1", Texts.MESSAGE_WIZARD01); 
Parameter:
key  Schlüssel
message  Nachricht
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Gibt es bereits einen Text mit dem Schlüssel, wird er durch den übergebenen Text ersetzt
Rückgabe:
'true'
Isom.Request.Wizard.AddNumber

Speichert eine Zahl im Assistenten.

objectbound Isom.Base.Boolean Isom.Request.Wizard.AddNumber  ( Isom.Base.String  key,
Isom.Base.Number  value  )

Speichert eine Zahl im Assistenten.

Der Wert wird zusammen mit einem Schlüssel übergeben, der das Abrufen der Zahl mit 'GetNumber' erlaubt

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.AddNumber("Key1", 5); 
Parameter:
key  Schlüssel des Zahlenwerts
value  Zu speichernder Zahlenwert
Ausnahmebehandlung:
Falls einer der Parameter 'key' und 'value' ein Void-Objekt ist, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.AddRadioButton

Erzeugt einen RadioButton, der dem Nachrichtenfenster des beschriebenen Dialogschritts hinzugefügt wird

objectbound Isom.Request.RadioButton Isom.Request.Wizard.AddRadioButton  ( Isom.Base.String  key,
Isom.Base.String  rbText  )

Erzeugt einen RadioButton, der dem Nachrichtenfenster des beschriebenen Dialogschritts hinzugefügt wird

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 RadioButton rb = wizard.AddRadioButton("SelectYes", "Ja"); 
 RadioButton rb = wizard.AddRadioButton("SelectNo", "Nein"); 
Parameter:
key  Schlüssel des RadioButton
rbText  Nachrichtentext des RadioButton
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Gibt es bereits einen RadioButton mit dem Schlüssel, wird er ersetzt
Rückgabe:
Erzeugter RadioButton
Isom.Request.Wizard.AddString

Speichert eine Zeichenkette im Assistenten.

objectbound Isom.Base.Boolean Isom.Request.Wizard.AddString  ( Isom.Base.String  key,
Isom.Base.String  value  )

Speichert eine Zeichenkette im Assistenten.

Der Wert wird zusammen mit einem Schlüssel übergeben, der das Abrufen der Zeichenkette mit 'GetString' erlaubt

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.AddString("Key1", "Value1"); 
Parameter:
key  Schlüssel des Zeichenkettenwerts
value  Zu speichernder Zeichenkettenwert
Ausnahmebehandlung:
Falls einer der Parameter 'key' und 'value' ein Void-Objekt ist, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.AddTextInput

Fügt ein Texteingabefeld im Nachrichtenfenster des beschriebenen Dialogschritts hinzu

objectbound Isom.Base.Boolean Isom.Request.Wizard.AddTextInput  ( Isom.Base.String  key,
Isom.Base.String  inputDescription,
Isom.Base.String  defaultValue  )

Fügt ein Texteingabefeld im Nachrichtenfenster des beschriebenen Dialogschritts hinzu

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.AddTextInput("FgNr", "Fahrgestellnummer", ""); 
Parameter:
key  Schlüssel des Texteingabefelds
inputDescription  Texthinweis zum Eingabefeld
defaultValue  Voreingestellter Wert im Eingabefeld
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Gibt es bereits ein Texteingabefeld mit dem Schlüssel, wird es mit den übergebenen Werten ersetzt
Rückgabe:
'true'
Isom.Request.Wizard.ClearWizard

Setzt den Assistenten zurück auf die Einstellungen, die vor der Ausführung des Assistenten mit 'Run' gemacht wurden

objectbound Isom.Base.Boolean Isom.Request.Wizard.ClearWizard  (  ) 

Setzt den Assistenten zurück auf die Einstellungen, die vor der Ausführung des Assistenten mit 'Run' gemacht wurden

 Isom.Base.Boolean StartWizard() 
 { 
   Isom.Request.Wizard wizard = Wizard.Create(); 
   wizard.SetTitle("MyTitle"); 
   wizard.Run("Dispatcher", false); //Der Assistent ruft die Funktion 'Dispatcher' auf,  
                                    //die eine autorengesteuerten Dialogabfolge enthält. 
 } 

 Isom.Base.Boolean Dispatcher(Isom.Request.Wizard wizard) 
 { 
   wizard.AddMessage("FirstMessage", "Erster Schritt"); 
   Isom.Base.String button = wizard.WaitWizard();  //Zeigt den Dialog mit Text "FirstMessage" an und  
                                                   //wartet auf eine Schaltflächenbetätigung 
   wizard.ClearWizard();                 //Setzt den Dialog zurück (danach ist nur noch der Titel als  
                                         //"MyTitle" gesetzt) 
   switch (button) 
   { 
      //... 
   } 
 } 

Ausnahmebehandlung:
Die Funktion kann nur während der Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle durch den Assistenten verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.Clone

Liefert das aktuelle Objekt.

objectbound Isom.Request.Wizard Isom.Request.Wizard.Clone  (  ) 

Liefert das aktuelle Objekt.

Rückgabe:
das aktuelle Objekt
Isom.Request.Wizard.Create

Erzeugt einen neuen Assistenten

Isom.Request.Wizard Isom.Request.Wizard.Create  (  ) 

Erzeugt einen neuen Assistenten

Rückgabe:
Assistent
Isom.Request.Wizard.DisableBack

Deaktiviert die Zurück-Schaltfläche, so dass sie nicht verwendet werden kann

objectbound Isom.Base.Boolean Isom.Request.Wizard.DisableBack  (  ) 

Deaktiviert die Zurück-Schaltfläche, so dass sie nicht verwendet werden kann

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.DisableBack(); 
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.DisableNext

Deaktiviert die Weiter-Schaltfläche, so dass sie nicht verwendet werden kann

objectbound Isom.Base.Boolean Isom.Request.Wizard.DisableNext  (  ) 

Deaktiviert die Weiter-Schaltfläche, so dass sie nicht verwendet werden kann

Bemerkungen:
Um die Schaltfläche wieder aktivierbar zu machen, muss sie bei Steuerung der Schrittkontrolle durch den Assistenten mit 'SetNext' mit einer Funktion verknüpft werden. Bei autorengesteuerter Schrittkontrolle lässt sich der Zustand der Schaltfläche wieder durch 'ClearWizard' zurücksetzen.
 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.Disable(); 
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.Dispose

Schließt und löscht den Assistenten

objectbound Isom.Base.Boolean Isom.Request.Wizard.Dispose  (  ) 

Schließt und löscht den Assistenten

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.Dispose(); 
Ausnahmebehandlung:
Wurde der Wizard bereits mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.GetBoolean

Fragt einen vorher zur Datenhaltung an den Assistenten übergebenen Wahrheitswert ab

objectbound Isom.Base.Boolean Isom.Request.Wizard.GetBoolean  ( Isom.Base.String  key  ) 

Fragt einen vorher zur Datenhaltung an den Assistenten übergebenen Wahrheitswert ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.Boolean value = wizard.GetBoolean("Key1"); 
Parameter:
key  Schlüssel des Wahrheitswerts
Ausnahmebehandlung:
Kann dem Schlüssel kein Wahrheitswert zugeordnet werden, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Gespeicherter Wahrheitswert
Isom.Request.Wizard.GetContentDialog

Ruft das Fachobjekt ab, das den Inhalt des Nachrichtenfenster beschreibt

objectbound Isom.Request.UserRequest Isom.Request.Wizard.GetContentDialog  (  ) 

Ruft das Fachobjekt ab, das den Inhalt des Nachrichtenfenster beschreibt

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Request.UserRequest request = wizard.GetContentDialog(); 
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Das Fachobjekt mit dem Inhalt des Nachrichtenfensters
Isom.Request.Wizard.GetContentTitle

Ruft den Titel des Inhaltelements des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetContentTitle  (  ) 

Ruft den Titel des Inhaltelements des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String contentTitle = wizard.GetContentTitle(); 
Ausnahmebehandlung:
Wurde kein Titel festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Titel des Inhaltelements des Assistenten
Isom.Request.Wizard.GetDescription

Ruft den Dokumentenverweis zur Beschreibung des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetDescription  (  ) 

Ruft den Dokumentenverweis zur Beschreibung des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String description = wizard.GetDescription(); 
Ausnahmebehandlung:
Wurde kein Dokumentenverweis zur Beschreibung des Assistenten festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Dokumentenverweis zur Beschreibung des Assistenten
Isom.Request.Wizard.GetDescriptionTitle

Ruft den Titel des Elements zur Beschreibung des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetDescriptionTitle  (  ) 

Ruft den Titel des Elements zur Beschreibung des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String descriptionTitle = wizard.GetDescriptionTitle(); 
Ausnahmebehandlung:
Wurde kein Titel festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Titel des Elements zur Beschreibung des Assistenten
Isom.Request.Wizard.GetHelp

Ruft den Dokumentenverweis zur Hilfe für die Benutzung des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetHelp  (  ) 

Ruft den Dokumentenverweis zur Hilfe für die Benutzung des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String help = wizard.GetHelp(); 
Ausnahmebehandlung:
Wurde kein Hilfedokument festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Dokumentenverweis zur Hilfe für die Benutzung des Assistenten
Isom.Request.Wizard.GetHelpTitle

Ruft den Titel der Hilfe für die Benutzung des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetHelpTitle  (  ) 

Ruft den Titel der Hilfe für die Benutzung des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String helpTitle = wizard.GetHelpTitle(); 
Ausnahmebehandlung:
Wurde kein Titel festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Hilfe für die Benutzung des Assistenten
Isom.Request.Wizard.GetKey

Fragt den identifizierenden Schlüssel ab.

objectbound Isom.Base.String Isom.Request.Wizard.GetKey  (  ) 

Fragt den identifizierenden Schlüssel ab.

Mit dem Schlüssel kann der Assistent über die Funktion 'GetWizard' abgerufen werden

Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Schlüssel des Assistenten
Isom.Request.Wizard.GetLabelButtonBack

Fragt die Beschriftung der Schaltfläche 'Zurück' ab.

objectbound Isom.Base.String Isom.Request.Wizard.GetLabelButtonBack  (  ) 

Fragt die Beschriftung der Schaltfläche 'Zurück' ab.

Mit der Schaltfläche 'Zurück' wechselt man zu der vorangegangenen Ansicht.

Rückgabe:
Isom.Base.String
Die aktuelle Beschriftung der Schaltfläche.
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.GetLabelButtonDone

Fragt die Beschriftung der Schaltfläche 'Beenden' ab.

objectbound Isom.Base.String Isom.Request.Wizard.GetLabelButtonDone  (  ) 

Fragt die Beschriftung der Schaltfläche 'Beenden' ab.

Die Schaltfläche 'Beenden' wird im letzten Schritt statt der Schaltfläche 'Weiter' angezeigt. Mit ihr wird der Assistent geschlossen.

Rückgabe:
Isom.Base.String
Die aktuelle Beschriftung der Schaltfläche.
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.GetLabelButtonNext

Fragt die Beschriftung der Schaltfläche 'Weiter' ab.

objectbound Isom.Base.String Isom.Request.Wizard.GetLabelButtonNext  (  ) 

Fragt die Beschriftung der Schaltfläche 'Weiter' ab.

Mit der Schaltfläche 'Weiter' wechselt man zu der nächsten Ansicht.

Rückgabe:
Isom.Base.String
Die aktuelle Beschriftung der Schaltfläche.
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.GetLabelButtonQuit

Fragt die Beschriftung der Schaltfläche 'X' ab.

objectbound Isom.Base.String Isom.Request.Wizard.GetLabelButtonQuit  (  ) 

Fragt die Beschriftung der Schaltfläche 'X' ab.

Mit der Schaltfläche 'X' schließt man den Assistenten sofort.

Rückgabe:
Isom.Base.String
Die aktuelle Beschriftung der Schaltfläche.
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.GetLayoutType

Liefert den eingestellten Darstellungstypen des Assistenten

objectbound Isom.Base.String Isom.Request.Wizard.GetLayoutType  (  ) 

Liefert den eingestellten Darstellungstypen des Assistenten

 Isom.Base.Boolean IsLayoutSet(Isom.Request.Wizard wizard) 
 { 
   Isom.Base.String layout = wizard.GetLayout();    //Liefert den eingestellten Darstellungstypen 
   return layout.IsVoid();                          //Prüft auf das Void-Objekt 
 } 
Ausnahmebehandlung:
Ist der Darstellungstyp nicht eingestellt, wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Der Darstellungstyp legt die für den Assistenten in der Bedienoberfläche verwendete Anzeigemaske fest
Rückgabe:
Darstellungstyp
Isom.Request.Wizard.GetMeasurement

Ruft eine Gruppe von Messwerten im Nachrichtenfenster des beschriebenen Dialogschritts ab

objectbound Isom.Diagnostics.Measurement Isom.Request.Wizard.GetMeasurement  ( Isom.Base.String  key  ) 

Ruft eine Gruppe von Messwerten im Nachrichtenfenster des beschriebenen Dialogschritts ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String key = wizard.WaitWizard(); 
 Isom.Diagnostics.Measurement measurement = wizard.GetMeasurement(key); 
Parameter:
key  Schlüssel
Ausnahmebehandlung:
Wurde keine Gruppe von Messwerten für den Schlüssel festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Gruppe von Messwerten
Isom.Request.Wizard.GetMedia

Ruft den Verweis auf das Medienelement des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetMedia  (  ) 

Ruft den Verweis auf das Medienelement des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String media = wizard.GetMedia(); 
Ausnahmebehandlung:
Wurde kein Verweis festgelegt, wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Verweis auf das Medienelement des Assistenten
Isom.Request.Wizard.GetMediaTitle

Ruft den Titel des Medienelements des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetMediaTitle  (  ) 

Ruft den Titel des Medienelements des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String mediaTitle = wizard.GetMediaTitle(); 
Ausnahmebehandlung:
Wurde kein Titel festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Titel des Medienelements des Assistenten
Isom.Request.Wizard.GetMessage

Ruft einen für den beschriebenen Dialogschritt festgelegten Text ab

objectbound Isom.Base.String Isom.Request.Wizard.GetMessage  ( Isom.Base.String  key  ) 

Ruft einen für den beschriebenen Dialogschritt festgelegten Text ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String key = wizard.WaitWizard(); 
 Isom.Base.String message = wizard.GetMessage(key); 
Parameter:
key  Schlüssel
Ausnahmebehandlung:
Wurde kein Text für den Schlüssel festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Nachricht
Isom.Request.Wizard.GetNext

Fragt ab, welche Funktion mit der Weiter-Schaltfläche verknüpft ist

objectbound Isom.Base.String Isom.Request.Wizard.GetNext  (  ) 

Fragt ab, welche Funktion mit der Weiter-Schaltfläche verknüpft ist

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String nextFunction = wizard.GetNext(); 
Ausnahmebehandlung:
Ist keine Funktion mit der Weiter-Schaltfläche verknüpft, wird das Void-Objekt zurückgegeben
Die Funktion kann nicht während Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Mit der Weiter-Schaltfläche verknüpfte Funktion
Isom.Request.Wizard.GetNumber

Fragt einen vorher zur Datenhaltung an den Assistenten übergebenen Zahlenwert ab

objectbound Isom.Base.Number Isom.Request.Wizard.GetNumber  ( Isom.Base.String  key  ) 

Fragt einen vorher zur Datenhaltung an den Assistenten übergebenen Zahlenwert ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Number value = wizard.GetNumber("Key1"); 
Parameter:
key  Schlüssel des Zahlenwerts
Ausnahmebehandlung:
Kann dem Schlüssel kein Zahlenwert zugeordnet werden, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Gespeicherter Zahlenwert
Isom.Request.Wizard.GetPreviousStep

Ermittelt den Assistenten aus dem vorhergehenden Schritt

objectbound Isom.Request.Wizard Isom.Request.Wizard.GetPreviousStep  (  ) 

Ermittelt den Assistenten aus dem vorhergehenden Schritt

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Request.Wizard previousStep = wizard.GetPreviousStep(); 
Ausnahmebehandlung:
Wurde noch kein Schritt des Assistenten durchgeführt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Assistent mit den Daten aus dem vorhergehenden Schritt. Dieses Fachobjekt kann nicht verändert oder ausgeführt werden, jede Funktion, die dies versucht gibt das Void-Objekt zurück
Isom.Request.Wizard.GetQuit

Fragt ab, welche Funktion beim Beenden des Assistenten ausgeführt wird

objectbound Isom.Base.String Isom.Request.Wizard.GetQuit  (  ) 

Fragt ab, welche Funktion beim Beenden des Assistenten ausgeführt wird

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String nextFunction = wizard.GetNext(); 
Ausnahmebehandlung:
Ist keine Funktion Zur Ausführung beim Beenden gesetzt, wird das Void-Objekt zurückgegeben
Die Funktion kann nicht während Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Funktion , die beim Beenden des Assistenten ausgeführt wird
Isom.Request.Wizard.GetRadioButton

Fragt einen RadioButton ab

objectbound Isom.Request.RadioButton Isom.Request.Wizard.GetRadioButton  ( Isom.Base.String  key  ) 

Fragt einen RadioButton ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 RadioButton rb = wizard.GetRadioButton("SelectYes"); 
Parameter:
key  Schlüssel des RadioButton
Ausnahmebehandlung:
Gibt es keinen RadioButton mit dem Schlüssel, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
RadioButton
Isom.Request.Wizard.GetSelectedButton

Fragt die betätigte Schaltfläche ab.

objectbound Isom.Base.String Isom.Request.Wizard.GetSelectedButton  (  ) 

Fragt die betätigte Schaltfläche ab.

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String result = wizard.GetSelectedButton(); 
Ausnahmebehandlung:
Ist keine Schaltfläche betätigt oder der Assistent bei autorengesteuerter Schrittkontrolle mit 'ClearWizard' zurückgesetzt worden, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Die Rückgabe ist einer folgenden Werte: 1. "Next" für die 'Weiter'-Schaltfläche 1. "Back" für die 'Zurück'-Schaltfläche 1. "Quit", falls der Benutzer den Assistenten beendet hat
Rückgabe:
Betätigte Schaltfläche
Isom.Request.Wizard.GetSelectedRadioButton

Fragt den ausgewählten RadioButton ab

objectbound Isom.Request.RadioButton Isom.Request.Wizard.GetSelectedRadioButton  (  ) 

Fragt den ausgewählten RadioButton ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 RadioButton rb = wizard.GetSelectedButton(); 
Ausnahmebehandlung:
Ist kein RadioButton ausgewählt oder der Assistent bei autorengesteuerter Schrittkontrolle mit 'ClearWizard' zurückgesetzt worden, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Ausgewählter RadioButton
Isom.Request.Wizard.GetString

Fragt eine vorher zur Datenhaltung an den Assistenten übergebene Zeichenkette ab

objectbound Isom.Base.String Isom.Request.Wizard.GetString  ( Isom.Base.String  key  ) 

Fragt eine vorher zur Datenhaltung an den Assistenten übergebene Zeichenkette ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String value = wizard.GetString("Key1"); 
Parameter:
key  Schlüssel des Zeichenkettenwerts
Ausnahmebehandlung:
Kann dem Schlüssel keine Zeichenkette zugeordnet werden, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Gespeicherter Zeichenkettenwert
Isom.Request.Wizard.GetTextInput

Ruft den Wert eines Texteingabefelds ab

objectbound Isom.Base.String Isom.Request.Wizard.GetTextInput  ( Isom.Base.String  key  ) 

Ruft den Wert eines Texteingabefelds ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String input = wizard.GetTextInput(); 
Parameter:
key  Schlüssel des Texteingabefelds
Ausnahmebehandlung:
Wurde kein Texteingabefeld für das Nachrichtenfenster festgelegt, wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Aktueller Wert des Texteingabefelds
Isom.Request.Wizard.GetTitle

Ruft den Titel des Assistenten ab

objectbound Isom.Base.String Isom.Request.Wizard.GetTitle  (  ) 

Ruft den Titel des Assistenten ab

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String title = wizard.GetTitle(); 
Ausnahmebehandlung:
Wurde kein Titel festgelegt, wird das Void-Objekt zurückgegeben
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Titel des Assistenten
Isom.Request.Wizard.GetUpdateFunction

Fragt die Aktualisierungsfunktion ab.

objectbound Isom.Base.String Isom.Request.Wizard.GetUpdateFunction  (  ) 

Fragt die Aktualisierungsfunktion ab.

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Base.String updateFunction = wizard.GetUpdateFunction(); 
Ausnahmebehandlung:
Ist keine Aktualisierungsfunktion gesetzt, wird das Void-Objekt zurückgegeben
Die Funktion kann nicht während Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
Funktion, die den Dialogschritt aktualisiert
Isom.Request.Wizard.GetWizard

Fragt einen bereits erzeugten Assistenten anhand seines identifizierenden Schlüssels ab

Isom.Request.Wizard Isom.Request.Wizard.GetWizard  ( Isom.Base.String  key  ) 

Fragt einen bereits erzeugten Assistenten anhand seines identifizierenden Schlüssels ab

 Isom.Request.Wizard wizard1 = wizard1.Create(); 
 Isom.Base.String key = wizard1.GetKey(); 
 Isom.Request.Wizard wizard2 = wizard1.GetWizard(key); 
Parameter:
key  Schlüssel des abgefragten Assistenten
Ausnahmebehandlung:
Existiert kein Assistent mit dem Schlüssel, wird das Void-Objekt zurückgegeben
Rückgabe:
Assistent
Isom.Request.Wizard.IsVisited

Ruft ab, ob der Dialogschritt schon einmal ausgeführt wurde

objectbound Isom.Base.Boolean Isom.Request.Wizard.IsVisited  (  ) 

Ruft ab, ob der Dialogschritt schon einmal ausgeführt wurde

 Isom.Base.Boolean Step1(Isom.Request.Wizard wizard) 
 { 
   if (wizard.IsVisited()) 
   { 
     //Schritt wurde bereits ausgeführt 
   } 
   else 
   { 
     //Schritt wird das erste Mal ausgeführt 
   } 
   return true; 
 } 
Ausnahmebehandlung:
Wird die Funktion außerhalb der Festlegung eines Dialogschritts aufgerufen, wird das Void-Objekt zurückgegeben
Die Funktion kann nur während der Ausführung von 'Run' mit Steuerung der Schrittkontrolle durch den Assistenten verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true', falls der Dialogschritt schon einmal ausgeführt wurde, 'false' sonst
Isom.Request.Wizard.IsVoid

Bestimmt, ob das aktuelle Element das Void-Objekt ist.

objectbound Isom.Base.Boolean Isom.Request.Wizard.IsVoid  (  ) 

Bestimmt, ob das aktuelle Element das Void-Objekt ist.

 Isom.Request.Wizard a = Isom.Request.Wizard.Create(); 
 if (a.IsVoid()) 
 { 
    return false; 
 } 
Rückgabe:
'true', falls das aktuelle Element das Void-Objekt ist, 'false' sonst.
Isom.Request.Wizard.Run

Startet die Ausführung des Assistenten.

objectbound Isom.Base.Boolean Isom.Request.Wizard.Run  ( Isom.Base.String  function,
Isom.Base.Boolean  wizardControlledWorkflow  )

Startet die Ausführung des Assistenten.

 Isom.Base.Boolean StartWizard() 
 { 
   Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
   wizard.Run("Step1", true);     //Startet Assistent mit automatischer Schrittverwaltung  
                                  //und 'Step1' als ersten Schritt. 
 } 

 Isom.Base.Boolean Step1(Isom.Request.Wizard wizard) 
 { 
   //... 
 } 

Parameter:
function  Funktion, die den Assistenten mit Inhalt befüllt.
wizardControlledWorkflow  Angabe, ob die Schrittverwaltung automatisch vom Assistenten erledigt wird.
Bemerkungen:
Für die Angabe des Parameters 'function' gelten die gleichen Regeln wie beim direkten Aufruf der Funktion. Hier kann wie im Codebeispiel der Funktionsname ohne Namensraumqualifizierung angegeben werden, falls die Funktion im gleichen Namensraum liegt, wie die Funktion, in der 'Run' aufgerufen wird. Alternativ kann die Funktion mit einem vorangestellten Namensraum angegeben werden, z. B. mit 'OEM.Wizard1.Step1'. Es können nur Funktionen verwendet werden, die genau einen Parameter besitzen, der vom Typ 'Wizard' ist und ein 'Isom.Base.Boolean' als Rückgabewert liefern. Kann der Parameter 'function' keiner ISOM/L-Funktion zugeordnet werden, die den Anforderungen entspricht, liefert der Aufruf von 'Run' die Rückgabe 'Void'.
Ausnahmebehandlung:
Existiert die angegebene Funktion nicht oder erfüllt sie die Anforderungen nicht, wird das Void-Objekt zurückgegeben.
Wird der Assistent bereits mit einem Aufruf von Run() ausgeführt, wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetContentTitle

Legt den Titel des Inhaltelements des Assistenten fest

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetContentTitle  ( Isom.Base.String  title  ) 

Legt den Titel des Inhaltelements des Assistenten fest

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetContentTitle("Ablauf"); 
Parameter:
title  Titel des Inhaltelements des Assistenten
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetDescription

Legt das Dokument fest, das zur Beschreibung des Assistenten angezeigt wird.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetDescription  ( Isom.Base.String  descriptionFile  ) 

Legt das Dokument fest, das zur Beschreibung des Assistenten angezeigt wird.

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetDescription("DescriptionDir\Description_Wizard01.pdf"); 
Parameter:
descriptionFile  Dokumentenverweis zur Anzeige der Beschreibung des Assistenten
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Der Parameter 'descriptionFile' unterstützt die von der Klasse 'MediaElement' angebotenen Medienelemente.
Rückgabe:
'true'
Isom.Request.Wizard.SetDescriptionTitle

Legt den Titel des Elements zur Beschreibung des Assistenten fest

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetDescriptionTitle  ( Isom.Base.String  title  ) 

Legt den Titel des Elements zur Beschreibung des Assistenten fest

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetDescriptionTitle("Beschreibung"); 
Parameter:
title  Titel des Elements zur Beschreibung des Assistenten
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetHelp

Legt das Dokument fest, das zur Hilfe für die Benutzung des Assistenten angezeigt wird

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetHelp  ( Isom.Base.String  helpFile  ) 

Legt das Dokument fest, das zur Hilfe für die Benutzung des Assistenten angezeigt wird

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetHelp("HelpDir\HowTo_Wizard01.html"); 
Parameter:
helpFile  Dokumentenverweis zur Anzeige der Hilfe des Assistenten
Bemerkungen:
Der Parameter 'helpFile' unterstützt die von der Klasse 'MediaElement' angebotenen Medienelemente.
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetHelpTitle

Legt den Titel der Hilfe für die Benutzung des Assistenten fest

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetHelpTitle  ( Isom.Base.String  title  ) 

Legt den Titel der Hilfe für die Benutzung des Assistenten fest

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetHelpTitle("Hilfe"); 
Parameter:
title  Titel der Hilfe für die Benutzung des Assistenten
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetLabelButtonBack

Setzt die Beschriftung für die Schaltfläche 'Zurück'.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetLabelButtonBack  ( Isom.Base.String  label  ) 

Setzt die Beschriftung für die Schaltfläche 'Zurück'.

Mit der Schaltfläche 'Zurück' wechselt man zu der vorangegangenen Ansicht.

Parameter:
label  Beschriftung für die Schaltfläche
Rückgabe:
'true'
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht oder wird als Parameter eine leere Zeichenkette oder ein Void-Objekt übergeben, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.SetLabelButtonDone

Setzt die Beschriftung für die Schaltfläche 'Beenden'.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetLabelButtonDone  ( Isom.Base.String  label  ) 

Setzt die Beschriftung für die Schaltfläche 'Beenden'.

Die Schaltfläche 'Beenden' wird im letzten Schritt statt der Schaltfläche 'Weiter' angezeigt. Mit ihr wird der Assistent geschlossen.

Parameter:
label  Beschriftung für die Schaltfläche
Rückgabe:
'true'
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht oder wird als Parameter eine leere Zeichenkette oder ein Void-Objekt übergeben, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.SetLabelButtonNext

Setzt die Beschriftung für die Schaltfläche 'Weiter'.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetLabelButtonNext  ( Isom.Base.String  label  ) 

Setzt die Beschriftung für die Schaltfläche 'Weiter'.

Mit der Schaltfläche 'Weiter' wechselt man zu der nächsten Ansicht.

Parameter:
label  Beschriftung für die Schaltfläche
Rückgabe:
'true'
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht oder wird als Parameter eine leere Zeichenkette oder ein Void-Objekt übergeben, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.SetLabelButtonQuit

Setzt die Beschriftung für die Schaltfläche 'X'.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetLabelButtonQuit  ( Isom.Base.String  label  ) 

Setzt die Beschriftung für die Schaltfläche 'X'.

Mit der Schaltfläche 'X' schließt man den Assistenten sofort.

Zu beachten:
Im Taurus® Client wird für diese Schaltfläche eine Grafik verwendet und die Beschriftung nicht angezeigt.
Parameter:
label  Beschriftung für die Schaltfläche
Rückgabe:
'true'
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht oder wird als Parameter eine leere Zeichenkette oder ein Void-Objekt übergeben, wird das Void-Objekt zurückgegeben
Isom.Request.Wizard.SetLayoutType

Setzt den Darstellungstypen des Assistenten

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetLayoutType  ( Isom.Base.String  layout  ) 

Setzt den Darstellungstypen des Assistenten

 Isom.Base.Boolean StepWithLayoutX(Isom.Request.Wizard wizard) 
 { 
   wizard.SetLayout("LayoutX");    //Setzt den Darstellungstypen 'LayoutX' 
   wizard.SetNext("Step2", false); //Verknüpt die Weiter-Schaltfläche mit 'Step2' 
   return true; 
 } 
Parameter:
layout  Darstellungstyp, der gesetzt wird
Ausnahmebehandlung:
Ist der Darstellungstyp das Void-Objekt oder die leere Zeichenkette, wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Der Darstellungstyp legt die für den Assistenten in der Bedienoberfläche verwendete Anzeigemaske fest
Rückgabe:
'true'
Isom.Request.Wizard.SetMeasurement

Aktualisiert eine Gruppe von Messwerten im Nachrichtenfenster des beschriebenen Dialogschritts

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetMeasurement  ( Isom.Base.String  key,
Isom.Diagnostics.Measurement  measurement  )

Aktualisiert eine Gruppe von Messwerten im Nachrichtenfenster des beschriebenen Dialogschritts

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 Isom.Diagnostics.Measurement update = Isom.Diagnostics.Measurement.CreateMeasurement("XAngle"); 
 wizard.SetMeasurement("Measurement_01", update); 
Parameter:
key  Schlüssel
measurement  Aktualisierte Messwerte
Ausnahmebehandlung:
Wurde keine Gruppe von Messwerten für den Schlüssel festgelegt, wird das Void-Objekt zurückgegeben
Die Funktion kann nur während der Ausführung von 'Run' mit Steuerung der Schrittkontrolle durch den Assistenten verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Die Funktion kann in der Aktualisierungsfunktion des Dialogschritts verwendet werden, um eine vorher eingeführte Messwertgruppe zu aktualisieren.
Rückgabe:
'true'
Isom.Request.Wizard.SetMedia

Legt das Medienelement fest, das im Assistenten angezeigt werden soll

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetMedia  ( Isom.Base.String  mediaFile  ) 

Legt das Medienelement fest, das im Assistenten angezeigt werden soll

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetMedia("MediaDir\Diagrams\Wizard01.jpg"); 
Parameter:
mediaFile  Verweis auf ein Medienelement
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Der Parameter 'mediaFile' unterstützt die von der Klasse 'MediaElement' angebotenen Medienelemente.
Rückgabe:
'true'
Isom.Request.Wizard.SetMediaTitle

Legt den Titel des Medienelements des Assistenten fest

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetMediaTitle  ( Isom.Base.String  title  ) 

Legt den Titel des Medienelements des Assistenten fest

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetMediaTitle("Bild"); 
Parameter:
title  Titel des Medienelements des Assistenten
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetMessage

Aktualisiert einen Text im Dialogschritt, während er angezeigt wird.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetMessage  ( Isom.Base.String  key,
Isom.Base.String  message  )

Aktualisiert einen Text im Dialogschritt, während er angezeigt wird.

 Isom.Base.Boolean StartWizard() 
 { 
   Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
   wizard.Run("Step1", true); 
 } 

 Isom.Base.Boolean Step1(Isom.Request.Wizard wizard) 
 { 
   //... 
   wizard.AddMessage("MSG1", Texts.MESSAGE_WIZARD01); 
   //... 
   wizard.SetUpdateFunction("UpdateStep1"); 
   //... 
 } 

 Isom.Base.Boolean UpdateStep1(Isom.Request.Wizard wizard) 
 { 
   //... 
   Isom.Base.String updatedText = Texts.MESSAGE_WIZARD02; 
   wizard.SetMessage("MSG1", updatedText); 
   //... 
 } 

Parameter:
key  Schlüssel der aktualisierten Nachricht
message  Nachricht
Ausnahmebehandlung:
Wurde kein Text für den Schlüssel festgelegt, wird das Void-Objekt zurückgegeben
Die Funktion kann nur während der Ausführung von 'Run' mit Steuerung der Schrittkontrolle durch den Assistenten verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Bemerkungen:
Die Funktion kann in der Aktualisierungsfunktion des Dialogschritts verwendet werden, um eine vorher eingeführte Textnachricht zu aktualisieren.
Rückgabe:
'true'
Isom.Request.Wizard.SetNext

Bietet zwei Möglichkeiten an, die Weiter-Schaltfläche anzupassen: 1.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetNext  ( Isom.Base.String  nextFunction,
Isom.Base.Boolean  lastStep  )

Bietet zwei Möglichkeiten an, die Weiter-Schaltfläche anzupassen: 1.

Die Weiter-Schaltfläche kann für die aktivierte Schrittkontrolle durch den Assistenten mit einer Funktion, die den Dialog für den nächsten Schritt anpasst, verknüpft werden. 2. Die Weiter-Schaltfläche kann zu einer Beenden-Schaltfläche umgewandelt werden

 Isom.Base.Boolean Step1(Isom.Request.Wizard wizard) 
 { 
   wizard.SetNext("Step2", false); 
   return true; 
 } 

 Isom.Base.Boolean Step2(Isom.Request.Wizard wizard) 
 { 
   //... 
 } 

Parameter:
nextFunction  Funktion, die den Assistenten mit dem Inhalt des nächsten Dialogs befüllt.
lastStep  Angabe, ob im nächsten Dialog die Weiter-Schaltfläche durch eine Beenden-Schaltfläche ersetzt wird
Bemerkungen:
Für die Angabe des Parameters 'nextFunction' gelten ansonsten die gleichen Regeln wie beim direkten Aufruf der Funktion. Hier kann wie im Codebeispiel der Funktionsname ohne Namensraumqualifizierung angegeben werden, falls die Funktion im gleichen Namensraum liegt, wie die Funktion, in der 'SetNext' aufgerufen wird. Alternativ kann die Funktion mit einem vorangestellten Namensraum angegeben werden, z. B. mit 'OEM.Wizard1.Step2'. Es können nur Funktionen verwendet werden, die genau einen Parameter besitzen, der vom Typ 'Wizard' ist und ein 'Isom.Base.Boolean' als Rückgabewert liefern.
Falls der Parameter 'lastStep' den Wert 'true' besitzt, kann als Parameter 'nextFunction' auch eine leere Zeichenkette angegeben werden. Wird die Beenden-Schaltfläche dann während der Ausführung von 'Run' mit Steuerung der Schrittkontrolle durch den Assistenten betätigt, wird falls vorhanden, die mit 'SetQuit' vorgegebene Funktion ausgeführt. Wurde keine Funktion mit 'SetQuit' vorgegeben, wird der Assistent geschlossen, ohne eine Funktion auszuführen.
Bei autorengesteuerter Schrittkontrolle kann die Funktion nur mit leerer Zeichenkette als Parameter 'nextFunction' und 'lastStep' mit Wert 'true' verwendet werden. Dadurch wandelt sich die Weiter- Schaltfläche in eine Beenden-Schaltfläche um. Bei dieser Art der Schrittkontrolle wird bei anderen Parametern das Void-Objekt zurückgegeben.
Ausnahmebehandlung:
Existiert die angegebene Funktion nicht oder erfüllt sie die Anforderungen nicht, wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetQuit

Setzt eine Funktion, die beim Beenden des Assistenten aufgerufen wird

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetQuit  ( Isom.Base.String  quitFunction  ) 

Setzt eine Funktion, die beim Beenden des Assistenten aufgerufen wird

 Isom.Base.Boolean StartWizard() 
 { 
   Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
   wizard.SetQuit("OnQuit"); 
 } 

 Isom.Base.Boolean OnQuit(Isom.Request.Wizard wizard) 
 { 
   wizard.Dispose(); 
 } 

Parameter:
quitFunction  Funktion, die beim Beenden des Assistenten aufgerufen wird
Bemerkungen:
Für die Angabe des Parameters 'quitFunction' gelten die gleichen Regeln wie beim direkten Aufruf der Funktion. Hier kann wie im Codebeispiel der Funktionsname ohne Namensraumqualifizierung angegeben werden, falls die Funktion im gleichen Namensraum liegt, wie die Funktion, in der 'SetQuit' aufgerufen wird. Alternativ kann die Funktion mit einem vorangestellten Namensraum angegeben werden, z. B. mit 'OEM.Wizard1.OnQuit'. Es können nur Funktionen verwendet werden, die genau einen Parameter besitzen, der vom Typ 'Wizard' ist und ein 'Isom.Base.Boolean' als Rückgabewert liefern.
Der Rückgabewert der 'quitFunction' legt fest, ob der Assistent tatsächlich beendet wird. Gibt die 'quitFunction' den Wert 'false' zurück, so wird die Ausführung des Assistenten fortgesetzt.
Ausnahmebehandlung:
Existiert die angegebene Funktion nicht oder erfüllt sie die Anforderungen nicht, wird das Void-Objekt zurückgegeben.
Die Funktion kann nicht während Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.SetTitle

Setzt den anzuzeigenden Titel des Assistenten

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetTitle  ( Isom.Base.String  title  ) 

Setzt den anzuzeigenden Titel des Assistenten

 Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
 wizard.SetTitle("ISOM-Assistent"); 
Ausnahmebehandlung:
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Parameter:
title  Titel des Assistenten
Rückgabe:
'true'
Isom.Request.Wizard.SetUpdateFunction

Setzt die Aktualisierungsfunktion.

objectbound Isom.Base.Boolean Isom.Request.Wizard.SetUpdateFunction  ( Isom.Base.String  updateFunction  ) 

Setzt die Aktualisierungsfunktion.

Diese Funktion wird vor der Anzeige des Dialogschritts gestartet und erlaubt es, die Anzeige zu aktualisieren.

 Isom.Base.Boolean StartWizard() 
 { 
   Isom.Request.Wizard wizard = Isom.Request.Wizard.Create(); 
   wizard.Run("Step1", true); 
 } 

 Isom.Base.Boolean Step1(Isom.Request.Wizard wizard) 
 { 
   //... 
   wizard.AddMessage("MSG1", Texts.MESSAGE_WIZARD01); 
   //... 
   wizard.SetUpdateFunction("UpdateStep1"); 
   //... 
 } 

 Isom.Base.Boolean UpdateStep1(Isom.Request.Wizard wizard) 
 { 
   //... 
   Isom.Base.String updatedText = Texts.MESSAGE_WIZARD02; 
   wizard.SetMessage("MSG1", updatedText); 
   //... 
 } 

Parameter:
updateFunction  Funktion, die bei Anzeige des Dialogschritts gestartet wird
Bemerkungen:
Für die Angabe des Parameters 'updateFunction' gelten die gleichen Regeln wie beim direkten Aufruf der Funktion. Hier kann wie im Codebeispiel der Funktionsname ohne Namensraumqualifizierung angegeben werden, falls die Funktion im gleichen Namensraum liegt, wie die Funktion, in der 'UpdateStep1' aufgerufen wird. Alternativ kann die Funktion mit einem vorangestellten Namensraum angegeben werden, z. B. mit 'OEM.Wizard1.UpdateStep1'. Es können nur Funktionen verwendet werden, die genau einen Parameter besitzen, der vom Typ 'Wizard' ist und ein 'Isom.Base.Boolean' als Rückgabewert liefern.
Um die Anzeige des Dialogschritts zu ändern, kann man in der Aktualisierungsfunktion die Funktionen aufrufen, mit denen die Inhalte des Assistenten geändert werden.
Ausnahmebehandlung:
Existiert die angegebene Funktion nicht oder erfüllt sie die Anforderungen nicht, wird das Void-Objekt zurückgegeben.
Die Funktion kann nicht während Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.ShowWizard

Zeigt einen Dialog an und kehrt zurück, ohne auf eine Schaltflächenbetätigung zu warten

objectbound Isom.Base.Boolean Isom.Request.Wizard.ShowWizard  (  ) 

Zeigt einen Dialog an und kehrt zurück, ohne auf eine Schaltflächenbetätigung zu warten

 Isom.Base.Boolean StartWizard() 
 { 
   Isom.Request.Wizard wizard = Wizard.Create(); 
   wizard.SetTitle("MyTitle"); 
   wizard.Run("Dispatcher", false); //Der Assistent ruft die Funktion 'Dispatcher' auf,  
                                    //die eine autorengesteuerten Dialogabfolge enthält. 
 } 

 Isom.Base.Boolean Dispatcher(Isom.Request.Wizard wizard) 
 { 
   wizard.AddMessage("FirstMessage", "Erster Schritt"); 
   wizard.ShowWizard();  //Zeigt den Dialog mit Text "FirstMessage" an 
   //... 
 } 

Ausnahmebehandlung:
Die Funktion kann nur während der Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle durch den Assistenten verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'
Isom.Request.Wizard.Void

Erzeugt ein Void-Objekt.

Isom.Request.Wizard Isom.Request.Wizard.Void  (  ) 

Erzeugt ein Void-Objekt.

Das erzeugte Void-Objekt kann z. B. in Funktionen zurückgegeben werden, um einen Fehler anzuzeigen.

 Isom.Request.Wizard f() 
 { 
  //... 
  if (error) 
    return Wizard.Void(); 
  //... 
 } 
Rückgabe:
Void-Objekt
Isom.Request.Wizard.WaitWizard

Zeigt einen Dialog an und wartet auf eine Schaltflächenbetätigung

objectbound Isom.Base.String Isom.Request.Wizard.WaitWizard  (  ) 

Zeigt einen Dialog an und wartet auf eine Schaltflächenbetätigung

 Isom.Base.Boolean StartWizard() 
 { 
   Isom.Request.Wizard wizard = Wizard.Create(); 
   wizard.SetTitle("MyTitle"); 
   wizard.Run("Dispatcher", false); //Der Assistent ruft die Funktion 'Dispatcher' auf,  
                                    //die eine autorengesteuerten Dialogabfolge enthält. 
 } 

 Isom.Base.Boolean Dispatcher(Isom.Request.Wizard wizard) 
 { 
   wizard.AddMessage("FirstMessage", "Erster Schritt"); 
   Isom.Base.String button = wizard.WaitWizard();  //Zeigt den Dialog mit Text "FirstMessage" an und  
                                                   //wartet auf eine Schaltflächenbetätigung 
   wizard.ClearWizard();                 //Setzt den Dialog zurück (danach ist nur noch der Titel als  
                                         //"MyTitle" gesetzt) 
   switch (button) 
   { 
      //... 
   } 
 } 

Ausnahmebehandlung:
Die Funktion kann nur während der Ausführung von 'Run' mit autorengesteuerter Schrittkontrolle durch den Assistenten verwendet werden, sonst wird das Void-Objekt zurückgegeben.
Wurde der Wizard mit 'Dispose()' gelöscht, wird das Void-Objekt zurückgegeben
Rückgabe:
'true'

Version 9.10.1.0 vom 25 November 2013