Parameterelemente für Felder

Mit Hilfe von Funktionselementen kann man auf Felder zugreifen. So kann man beispielsweise mit dem attribute-get-Element die Werte sämtlicher Feldparameter ermitteln. Um jedoch zu spezifizieren, welche Feldeigenschaften, ausgelesen oder gesetzt werden sollen, verwendet man Parameterelemente. Im Folgenden werden die Parameterelemente für Felder aufgeführt.

callback
Bedeutung: Ein Tcl-Script, das aufgerufen wird, nachdem dem Feld ein Wert zugewiesen wurde.

Definition:

<!ELEMENT callback (%cm.atom;)>
displayTitle
Bedeutung: Der in der HTML-Benutzerschnittstelle angezeigte Titel des Feldes (eine Kombination aus Titel und Namen).

Definition:

<!ELEMENT displayTitle (%cm.atom;)>
displayValueCallback
Bedeutung: Tcl-Script, das aufgerufen wird, um den Anzeigewert eines kundenspezifischen Feldes zu berechnen.

Definition:

<!ELEMENT displayValueCallback (%cm.atom;)>
editField
Bedeutung: Definition des bei Wertzuweisung zu dem Feld zu verwendenden Eingabefeldes.

Definition:

<!ELEMENT editField (%cm.atom;)>
<!ATTLIST editField
          parameter (length |
                     maxlength |
                     nilAllowed |
                     objClasses |
                     rows |
                     startPub |
                     type |
                     wizard) CDATA #REQUIRED
>

Bedeutung der Attribute:

  • length: Die angezeigte Länge eines Feldes (als Parameter verfügbar nur bei textfield, passwordfield, textarea).
  • maxlength: Die maximale Länge des in ein Feld eingebbaren Textes (als Parameter verfügbar nur bei textfield und passwordfield).
  • nilAllowed: Gibt bei Eingabefeldern vom Typ multiselect und popup an, ob neben den Aufzählungswerten des Feldes auch der leere Wert ausgewählt werden kann.
  • objClasses: wenn type gleich linklistfield ist, beschränkt diese Liste (durch Leerzeichen separierter Vorlagennamen), die im Dateiauswahldialog auswählbaren Dateien (verfügbar ab Version 6.7.0).
  • rows: Die Anzahl der darzustellenden Zeilen des Feldes (als Parameter verfügbar nur bei textarea, multiselect, popup bis Version 6.0.x).
  • startPub: wenn type gleich linklistfield ist, legt dieser Wert den Pfad des für die Linkzielauswahl zu öffnenden Ordners fest (verfügbar ab Version 6.7.0).
  • type: Der Typ des Eingabefeldes. Folgende Typen sind verfügbar: textfield, passwordfield, textarea, multiselect, popup, radio, custom, html, checkbox, hidden, external, linklistfield (ab Version 6.5.0), wizard.
  • wizard: wenn type gleich wizard ist, legt dieser Wert den Namen des Assistenten fest, der zur Erfassung des Feldwertes verwendet werden soll.

Beispiel:

<cm-request...>
  <attribute-where>
    <name>fruit</name>
  </attribute-where>
  <attribute-get>
    <editfield parameter="type"/>
  </attribute-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <attribute>
      <editfield parameter="type">multiselect</editfield>
    </attribute>
  </cm-code>
</cm-response>
editFieldSpec
Bedeutung: Liefert die vollständige Spezifikation des Eingabefeldes - enthält auch Feldnamen und Aufzählungswerte.

Definition:

<!ELEMENT editFieldSpec (%cm.atom;
 | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom;
 | listitem | dictitem)*>
getKeys
Bedeutung: Liste der mit attribute-get abfragbaren Parameter.

Definition:

<!ELEMENT getKeys (listitem)*>
<!ELEMENT listitem (%cm.atom;
 | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom;
 | listitem | dictitem)*>
helpText
Bedeutung: Beschreibung des Feldes.

Definition:

<!ELEMENT helpText (%cm.atom;)>
<!ATTLIST helpText
          lang (en | de | it | fr | es) #IMPLIED
>

Bedeutung der Attribute:

  • lang: Kennzeichnet die Sprache einer Feldbeschreibung. Zu Dimensionen von Werten im CMS siehe Dimensionen von Werten.

Beispiel:

