FieldDatabase
Overview
FieldDatabase is a class in Aspose.Words FOSS for .NET.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the DATABASE field.
This class provides 4 methods for working with FieldDatabase objects in .NET programs.
Available methods include: GetFieldCode, Remove, Unlink, Update.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: Connection, DisplayResult, End, FileName, FirstRecord, Format, and 13 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
FormatAttributes | string | Read/Write | Gets or sets which attributes of the format are to be applied to the table. |
Connection | string | Read/Write | Gets or sets a connection to the data. |
FileName | string | Read/Write | Gets or sets the complete path and file name of the database |
FirstRecord | string | Read/Write | Gets or sets the integral record number of the first data record to insert. |
InsertHeadings | bool | Read/Write | Gets or sets whether to insert the field names from the database as column headings in the resulting table. |
TableFormat | string | Read/Write | Gets or sets the format that is to be applied to the result of the database query. |
InsertOnceOnMailMerge | bool | Read/Write | Gets or sets whether to insert data at the beginning of a merge. |
Query | string | Read/Write | Gets or sets a set of SQL instructions that query the database. |
LastRecord | string | Read/Write | Gets or sets the integral record number of the last data record to insert. |
Start | FieldStart | Read | Gets the node that represents the start of the field. |
Separator | FieldSeparator | Read | Gets the node that represents the field separator. |
End | FieldEnd | Read | Gets the node that represents the field end. |
Type | FieldType | Read | Gets the Microsoft Word field type. |
Result | string | Read/Write | Gets or sets text that is between the field separator and field end. |
DisplayResult | string | Read | Gets the text that represents the displayed field result. |
IsLocked | bool | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
IsDirty | bool | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
Format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
LocaleId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
GetFieldCode() | Returns text between field start and field separator (or field end if there is no separator). |
Remove() | Removes the field from the document. |
Update() | Performs the field update. |
Unlink() | Performs the field unlink. |