Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »


Neben den aktuellen Konfigurationsmöglichkeiten vom Dokument-Parameter gibt es Möglichkeiten zur Konfiguration, die so nicht mehr empfohlen sind, aber für welche die Rückwärtskompatibilität weiterhin funktioniert. Die entsprechend veralteten Konfigurationsmöglichkeiten sind auf dieser Seite aufgeführt.


Änderungen auf einen Blick

CustomDataNodes (Felder):

<Configuration>
  <CustomContentSection [...]>
    <DataNodes>
      
      <!-- ## Text ## -->
      <CustomDataNode xsi:type="TextNode" Id="DocParam.BeispielText" [...]>[...]</CustomDataNode>
      <!-- NEU ↓ -->
      <Text Id="DocParam.BeispielText" [...]>[...]</Text>
      
      <!-- ## CheckBox ## -->
      <CustomDataNode xsi:type="CheckBoxNode" Id="DocParam.BeispielCheckBox" IsChecked="true" [...] />
      <!-- NEU ↓ -->
      <CheckBox Id="DocParam.BeispielCheckBox" [...]>true</CheckBox>
      
      <!-- ## DateTime ## -->
      <CustomDataNode xsi:type="DateTimeNode" Id="DocParam.BeispielDateTime" DateFormat="dddd, d. MM. yyyy" IsNowDefault="true" [...]>
        <DateTime>2016-07-31</DateTime>
      </CustomDataNode>
      <!-- NEU ↓ -->
      <DateTime Id="DocParam.BeispielDateTime" Format="dddd, d. MM. yyyy" [...]>2018-12-31</DateTime>
      
      <!-- ## ComboBox ## -->
      <CustomDataNode xsi:type="ComboBoxNode" Id="DocParam.BeispielComboBox" SelectedValue="aKey" [...]>
        <ListItems>
          <Item><Key><string>empty</string></Key> <Value><string><![CDATA[ ]]></string></Value></Item>
          <Item><Key><string>aKey</string></Key> <Value><string>A-Anzeigetext</string></Value></Item>
          <Item><Key><string>aKey</string></Key> <Value><string>A-Anzeigetext</string></Value></Item>
          <Item><Key><string>bKey</string></Key> <Value><string>B-Anzeigetext</string></Value></Item>
        </ListItems>
      </CustomDataNode>
      <!-- NEU ↓ -->
      <ComboBox Id="DocParam.BeispielComboBox" SelectedValue="empty" [...]>
        <Item Value="empty" DisplayText=" "  />
        <Item Value="aKey" DisplayText="A-Anzeigetext" />
        <Item Value="bKey" DisplayText="B-Anzeigetext" />
      </ComboBox>
      
    </DataNodes>
  </CustomContentSection>
  [...]
</Configuration>

Mit und ohne Views:

Ohne Views (alt):

Konfiguration

<Configuration>
  <CustomContentSection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Name="Dokument-Parameter" WindowWidth="750" WindowHeight="350">
    <DataNodes>
      
      <CustomDataNode xsi:type="LabelNode" Id="DocParam.TitleLabel" Row="0" Column="0" ColumnSpan="4" Label="Beispieldialog" />
      
      <CustomDataNode xsi:type="TextNode" Id="DocParam.Subject" Row="1" Column="1" ColumnSpan="3" Label="Betreff" />
      
      <CustomDataNode xsi:type="DateTimeNode" Id="DocParam.DateOfWriting" DateFormat="d. MMMM yyyy" IsNowDefault="true" Label="Datum" Row="2" Column="1" />
      
      <CustomDataNode xsi:type="CheckBoxNode" Id="DocParam.IsConfidential" Label="Vertraulich" Row="3" Column="1" ColumnSpan="3" />
      
      <CustomDataNode xsi:type="ComboBoxNode" Id="DocParam.ReasonForCongratulation" SelectedValue="employeeanniversary" Label="Gratulationsgrund" Row="4" Column="1">
        <ListItems>
          <Item><Key><string>birthday</string></Key> <Value><string>Geburtstag</string></Value></Item>
          <Item><Key><string>employeeanniversary</string></Key> <Value><string>Mitarbeiterjubiläum</string></Value></Item>
          <Item><Key><string>motherfatherhood</string></Key> <Value><string>Mutter-/Vaterschaft</string></Value></Item>
        </ListItems>
      </CustomDataNode>
      
    </DataNodes>
  </CustomContentSection>
</Configuration>

Mit Views (alt):

<Configuration>
  <CustomContentSection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Name="Dokument-Parameter" WindowWidth="750" WindowHeight="400">
    <DataNodes>
      
      <CustomDataNode xsi:type="TextNode" Id="DocParam.Subject" />
      
      <CustomDataNode xsi:type="DateTimeNode" Id="DocParam.DateOfWriting" DateFormat="d. MMMM yyyy" IsNowDefault="true" />
      
      <CustomDataNode xsi:type="CheckBoxNode" Id="DocParam.IsConfidential" />
      
      <CustomDataNode xsi:type="ComboBoxNode" Id="DocParam.ReasonForCongratulation" SelectedValue="employee anniversary">
        <ListItems>
          <Item><Key><string>birthday</string></Key> <Value><string>Geburtstag</string></Value></Item>
          <Item><Key><string>employee anniversary</string></Key> <Value><string>Mitarbeiterjubiläum</string></Value></Item>
          <Item><Key><string>mother-/fatherhood</string></Key> <Value><string>Mutter-/Vaterschaft</string></Value></Item>
        </ListItems>
      </CustomDataNode>
      
    </DataNodes>
  </CustomContentSection>
  <Views>
    <View Id="main" Label="Startseite">
      <Row>
        <TextBlock Style="h1" ColumnSpan="4">Beispieldialog</TextBlock>
      </Row>
      <Row>
        <Separator ColumnSpan="4" />
      </Row>
      <Row>
        <Label Content="Betreff" />
        <TextBox Id="DocParam.Subject" ColumnSpan="3" />
      </Row>
      <Row>
        <Label Content="Datum" />
        <DatePicker Id="DocParam.DateOfWriting" />
      </Row>
      <Row>
        <CheckBox Id="DocParam.IsConfidential" Label="Vertraulich" ColumnOffset="1" ColumnSpan="3" />
      </Row>
      <Row>
        <Label Content="Gratulationsgrund" />
        <ComboBox Id="DocParam.ReasonForCongratulation" />
      </Row>
      <Button Type="Submit" Label="OK" IsDefault="true" />
      <Button Type="Cancel" Label="Abbrechen" />
    </View>
  </Views>
</Configuration>


Verwendung von "CustomDataNode" mit "xsi:type"

Grundgerüst eines CustomDataNodes:

  <CustomDataNode xsi:type="" Id="" LCID=""></CustomDataNode>

Diese drei Attribute müssen unabhängig vom Typ auf jeden Fall vorhanden sein, ansonsten wird der CustomDataNode nicht richtig funktionieren.

CustomDataNode-Basisattribute

Diese Attribute gelten für die Verwendung mit und ohne Views.

WICHTIG
Die Konfigurationen auf dieser Seite sind veraltet und sollten nicht mehr verwendet werden. Sie werden jedoch weiterhin unterstützt.
Es gibt eine kompaktere und strukturiertere Konfigurationsart. Siehe diese Seite.

Name

Beschreibung

Type (xsi:type)

TextNode
Wird in Word als Nur-Text-Inhaltssteuerelement (Plain Text Content Control) eingefügt, für ein- oder mehrzeilige Text-Eingabe, Überprüfung via Regex möglich

DateTimeNode
Wird in Word zu einem Datumsauswahl-Inhaltssteuerelement (Date Picker Content Control) mit Kalenderauswahl und wird auch im Dokument-Parameter so angezeigt.

CheckBoxNode
Wird in Word als Kontrollkästchensteuerelement (CheckBox Content Control) eingefügt und ist für eine ja/nein-Auswahl.

ComboBoxNode
Wird in Word als Kombinationsfeld-Inhaltssteuerelement (Combo Box Content Control), auch Dropdown genannt, eingefügt. Es ist für die Auswahl zwischen vorgegebenen Werten (es sind beliebige Eingaben in Word zulässig).

RadioButton
In Word gibt es keine RadioButton-Inhaltssteuerelemente, deswegen gibt es auch kein RadioButton-DataNode in primedocs. Als DataNode werden stattdessen der TextNode oder der ComboBoxNode verwendet:

Definition eines RadioButtons mit einem TextNode
Hier wird der RadioButton im TextNode gespeichert. Diese Variante ist geeignet, wenn der Wert in Skripten oder Extended Bindings verwendet wird. Falls ein RadioButton vorausgewählt sein soll, muss der Value des entsprechenden RadioButtons als Standard-Text konfiguriert werden. Im Beispiel unten ist also jetzt der RadioButton mit "Mann" vorausgewählt.
<CustomDataNode xsi:type="TextNode" Id="DocParam.RBGeschlecht">1</Text>" LCID="2055">1</CustomDataNode>{:.language-xml}

Definition eines RadioButtons mit einem ComboBoxNode
In diesem Fall wird der RadioButton im ComboBoxNode-Element gespeichert. Der Value in der ComboBox muss dabei der Value im RadioButton in der View entsprechen. Diese Variante ist geeignet, wenn der Wert im Dokument ausgegeben werden soll, da die Anzeige im Dokument über den Value des ComboBoxNode-Eintrags gesteuert wird. Falls ein RadioButton vorausgewählt sein soll, muss der Value des entsprechenden RadioButtons im SelectedValue-Attribut der ComboBoxNode konfiguriert werden.
<CustomDataNode xsi:type="ComboBoxNode" Id="DocParam.RBGeschlecht" LCID="2055" SelectedValue="1">...</CustomDataNode>{:.language-xml}

Wie die RadioButtons dann in der View definiert werden, wird im entsprechenden Kapitel beschrieben.

__Ohne Views können keine RadioButtons definiert werden

__LabelNode
Überschrift im Dokument-Parameter-Dialog wenn Views nicht verwendet werden, nicht für die Verwendung im Editor, in Skripten und in Extended Bindings geeignet

Id (Identifikation)

Textuelle Id, welche eindeutig sein muss. Diese wird im Editormodus angezeigt und danach für die Verwendung im Editor, in Skripten oder in Extended Bindings benötigt. Die Id darf keine Leerzeichen enthalten.
Wenn eine Id Doppelt vorhanden ist (NICHT in der View, sondern in den CustomDataNodes), dann kann der Dokumente-Parameter-Dialog nicht geöffnet werden.

DateFormat

Attribut, das nur für DateTimeNodes zulässig ist; Definition des Datumformates z. B. "dd MM yyyy" für "02.06.2016". Liste mit Datumsformaten In der Basis-Konfiguration der Globalen Übersetzungen sind mehrere Datumsformate hinterlegt, auf die zugegriffen werden kann.

IsNowDefault

Attribut, das nur für DateTimeNodes zulässig ist. Es setzt das initiale Datum auf das aktuelle Tagesdatum.

Calendar

Attribut, das nur für DateTimeNodes zulässig ist. Es setzt das Format des Kalenders. Default ist "Gregor". Dieses Attribut muss nicht zwingend gesetzt werden.

Required (benötigtes Feld)

Attribut, das nur für TextNodes zulässig ist. Es definiert, ob das Feld leer gelassen werden darf (Required="false" oder nicht gesetzt) oder ob das Feld ausgefüllt werden muss (Required="true"). Solange das Textfeld nicht ausgefüllt wird, bleibt der OK-Button zum Bestätigen der Eingaben im Dokument-Parameter grau gefärbt und nicht anklickbar. Sobald die nötigen Zeichen im Textfeld abgefüllt sind, kann der OK-Button angeklickt werden.
Das Required-Attribut wird von der Validierung (Regex-Attribut) übersteuert, falls eine gesetzt wird.

Regex (Validierung)

Attribut, das nur für TextNodes zulässig ist. Es erlaubt, einen Regex (.NET Syntax) zu definieren, der im eingegeben Text mindestens eine Übereinstimmung (Match) finden muss. Achtung: Falls der ganze Text übereinstimmen oder nur genau ein 'Match' vorhanden sein darf, muss dies vom Regex-Ausdruck definiert werden.

Beispiele
Regex="[0-9]+" erzwingt, dass mindestens ein Zeichen des Eingabetexts eine Ziffer sein muss. "Hallo 205" ist so beispielsweise eine gültige Eingabe.

Regex="^[0-9]+$" erzwingt, dass alle Zeichen des Eingabetexts Ziffern sein müssen und dass mindestens eine Ziffer vorhanden sein muss. (^ matcht den Anfang des Eingabetextes und $ das Ende)
Online Tool zum erstellen von Regex

ValidationMessage (Fehlermeldung)

Attribut, das nur für TextNodes zulässig ist. Falls Required="true" oder ein Validierungs-Regex gesetzt wurde, erlaubt ValidationMessage eine benutzerdefinierte Fehlermeldung, falls die Validierung fehlschlägt. Sie wird angezeigt, sobald der Mauszeiger über das rote Ausrufezeichen rechts im Textfeld schwebt. Falls ValidationMessage nicht gesetzt ist, wird im Fall einer Nichtübereinstimmung eine Standardmeldung angezeigt.

Tracked (Überwachung mit "Quick Check")

Die primedocs-Funktion Quick Check (Inhaltssteuerelemente prüfen) wird mit dem Attribut 'Tracked' aktiviert. Ist der Wert auf 'true' gesetzt, wird dem Benutzer im separaten Panel das Feld angezeigt. Sofern der Inhalt des Elementes leer ist, wird das Feld im Panel rot und nach der Bearbeitung grün angezeigt.

Label (Beschriftung)

Beschriftung des Elements im Quick Check-Panel in Word. Das Tracked-Attribut ist Voraussetzung.

