Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

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

...


In addition to the current configuration options from the Document Parameter, there are options for configuration that are no longer recommended in this way, but for which backward compatibility still works. The corresponding deprecated configuration possibilities are listed on this page.


Changes at a glance

CustomDataNodes (Fields)

Code Block
breakoutModewide
languagexml
<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):

...

With and without views

Without views (legacy)

Configuration

Code Block
languagexml
<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="

...

Example dialog" />
      
      <CustomDataNode xsi:type="TextNode" Id="DocParam.Subject" Row="1" Column="1" ColumnSpan="3" Label="

...

Subject" />
      
      <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>Birthday</string></Value></Item>
          <Item><Key><string>employeeanniversary</string></Key> <Value><string>Employee 

...

anniversary</string></Value></Item>
          <Item><Key><string>motherfatherhood</string></Key> 

...

<Value><string>Mother-/

...

Fatherhood</string></Value></Item>
        </ListItems>
      </CustomDataNode>
      
    </DataNodes>
  </CustomContentSection>
</Configuration>

Mit Views (alt):

...

Dialog

Image Added

With views (default)

Configuration

Code Block
languagexml
<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>Birthday</string></Value></Item>
          <Item><Key><string>employee anniversary</string></Key> <Value><string>Employee 

...

anniversary</string></Value></Item>
          <Item><Key><string>mother-/fatherhood</string></Key> 

...

<Value><string>Mother-/

...

Fatherhood</string></Value></Item>
        </ListItems>
      </CustomDataNode>
      
    </DataNodes>
  </CustomContentSection>
  <Views>
    <View Id="main" Label="

...

Homepage">
      <Row>
        <TextBlock Style="h1" ColumnSpan="4"

...

>Sample dialog</TextBlock>
      </Row>
      <Row>
        <Separator ColumnSpan="4" />
      </Row>
      <Row>
        <Label Content="

...

Subject" />
        <TextBox Id="DocParam.Subject" ColumnSpan="3" />
      </Row>
      <Row>
        <Label Content="

...

Date" />
        <DatePicker Id="DocParam.DateOfWriting" />
      </Row>
      <Row>
        <CheckBox Id="DocParam.IsConfidential" Label="

...

Confidential" ColumnOffset="1" ColumnSpan="3" />
      </Row>
      <Row>
        <Label Content="

...

Reason for congratulation" />
        <ComboBox Id="DocParam.ReasonForCongratulation" />
      </Row>
      <Button Type="Submit" Label="OK" IsDefault="true" />
      <Button Type="Cancel" Label="

...

Cancel" />
    </View>
  </Views>
</Configuration>

...

Dialog

Image Added

Usage of "CustomDataNode"

...

with "xsi:type"

...

Basic structure of a CustomDataNode:

Code Block
languagexml
  <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.

Note

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

...

These three attributes must be present in any case, regardless of the type, otherwise the CustomDataNode will not work properly.

CustomDataNode basic attributes

These attributes apply to use with and without views.

Warning

WARNING
The configurations on this page are deprecated and should no longer be used.
There is a more compact and structured configuration type. See this page.

Name

Description

Type (xsi:type)

TextNode

...

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.

...

Inserted in Word as plain text content control, for single or multiline text input, check via regex possible

DateTimeNode
Inserts in Word as date picker content control with calendar selection and is also shown in the document parameter as such.

CheckBoxNode
Inserted in Word as a check box content control (CheckBox Content Control) and is for a yes/no selection.

ComboBoxNode
Inserted in Word as a combo box content control (Combo Box Content Control),

...

also called a dropdown. It is for choosing between given values (any input is allowed in Word).

RadioButton

...

There are no RadioButton content controls in Word, that's why there is no RadioButton DataNode in OneOffixx. Instead, the TextNode or the ComboBoxNode are used as DataNode:


Definition of a RadioButton with a TextNode
Here, the RadioButton is stored in the TextNode. This option is suitable if the value is used in scripts or extended bindings. If a RadioButton is to be preselected, the Value of the corresponding RadioButton must be configured as the default text. So in the example below, the RadioButton is now preselected with "man".
<CustomDataNode xsi:type="TextNode" Id="DocParam.

...

RBGender">1</Text>" LCID="2055">1</CustomDataNode>{:.language-xml}

Definition

...

of a RadioButton with a ComboBoxNode
In

...

this case, the RadioButton is stored in the ComboBoxNode element. The Value in the ComboBox must correspond to the Value in the RadioButton in the view. This option is suitable if the value is to be output in the document, since the display in the document is controlled by the Value of the ComboBoxNode entry. If a RadioButton should be preselected, the Value of the corresponding RadioButton must be configured in the SelectedValue attribute of the ComboBoxNode.
<CustomDataNode xsi:type="ComboBoxNode" Id="DocParam.

...

RBGender" LCID="2055" SelectedValue="1">...</CustomDataNode>

...

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

...

How the RadioButtons are then defined in the view is described in the corresponding chapter.

Note

Without views RadioButtons cannot be defined.

