Navigation: click.EXE 4.0 Premium > Eigene PlugIns > cXtensionen >

Aufbau

Diese Seite drucken
Vorherige Seite Nächste Seite
Zurück zur Kapitelübersicht

Aufbau des Objekts für eine cXtension:

Das cXtension-Skript besteht üblicherweise nur aus einem Objekt, ggf. mit einem Vorspann zum Verhindern eines eigenständigen Starts. Der Name des Objekts ist gleichzeitig der Name des neuen Befehls in der click.EXE-Befehlsliste (sofern ein neuer Befehl gewünscht ist).

Damit das Objekt als PlugIn arbeiten kann, muss es einen festgelegten Grundaufbau haben, also bestimmte Eigenschaften aufweisen, deren Namen alle mit einem Ausrufungszeichen beginnen.

 

Über folgende Eigenschaften (jeweils nur Lesen) kann bzw. muss ein cXtension-Objekt verfügen (die Beispielcodes zeigen den Code einer cXtension namens Muster):

!BeschreibungBeschreibung der cXtension
!VersionVersion der cXtension
!RegistriertcXtension ist registriert (lizensiert und daher im Editor uneingeschränkt nutzbar) oder nicht
!Registrierungwird aufgerufen, wenn der Benutzer eine cXtension registrieren möchte
!VariablenListe der bereitgestellten Variablen
!EreignisseListe der verfügbaren Ereignisse
!HilfedateiHilfedatei, die im Editor per F1-Taste aufgerufen werden soll
!RessourcenDie im Skript verwendeten Ressourcen z.B. Bilder etc.
!DarstellungDefinition der Darstellung der cXtension-Befehle im Skript
!DialogAnzeige des Dialogs zum Bearbeiten des Befehls
!DesignerbildIcon, das die cXtension im Dialog-Designer repräsentieren soll
!Ausführender eigentliche Code, der bei der Ausführung des cXtension-Befehls ausgeführt werden soll
!StartDas Skript wurde gestartet - Platz für Initialisierungen
!StoppDas Skript wurde beendet - stoppt die Ausführung in der cXtension

 

 

::Objekt_StartInitialisierung des Objekts, die beim Laden der cXtension aufgerufen wird. Hier können allgemeine Vorbereitungen ausgeführt werden
::Objekt_StoppAufräumfunktion, die beim Beenden der cXtension aufgerufen wird
::Objekt_FesteEigenschaftenHier können mehrere Eigenschaften als Liste im Zurück-Befehl unter "Rückgabe" angegeben werden (z.B. !Beschreibung=xyz)

 

 

!Beschreibung  (optional)

Liefert eine Beschreibung der cXtension. Diese Beschreibung wird z.B. in der Befehlsliste neben dem Befehl bzw. im Hilfefenster angezeigt, wenn der Befehl markiert ist.

 

::  Muster_!Beschreibung_Lesen

  ***  Beschreibung der Beispiel-cXtension

Zurück   (Ergebnis: 'Beispiel-Aufbau einer Beispiel-cXtension')

 

 

!Version  (optional)

Liefert die Version der cXtension. Diese Version wird z.B. in dem Dialog "PlugIn-/Erweiterungs-Info" angezeigt

 

::  Muster_!Version_Lesen

  ***  Version der Beispiel-cXtension

Zurück   (Ergebnis: '1.0.0')

 

 

!Registriert  (optional)

Ist diese Eigenschaft implementiert, kann durch Rückgabe von 0 die cXtension als unregistriert bzw. bei 1 als registriert definiert werden. Dies wirkt sich ebenso aus wie bei den anderen PlugIns in click.EXE.

 

::  Muster_!Registriert_Lesen

  ***  Beispiel-cXtension ist registriert

Zurück   (Ergebnis: '1')

 

 

!Registrierung  (optional)

Unter Registrierung kommt der Code, der zum registrieren der cXtension erfordelich ist (z.B. Registrierdialog etc.). Es kann hierfür auch per [Editor.RegistrierungsDialog(n)] der click.EXE-Dialog für die Eingabe der Lizenznummer aufgerufen werden, dessen Ergebnis dann selbst ausgewertet werden muss.

 

::  Muster_!Registrierung_Lesen

  ***  Beispiel-cXtension registrieren

Zurück

 

 

!Variablen  (optional)

Liefert die Variablen, die zur Steuerung der cXtension benötigt werden.Diese Variablen werden im folgenden Format angegeben:

Variable=Beschreibung (z.B. Test=liefert eine Zahl). Mehrere Variablen können auch als mehrzeilige Liste angegeben werden.Die so erstellten Variablen tauchen dann in der Variablenauswahl unter der Kategorie "cXtensions-Eigenschaften" auf und können dann wie gewohnt benutzt werden.

 

::  Muster_!Variablen_Lesen

  ***  Variablen der Beispiel-cXtension

Zurück   (Ergebnis: 'Test=liefert eine Zahl')

 

Hinweis: Die Variablen [cXtensionName.Autor] (Name des Autors) und [cXtensionName.RegNummer] (bei der Zertifizierung zugewiesen) sind erforderlich bei einer Zertifizierung der cXtension

 

 

!Ereignisse  (optional)