SelectedValue (Ausgewählter Eintrag)

Attribut, das nur für ComboBoxNodes zulässig ist. Über dieses Attribut wird bestimmt, welche Option in der Liste standardmässig selektiert sein soll.

IsChecked (Standard-Selektion)

Attribut, das nur für CheckBoxNodes zulässig ist. Über dieses Attribut wird bestimmt, ob die CheckBox standardmässig aktiviert oder deaktiviert sein soll.

Locked (Sperrung)

Hat keine Wirkung. War ursprünglich dafür vorgesehen, dass das Inhaltssteuerelement in Word nicht gelöscht werden kann.

ReadOnly (nur Leserecht)

Hat keine Wirkung. War ursprünglich dafür vorgesehen, dass der Inhalt des Inhaltssteuerelements in Word nicht bearbeitet werden kann.

LCID

Die LCID (locale identifiers) definieren die Sprachkultur des entsprechenden DataNodes. Wenn die LCID nicht gesetzt ist, funktioniert das DataNode nicht. Liste mit den LCID-Codes


Konfigurationen ohne "Views"

Grundgerüst ohne Verwendung von Views:

<Configuration>
  <CustomContentSection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Name="Dokument-Parameter" WindowWidth="750" WindowHeight="750">
    <DataNodes>
      <!-- DataNode-Elemente werden hier definiert -->
    </DataNodes>
  </CustomContentSection>
</Configuration>

CustomDataNode-Zusatzattribute ohne Views

Diese Attribute gelten nur für die Verwendung ohne Views.

WICHTIG
Die Konfigurationen auf dieser Seite sind veraltet und sollten nicht mehr verwendet werden. Sie werden aber weiterhin unterstützt.
Es gibt eine kompaktere und strukturiertere Konfigurationsart. Siehe diese Seite.

Name

Beschreibung

Row (Zeile)

Zeile, in welcher das Element im Dokument-Parameter-Dialog angezeigt werden soll.

Column (Spalte)

Spalte, in welcher das Element im Dokument-Parameter-Dialog angezeigt werden soll (Startpunkt). Es sind mit der Label-Spalte 4 Spalten vorhanden.

ColumnSpan (Länge)

Länge respektive Anzahl Spalten, über welche sich das Element erstrecken soll.

Label (Beschriftung)

Beschriftung des Elements im Dokument-Parameter-Dialog; gilt auch für Überschriften des Typs LabelNode. Sofern mehrere Elemente in einer Zeile dargestellt werden, wird die Beschriftung des ersten Elements übernommen. Die Beschriftung erscheint immer in der Spalte ganz links. Wenn Tracked auf true gesetzt ist fungiert das Label zusätzlich als Beschriftung des Elements im Quick Check-Panel.

Visible (Sichtbarkeit)

Wenn die Sichtbarkeit auf false gesetzt ist, wird der Dokument-Parameter im Dialog nicht angezeigt.

ToolTip (Hinweis)

Hinweis, der angezeigt wird, wenn der Benutzer mit der Maus darüber fährt. Wird von ValidationMessage überschrieben, falls diese gesetzt ist.

IsInputEnabled

(Beschriftung editierbar)

Attribut nur für Elemente des Typs CheckBoxNode zulässig. Wenn diese Option auf "true" gesetzt ist, werden im Dokument-Parameter-Dialog Kontrollkästchen angezeigt, bei welchen der Benutzer die Beschriftung editieren resp. frei wählen kann.

MultiLine (Mehrzeiligkeit)

Attribut nur für Elemente des Typs Textfelder (TextNode) zulässig. Erstellt mehrzeilige Textfelder wenn auf true gesetzt.

MultilineRows

(Anzahl angezeigter Zeilen bei Mehrzeiligkeit)

Attribut nur für Elemente des Typs TextNode (inkl. Multiline="true") zulässig. Definiert die Anzahl angezeigter Zeilen in mehrzeiligen Textfelder (standardmässig auf 3).

IsSearchEnabled

(Suche für Kombinationsfelder aktivieren)

Attribut nur für Elemente des Typs Kombinationsfeld (ComboBoxNode) zulässig. Über diese Option wird bestimmt ob Mittels Tastatureingabe im Kombinationsfeld nach vorhandenen Einträgen gesucht werden kann.

IsEditable

(bei Kombinationsfeld beliebige Eingabe zulassen)

Attribut nur für Elemente des Typs Kombinationsfeld (ComboBoxNode) zulässig. Über diese Option wird bestimmt, ob der Benutzer eine beliebige Eingabe tätigen kann. Wenn dieses Attribut nicht auf true gesetzt ist kann der Benutzer nur zwischen den vorhandenen Einträgen auswählen.

  • No labels