FieldDatabase class
FieldDatabase class
Implements the DATABASE field. To learn more, visit the Working with Fields documentation article.
Remarks
Inserts the results of a database query into a WordprocessingML table.
Inheritance: FieldDatabase → Field
Constructors
| Name | Description |
|---|---|
| FieldDatabase() | The default constructor. |
Properties
| Name | Description |
|---|---|
| connection | Gets or sets a connection to the data. |
| display_result | Gets the text that represents the displayed field result. (Inherited from Field) |
| end | Gets the node that represents the field end. (Inherited from Field) |
| file_name | Gets or sets the complete path and file name of the database |
| first_record | Gets or sets the integral record number of the first data record to insert. |
| format | Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field) |
| format_attributes | Gets or sets which attributes of the format are to be applied to the table. |
| insert_headings | Gets or sets whether to insert the field names from the database as column headings in the resulting table. |
| insert_once_on_mail_merge | Gets or sets whether to insert data at the beginning of a merge. |
| is_dirty | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field) |
| is_locked | Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field) |
| last_record | Gets or sets the integral record number of the last data record to insert. |
| locale_id | Gets or sets the LCID of the field. (Inherited from Field) |
| query | Gets or sets a set of SQL instructions that query the database. |
| result | Gets or sets text that is between the field separator and field end. (Inherited from Field) |
| separator | Gets the node that represents the field separator. Can be None.(Inherited from Field) |
| start | Gets the node that represents the start of the field. (Inherited from Field) |
| table_format | Gets or sets the format that is to be applied to the result of the database query. |
| type | Gets the Microsoft Word field type. (Inherited from Field) |
Methods
| Name | Description |
|---|---|
| get_field_code() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. (Inherited from Field) |
| get_field_code(include_child_field_codes) | Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field) |
| remove() | Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns None.(Inherited from Field) |
| unlink() | Performs the field unlink. (Inherited from Field) |
| update() | Performs the field update. Throws if the field is being updated already. (Inherited from Field) |
| update(ignore_merge_format) | Performs a field update. Throws if the field is being updated already. (Inherited from Field) |
See Also
- module aspose.words.fields
- class Field