Liefert die Ereignisse der cXtension. Diese werden ebenfalls im Format "Text=Beschreibung" angegeben. In diesem Fall entspricht Text dem Namen des Ereignisses. Diese definierten Ereignisse werden dann auch im Marken-Dialog angeboten.(z.B. ::Muster_Test)

 

::  Muster_!Ereignisse_Lesen

  ***  Ereignisse der Beispiel-cXtension

Zurück   (Ergebnis: 'Muster_Klick=Ereignis bei Klick'')

 

 

!Hilfedatei  (optional)

Setzt die Hilfedatei (z.B. Test.chm) für die cXtension. Diese Hilfedatei steht dann mit F1 zur Verfügung.

 

::  Muster_!Hilfedatei_Lesen

  ***  Hilfedatei der Beispiel-cXtension

Zurück   (Ergebnis: 'Muster.chm')

 

 

!Ressourcen  (optional)

Liefert die Ressourcen, die für die cXtensionen bestimmt sind (z.B. Bilder etc.). Diese Ressourcen tauchen dann im Hauptskript in den Ressourcen auf. Die EIgenschaft wird für jede Befehlszeile mit dem cXtension-Befehl aufgerufen, wobei in den Befehlsparametern die jeweiligen Parameter enthalten sind. Aus diesen muss die cXtension selbst herausfinden, ob hier Dateinamen für die Einbindung enthalten sind.

 

::  Muster_!Resourcen_Lesen

  ***  Ressourcen der Beispiel-cXtension

Zurück   (Ergebnis: 'Bild1.jpg')

 

 

!Darstellung  (optional)

Hier wird definiert, wie der neue Befehl der cXtension im Skript mit seinen Eigenschaften aussehen soll.

Hinweise:

Die Platzhalter, die mit "Befehlsparameter." beginnen, sind von click.EXE vorgegeben und erleichtern die Verwaltung der Parameter für den Befehl. Bei  cXtensionen, die ein Element im Fenster darstellen sollen, sind dabei einige Variablen einzubauen, damit dies auch mit dem Dialog-Designer zusammenarbeiten kann.
Beginnt der zurückgelieferte Text mit ==, wo wird der Rest als Befehlsanzeige verwendet, ohne dass das Schlüsselwort davor gesetzt wird.

 

::  Muster_!Darstellung_Lesen

  ***  Darstellung der Beispiel-cXtension

Zurück   (Ergebnis: 'X=[Befehlsparameter X], Y=[Befehlsparameter.Y], Farbe=[Farbe]')

 

 

!Dialog  (optional)

In diesem Ereignis wird der Dialog dargestellt, in dem ein hinzugefügter Befehl bearbeitet werden kann. Dieser Dialog muss modal angezeigt werden, damit das Ergebnis erst zurückgeliefert wird, wenn die Bearbeitung abgeschlossen ist. Als Ein- und Ausgabeparameter wird hierbei üblicherweise [Befehlsparameter.X] verwendet.

 

::  Muster_!Dialog_Lesen

  ***  Bearbeitung der Beispiel-cXtension

  Aufbau und Verwaltung des (modalen) Dialogs

Zurück

 

 

!Designerbild  (optional)

Mit Designerbild wird angegeben, welches Symbol die cXtension im Dialog-Designer haben soll (Bilddateiname oder Bildquelle). Nur wenn dieses angegeben wurde, erkennt click.EXE die cXtension als designbaren Befehl an, der ein Element im Anzeigefenster darstellen kann.

 

::  Muster_!Designerbild_Lesen

  ***  Designerbild der Beispiel-cXtension

Zurück   (Ergebnis: '%ICON%')

 

 

!Ausführen  (optional)

Unter Ausführung kommt der Code, der beim Ausführen des Befehls abgearbeitet werden soll. Die Befehlsparameter enthalten die jeweiligen Parameter des Befehls.

 

::  Muster_!Ausführen_Lesen

  ***  Ausführung der Beispiel-cXtension

Hier kommt der Code hin, der ausgeführt werden soll !

Zurück

 

 

Für die Initialisierung der cXtension können eine Initialisierungs- und eine Aufräumroutine verwendet werden, die beim Starten bzw. Beenden des Hauptskripts aufgerufen werden. Hier ein kleines Beispiel dazu :

 

::  Muster_!Start_Lesen

***  Initialisierungs-Routine für die cXtension

Hier kommt nun der Initialisierungscode hin, z.B. die Definition von Vorgabewerten

Zurück

 

::  Muster_!Stopp_Lesen

  ***  Aufräum-Routine für die cXtension

Hier kommt ein Aufräumskript hin

Zurück

 

 

Weiterhin gehört optional zum Aufbau einer cXtension eine Initialisierungs- und eine Aufräumroutine für das Objekt, die beim Laden der cXtension bzw. beim Beenden der EXE aufgerufen werden. Hier ein kleines Beispiel dazu :

 

::  Objekt(Muster)_Start

 

::  Muster_Start

  ***  Initialisierungs-Routine für das Objekt

Hier kommt nun der grundlegende Initialisierungscode hin

Zurück

 

::  Muster_Stopp

  ***  Aufräum-Routine für das Objekt

Hier kommt ein finales Aufräumskript hin

Zurück

 

::  Objekt(Muster)_Ende

 

 

 


cX-Webseite: http://www.clickexe.de