FieldInclude

Overview

FieldInclude is a class in Aspose.Words FOSS for Java. Inherits from: Field, IFieldCodeTokenInfoProvider, IFieldIncludeTextCode.

Implements the INCLUDE field.

Edition status of its 39 listed members (a property and its accessor methods are listed separately, overloads once): 39 not yet exercised by a verified example.

This class declares 28 methods for FieldInclude objects in Java programs. Available methods include: getBookmarkName, getDisplayResult, getEnd, getFieldCode, getFormat, getLocaleId, getLockFields, getResult, getSeparator, getSourceFullName, getStart, getTextConverter, and 12 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bookmarkName, dirty, displayResult, end, fieldCode, format, and 9 more.

Properties

NameTypeAccessDescription
sourceFullNameStringRead/WriteGets or sets the location of the document.
bookmarkNameStringRead/WriteGets or sets the name of the bookmark in the document to include.
lockFieldsbooleanRead/WriteGets or sets whether to prevent fields in the included document from being updated.
textConverterStringRead/WriteGets or sets the name of the text converter for the format of the included file.
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
getSourceFullName() → StringGets or sets the location of the document.
setSourceFullName(value: String)Sets the source full name value.
getBookmarkName() → StringGets or sets the name of the bookmark in the document to include.
setBookmarkName(value: String)Sets the bookmark name value.
getLockFields() → booleanGets or sets whether to prevent fields in the included document from being updated.
setLockFields(value: boolean)Sets the lock fields value.
getTextConverter() → StringGets or sets the name of the text converter for the format of the included file.
setTextConverter(value: String)Sets the text converter 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 FieldInclude 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 FieldInclude 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