<cm-request...>
  <attribute-where>
    <name>fruit</name>
  </attribute-where>
  <attribute-get>
    <helpText lang="en"/>
  </attribute-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <attribute-get>
      <helpText lang="en">summer fruit</helpText>
    </attribute-get>
  </cm-code>
</cm-response>
isSearchableInCM
Bedeutung: Gibt an, ob die Werte des Feldes bei laufendem Search Engine Server im Content Manager durchsucht werden können.

Definition:

<!ELEMENT isSearchableInCM (%cm.atom;)>
isSearchableInTE
Bedeutung: Gibt an, ob die Werte des Feldes bei laufendem Search Engine Server auf dem Live-Server durchsucht werden können.

Definition:

<!ELEMENT isSearchableInTE (%cm.atom;)>
localizedTitle
Bedeutung: Der Titel in der Sprache, die der authentifizierte Benutzer eingestellt hat. Ist dieser leer, wird title zurückgegeben. Ist auch dieser Titel leer, wird name zurückgegeben.

Definition:

<!ELEMENT localizedTitle (%cm.atom;)>
localizedHelpText
Bedeutung: Die Feldbeschreibung in der Sprache, die der authentifizierte Benutzer eingestellt hat. Ist diese leer, wird helpText zurückgegeben. Ist auch diese leer, so wird nichts zurückgegeben.

Definition:

<!ELEMENT localizedHelpText (%cm.atom;)>
maxSize
Bedeutung: Bei Feldern vom Typ linklist die maximale Anzahl Links, die in der Linkliste enthalten sein darf (ab Version 6.7.0).

Definition:

<!ELEMENT maxSize (%cm.atom;)>
minSize
Bedeutung: Bei Feldern vom Typ linklist die minimale Anzahl Links, die in der Linkliste enthalten sein muss (ab Version 6.7.0).

Definition:

<!ELEMENT minSize (%cm.atom;)>
name
Bedeutung: Der Name des Feldes.

Definition:

<!ELEMENT name (%cm.atom;)>
setKeys
Bedeutung: Liste der mitattribute-set setzbaren Parameter.

Definition:

<!ELEMENT setKeys (listitem)*>
<!ELEMENT listitem (%cm.atom;
 | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom;
 | listitem | dictitem)*>
title
Bedeutung: Der Titel des Feldes.

Definition:

<!ELEMENT title (%cm.atom;)>
<!ATTLIST title
          lang (en | de | it | fr | es) #IMPLIED
>

Bedeutung der Attribute:

  • lang: Kennzeichnet die Sprache des Feldtitels. Zu Dimensionen von Werten im CMS siehe Dimensionen von Werten.

Beispiel:

<cm-request...>
  <attribute-where>
    <name>fruit</name>
  </attribute-where>
  <attribute-get>
    <title lang="en"/>
  </attribute-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <attribute-get>
      <title lang="en">fruits and berries</title>
    </attribute-get>
  </cm-code>
</cm-response>
type
Bedeutung: Typ des Feldes (zulässig: string(voreingestellt), date, enum, html, multienum, signature, text).

Definition:

<!ELEMENT type (%cm.atom;)>
validEditFieldKeys
Bedeutung: Liste der möglichen Parameternamen in der Eingabefelddefinition (abhängig vom Eingabefeldtyp).

Definition:

<!ELEMENT validEditFieldKeys (listitem)*>

<!ELEMENT listitem (%cm.atom;
 | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom;
 | listitem | dictitem)*>
validEditFieldTypes
Bedeutung: Liste der möglichen Eingabefeldtypen (abhängig vom Feldtyp).

Definition:

<!ELEMENT validEditFieldTypes (listitem)*>
<!ELEMENT listitem (%cm.atom;
 | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom;
 | listitem | dictitem)*>
values
Bedeutung: Aufzählungswerte (nur bei enum- und multienum-Feldern).

Definition:

<!ELEMENT values (listitem)*>
<!ELEMENT listitem (%cm.atom;
 | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom;
 | listitem | dictitem)*>
wantedTags
Bedeutung: Liste der im Feldwert erlaubten HTML-Tags (nur bei Feldern vom Typ html).

Definition:

<!ELEMENT wantedTags (listitem)*>
<!ELEMENT listitem (%cm.atom;
 | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom;
 | listitem | dictitem)*>