java.lang.ObjectField
com.aspose.words.FieldInclude
public class FieldInclude
Constructor Summary |
---|
FieldInclude()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getBookmarkName() | |
void | setBookmarkName(java.lang.String value) | |
Gets or sets the name of the bookmark in the document to include. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
boolean | getLockFields() | |
void | setLockFields(boolean value) | |
Gets or sets whether to prevent fields in the included document from being updated. | ||
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. | ||
java.lang.String | getSourceFullName() | |
void | setSourceFullName(java.lang.String value) | |
Gets or sets the location of the document. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
java.lang.String | getTextConverter() | |
void | setTextConverter(java.lang.String value) | |
Gets or sets the name of the text converter for the format of the included file. | ||
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 | getBookmarkName() | |
Reserved for internal use. | ||
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). | ||
boolean | getLockFields() | |
Reserved for internal use. | ||
java.lang.String | getNamespaceMappings() | |
Reserved for internal use. | ||
java.lang.String | getSourceFullName() | |
Reserved for internal use. | ||
int | getSourceFullNameArgumentIndex() | |
Reserved for internal use. | ||
aspose.obfuscated.type | getSwitchType(java.lang.String switchName) | |
Reserved for internal use. | ||
java.lang.String | getXPath() | |
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 FieldInclude()
Property Getters/Setters Detail |
---|
getBookmarkName/setBookmarkName | |
public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value) |
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
getLockFields/setLockFields | |
public boolean getLockFields() / public void setLockFields(boolean 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() |
getSourceFullName/setSourceFullName | |
public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value) |
getStart | → inherited from Field |
public FieldStart getStart() |
getTextConverter/setTextConverter | |
public java.lang.String getTextConverter() / public void setTextConverter(java.lang.String value) |
getType | → inherited from Field |
public int getType() |
Method Detail |
---|
getBookmarkName | |
public java.lang.String getBookmarkName() |
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.
getLockFields | |
public boolean getLockFields() |
getNamespaceMappings | |
public java.lang.String getNamespaceMappings() |
getSourceFullName | |
public java.lang.String getSourceFullName() |
getSourceFullNameArgumentIndex | |
public int getSourceFullNameArgumentIndex() |
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
getXPath | |
public java.lang.String getXPath() |
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.