java.lang.ObjectField
com.aspose.words.FieldDatabase
public class FieldDatabase
Constructor Summary |
---|
FieldDatabase()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getConnection() | |
void | setConnection(java.lang.String value) | |
Gets or sets a connection to the data. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
java.lang.String | getFileName() | |
void | setFileName(java.lang.String value) | |
Gets or sets the complete path and file name of the database | ||
java.lang.String | getFirstRecord() | |
void | setFirstRecord(java.lang.String value) | |
Gets or sets the integral record number of the first data record to insert. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
java.lang.String | getFormatAttributes() | |
void | setFormatAttributes(java.lang.String value) | |
Gets or sets which attributes of the format are to be applied to the table. | ||
boolean | getInsertHeadings() | |
void | setInsertHeadings(boolean value) | |
Gets or sets whether to insert the field names from the database as column headings in the resulting table. | ||
boolean | getInsertOnceOnMailMerge() | |
void | setInsertOnceOnMailMerge(boolean value) | |
Gets or sets whether to insert data at the beginning of a merge. | ||
boolean | isDirty() | → inherited from Field |
void | isDirty(boolean value) | |
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | ||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
java.lang.String | getLastRecord() | |
void | setLastRecord(java.lang.String value) | |
Gets or sets the integral record number of the last data record to insert. | ||
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
Gets or sets the LCID of the field. | ||
java.lang.String | getQuery() | |
void | setQuery(java.lang.String value) | |
Gets or sets a set of SQL instructions that query the database. | ||
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
Gets or sets text that is between the field separator and field end. | ||
FieldSeparator | getSeparator() | → inherited from Field |
Gets the node that represents the field separator. Can be null. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
java.lang.String | getTableFormat() | |
void | setTableFormat(java.lang.String value) | |
Gets or sets the format that is to be applied to the result of the database query. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. |
Method Summary | ||
---|---|---|
java.lang.String | getFieldCode() | → inherited from Field |
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. | ||
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator). | ||
aspose.obfuscated.type | getSwitchType(java.lang.String switchName) | |
Reserved for internal use. | ||
Aspose.Words.Node | remove() | → inherited from Field |
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 null. | ||
boolean | unlink() | → inherited from Field |
Performs the field unlink. | ||
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already. | ||
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already. |
Constructor Detail |
---|
public FieldDatabase()
Property Getters/Setters Detail |
---|
getConnection/setConnection | |
public java.lang.String getConnection() / public void setConnection(java.lang.String value) |
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getFileName/setFileName | |
public java.lang.String getFileName() / public void setFileName(java.lang.String value) |
getFirstRecord/setFirstRecord | |
public java.lang.String getFirstRecord() / public void setFirstRecord(java.lang.String value) |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
getFormatAttributes/setFormatAttributes | |
public java.lang.String getFormatAttributes() / public void setFormatAttributes(java.lang.String value) |
getInsertHeadings/setInsertHeadings | |
public boolean getInsertHeadings() / public void setInsertHeadings(boolean value) |
getInsertOnceOnMailMerge/setInsertOnceOnMailMerge | |
public boolean getInsertOnceOnMailMerge() / public void setInsertOnceOnMailMerge(boolean value) |
isDirty/isDirty | → inherited from Field |
public boolean isDirty() / public void isDirty(boolean value) |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getLastRecord/setLastRecord | |
public java.lang.String getLastRecord() / public void setLastRecord(java.lang.String value) |
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
getQuery/setQuery | |
public java.lang.String getQuery() / public void setQuery(java.lang.String value) |
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
getStart | → inherited from Field |
public FieldStart getStart() |
getTableFormat/setTableFormat | |
public java.lang.String getTableFormat() / public void setTableFormat(java.lang.String value) |
getType | → inherited from Field |
public int getType() |
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
includeChildFieldCodes
- True
if child field codes should be included.
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
remove | → inherited from Field |
public Aspose.Words.Node remove() throws java.lang.Exception |
unlink | → inherited from Field |
public boolean unlink() throws java.lang.Exception |
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True
if the field has been unlinked, otherwise false
.
update | → inherited from Field |
public void update() throws java.lang.Exception |
update | → inherited from Field |
public void update(boolean ignoreMergeFormat) throws java.lang.Exception |
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.