LabelNode

Heading in document parameter dialog when views are not used, not suitable for use in editor, scripts and extended bindings

Id

Textual Id, which must be unique. This is displayed in editor mode and then needed for use in editor, scripts or extended bindings. The Id must not contain any spaces.
If an Id is duplicated (NOT in the view, but in the CustomDataNodes), then the documents parameter dialog can not be opened.

DateFormat

Attribute that is only allowed for DateTimeNodes; definition of the date format e. g. "dd MM yyyy"

...

for "02.06.2016".

...

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)

...

List of date formats There are several date formats stored in the Global Translations base configuration that can be accessed.

IsNowDefault

Attribute that is only allowed for DateTimeNodes. It sets the initial date to the current date.

Calendar

Attribute which is only valid for DateTimeNodes. It sets the format of the calendar. Default is "Gregor". It is not mandatory to set this attribute.

Required

Attribute that is only allowed for TextNodes. It defines whether the field may be left empty (Required="false" or not set) or whether the field must be filled in (Required="true").

...

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.

...

As long as the text field is not filled in, the OK button for confirming the input in the document parameter remains grayed out and unclickable. As soon as the required characters are filled in the text field, the OK button can be clicked.
The Required attribute is overridden by the validation (regex attribute) if one is set.

Regex

Attribute, which is only allowed for TextNodes. It allows to define a regex (.NET syntax) that must find at least one match in the entered text. Attention: if the whole text must match or there must be exactly one 'match', this must be defined by the regex expression.

Examples
Regex="[0-9]+"

...

forces that at least one character of the input text must be a digit. For example, "Hello 205" is a valid input.

Regex="^[0-9]+$"

...

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"

...

forces that all characters of the input text must be digits and that at least one digit must be present. (^ matches the beginning of the input text and $ matches the end)
Online tool to create regex

ValidationMessage

Attribute, which is only allowed for TextNodes. If Required="true" or a validation regex is set, ValidationMessage allows a custom error message if validation fails. It will be displayed when the mouse pointer hovers over the red exclamation mark on the right side of the text field. If ValidationMessage is not set, a default message will be displayed in case of a mismatch.

Tracked

The primedocs function Quick Check (check content controls) is activated with the 'Tracked' attribute. If the value is set to 'true', the field will be displayed to the user in the separate panel. Provided that the content of the element is empty, the field will be displayed red in the panel and green after editing.

Label

Label the element in the Quick Check panel in Word. The Tracked attribute is a prerequisite.

SelectedValue

Attribute that is only allowed for ComboBoxNodes. This attribute determines which option in the list should be selected by default.

IsChecked

Attribute which is only valid for CheckBoxNodes. This attribute determines whether the CheckBox should be checked or unchecked by default.

Locked

Has no effect. Was originally intended to prevent the content control from being deleted in Word.

ReadOnly

Has no effect. Was originally intended to prevent the content control from being edited in Word.

LCID

The LCID (locale identifiers) define the language culture of the corresponding DataNode. If the LCID is not set, the DataNode will not work. List of LCID codes


Configurations without "Views"

Basic configuration without using Views:

Code Block
languagexml
<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

...

 elements 

...

are 

...

defined 

...

here -->
    </DataNodes>
  </CustomContentSection>
</Configuration>

CustomDataNode

...

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

Note

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)

...

additional attributes without views

These attributes are only valid for use without views.

Warning

WARNING
The configurations on this page are deprecated and should no longer be used.
There is a more compact and structured configuration type. See this page.

Name

Description

Row

Row in which the element is to be displayed in the document parameter dialog.

Column

Column in which the element is to be displayed in the document parameter dialog (starting point). There are 4 columns with the Label column.

ColumnSpan (Length)

Length respectively number of columns the element should span.

Label

Label of the element in the document parameter dialog; also applies to headings of the type LabelNode. If several elements are displayed in one line, the label of the first element is used. The label always appears in the leftmost column. If Tracked is set to true, the label also acts as the element's caption in the Quick Check panel.

Visible

If Visible is set to false, the document parameter will not be displayed in the dialog.

ToolTip (Hint)

Hint that is displayed when the user hovers over it with the mouse. Overridden by ValidationMessage if it is set.

IsInputEnabled

Attribute only allowed for elements of type CheckBoxNode. If this option is set to true, checkboxes are displayed in the document parameter dialog where the user can edit or freely select the caption.

MultiLine

Attribute only allowed for elements of type TextNode. Creates multiline text fields if set to true.

MultilineRows (Number of displayed rows for multiline)

Attribute only allowed for elements of type TextNode (incl. Multiline="true")

...

. Defines the number of displayed rows in multiline text fields (defaults to 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)

...

(Enable search for combo boxes)

Attribute only allowed for elements of type ComboBoxNode. This option determines whether keyboard input can be used to search for existing entries in the combo box.

IsEditable (Allow any input for combo box)

Attribute only allowed for elements of type ComboBoxNode. This option determines whether the user can make any input. If this attribute is not set to true the user can only choose between the existing entries.