FieldDatabase
Overview
FieldDatabase is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the DATABASE field.
Edition status of its 54 listed members (a property and its accessor methods are listed separately, overloads once): 54 not yet exercised by a verified example.
This class declares 38 methods for FieldDatabase objects in Java programs.
Available methods include: getConnection, getDisplayResult, getEnd, getFieldCode, getFileName, getFirstRecord, getFormat, getFormatAttributes, getInsertHeadings, getInsertOnceOnMailMerge, getLastRecord, getLocaleId, and 22 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: connection, dirty, displayResult, end, fieldCode, fileName, and 14 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 | boolean | 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 | boolean | 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. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
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 | int | Read | Gets the 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. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | 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 |
|---|---|
getFormatAttributes() → String | Gets or sets which attributes of the format are to be applied to the table. |
setFormatAttributes(value: String) | Sets the format attributes value. |
getConnection() → String | Gets or sets a connection to the data. |
setConnection(value: String) | Sets the connection value. |
getFileName() → String | Gets or sets the complete path and file name of the database |
setFileName(value: String) | Sets the file name value. |
getFirstRecord() → String | Gets or sets the integral record number of the first data record to insert. |
setFirstRecord(value: String) | Sets the first record value. |
getInsertHeadings() → boolean | Gets or sets whether to insert the field names from the database as column headings in the resulting table. |
setInsertHeadings(value: boolean) | Sets the insert headings value. |
getTableFormat() → String | Gets or sets the format that is to be applied to the result of the database query. |
setTableFormat(value: String) | Sets the table format value. |
getInsertOnceOnMailMerge() → boolean | Gets or sets whether to insert data at the beginning of a merge. |
setInsertOnceOnMailMerge(value: boolean) | Sets the insert once on mail merge value. |
getQuery() → String | Gets or sets a set of SQL instructions that query the database. |
setQuery(value: String) | Sets the query value. |
getLastRecord() → String | Gets or sets the integral record number of the last data record to insert. |
setLastRecord(value: String) | Sets the last record value. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getType() → int | Returns the type. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldDatabase instance. |
isDirty() → boolean | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
isDirty(value: boolean) | Calls isDirty(value) on this FieldDatabase instance. |
getFormat() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |