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

NameTypeAccessDescription
formatAttributesStringRead/WriteGets or sets which attributes of the format are to be applied to the table.
connectionStringRead/WriteGets or sets a connection to the data.
fileNameStringRead/WriteGets or sets the complete path and file name of the database
firstRecordStringRead/WriteGets or sets the integral record number of the first data record to insert.
insertHeadingsbooleanRead/WriteGets or sets whether to insert the field names from the database as column headings in the resulting table.
tableFormatStringRead/WriteGets or sets the format that is to be applied to the result of the database query.
insertOnceOnMailMergebooleanRead/WriteGets or sets whether to insert data at the beginning of a merge.
queryStringRead/WriteGets or sets a set of SQL instructions that query the database.
lastRecordStringRead/WriteGets or sets the integral record number of the last data record to insert.
fieldCodeStringReadReturns text between field start and field separator (or field end if there is no separator).
startFieldStartReadGets the node that represents the start of the field.
separatorFieldSeparatorReadGets the node that represents the field separator.
endFieldEndReadGets the node that represents the field end.
typeintReadGets the type.
resultStringRead/WriteGets or sets text that is between the field separator and field end.
displayResultStringReadGets the text that represents the displayed field result.
lockedbooleanRead/WriteGets or sets whether the field is locked (should not recalculate its result).
dirtybooleanRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
formatFieldFormatReadGets a FieldFormat object that provides typed access to field’s formatting.
localeIdintRead/WriteGets or sets the LCID of the field.

Methods

SignatureDescription
getFormatAttributes() → StringGets or sets which attributes of the format are to be applied to the table.
setFormatAttributes(value: String)Sets the format attributes value.
getConnection() → StringGets or sets a connection to the data.
setConnection(value: String)Sets the connection value.
getFileName() → StringGets or sets the complete path and file name of the database
setFileName(value: String)Sets the file name value.
getFirstRecord() → StringGets or sets the integral record number of the first data record to insert.
setFirstRecord(value: String)Sets the first record value.
getInsertHeadings() → booleanGets 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() → StringGets 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() → booleanGets or sets whether to insert data at the beginning of a merge.
setInsertOnceOnMailMerge(value: boolean)Sets the insert once on mail merge value.
getQuery() → StringGets or sets a set of SQL instructions that query the database.
setQuery(value: String)Sets the query value.
getLastRecord() → StringGets or sets the integral record number of the last data record to insert.
setLastRecord(value: String)Sets the last record value.
getFieldCode() → StringReturns text between field start and field separator (or field end if there is no separator).
getFieldCode(includeChildFieldCodes: boolean) → StringReturns text between field start and field separator (or field end if there is no separator).
remove() → NodeRemoves the field from the document.
update()Performs the field update.
update(ignoreMergeFormat: boolean)Performs a field update.
unlink() → booleanPerforms the field unlink.
getStart() → FieldStartGets the node that represents the start of the field.
getSeparator() → FieldSeparatorGets the node that represents the field separator.
getEnd() → FieldEndGets the node that represents the field end.
getType() → intReturns the type.
getResult() → StringGets or sets text that is between the field separator and field end.
setResult(value: String)Sets the result value.
getDisplayResult() → StringGets the text that represents the displayed field result.
isLocked() → booleanGets or sets whether the field is locked (should not recalculate its result).
isLocked(value: boolean)Calls isLocked(value) on this FieldDatabase instance.
isDirty() → booleanGets 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() → FieldFormatGets a FieldFormat object that provides typed access to field’s formatting.
getLocaleId() → intGets or sets the LCID of the field.
setLocaleId(value: int)Sets the locale id value.

See Also