Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Index Data Reader "MsWord"

The purpose of the index data reader "MsWord" is to extract content of a file attachment of the type "Microsoft Word document." A special syntax applies to the .InputName property in the form of a value composed of several parameters. This value the element to be read out.

The first parameter is always named ElemType and specifies the element type. Depending on the element type, some other parameters are available to specify the element.

Element

Parameter

Entire document content

  1. ElemType*: Document

Number of pages

  1. ElemType*: PageCount

Page

  1. ElemType*: Page

  2. Number: page number (default value: 1)

Paragraph

  1. ElemType*: Paragraph

  2. Number: paragraph number (default value: 1)

Bookmark

  1. ElemType*: Bookmark

  2. Number: number of the bookmark (default value: 1)

  3. Name: name of the bookmark

Form field

  1. ElemType*: FormField

  2. Number: number of the form field (default value: 1)

  3. Name: name of the form field

Control

  1. ElemType*: ContentControl

  2. Number: number of the control (default value: 1)

  3. Name: name of the control

Text box

  1. ElemType*: TextBox

  2. Number: number of the text box (default value: 1)

  3. Name: name of the text box

Embedded custom XML file or a node in XML node

  1. ElemType*: CustomXml

  2. Number: number of the XML elements box (default value: 1)

  3. Name: name of the XML element

  4. Node: XPath expression if the node content is to be read instead of the entire XML element

Table

  1. ElemType*: Table

  2. Number: number of the table (default value: 1)

  3. ColNumber: number of the column (default value: 1)

Document property

  1. ElemType*: Property

  2. PropName*: document property name (Title, Subject, Author, LastAuthor, Keywords, Comments, TimeCreated, TimeLastSaved, Company)

    An unknown name is read as a user-defined property.

For example, a full value of the .InputName property for reading a table column might look like the following:

ElemType: Table, Number: 1, ColNumber: 2

With abbreviated form without parameter names, the value would look like this:

Table, 1, 2

The parameters Number and Name can be used alternatively: the elements in question can be identified either by their number (starting at 1) or by their name. When reading a table column, multiple values may be returned. If the target is a header data field and the ProcessReadIndex[].ReadMultiValues property is enabled, an array of the scalar values by cell will be assigned to it. In the process, empty cell values are filtered out automatically. If the target is a table field, on the other hand, a corresponding row in the target table will be generated for each table row read.

In this section: