FieldDdeAuto

Overview

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

Implements the DDEAUTO field.

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

This class declares 40 methods for FieldDdeAuto objects in Java programs. Available methods include: getDisplayResult, getEnd, getFieldCode, getFormat, getInsertAsBitmap, getInsertAsHtml, getInsertAsPicture, getInsertAsRtf, getInsertAsText, getInsertAsUnicode, getLocaleId, getProgId, and 23 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: dirty, displayResult, end, fieldCode, format, insertAsBitmap, and 15 more.

Properties

NameTypeAccessDescription
progIdStringRead/WriteGets or sets the application type of the link information.
sourceFullNameStringRead/WriteGets or sets the name and location of the source file.
sourceItemStringRead/WriteGets or sets the portion of the source file that’s being linked.
insertAsBitmapbooleanRead/WriteGets or sets whether to insert the linked object as a bitmap.
linkedbooleanRead/WriteGets or sets whether to reduce the file size by not storing graphics data with the document.
insertAsHtmlbooleanRead/WriteGets or sets whether to insert the linked object as HTML format text.
insertAsPicturebooleanRead/WriteGets or sets whether to insert the linked object as a picture.
insertAsRtfbooleanRead/WriteGets or sets whether to insert the linked object in rich-text format (RTF).
insertAsTextbooleanRead/WriteGets or sets whether to insert the linked object in text-only format.
insertAsUnicodebooleanRead/WriteGets or sets whether to insert the linked object as Unicode text.
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
getProgId() → StringGets or sets the application type of the link information.
setProgId(value: String)Sets the prog id value.
getSourceFullName() → StringGets or sets the name and location of the source file.
setSourceFullName(value: String)Sets the source full name value.
getSourceItem() → StringGets or sets the portion of the source file that’s being linked.
setSourceItem(value: String)Sets the source item value.
getInsertAsBitmap() → booleanGets or sets whether to insert the linked object as a bitmap.
setInsertAsBitmap(value: boolean)Sets the insert as bitmap value.
isLinked() → booleanGets or sets whether to reduce the file size by not storing graphics data with the document.
isLinked(value: boolean)Calls isLinked(value) on this FieldDdeAuto instance.
getInsertAsHtml() → booleanGets or sets whether to insert the linked object as HTML format text.
setInsertAsHtml(value: boolean)Sets the insert as html value.
getInsertAsPicture() → booleanGets or sets whether to insert the linked object as a picture.
setInsertAsPicture(value: boolean)Sets the insert as picture value.
getInsertAsRtf() → booleanGets or sets whether to insert the linked object in rich-text format (RTF).
setInsertAsRtf(value: boolean)Sets the insert as rtf value.
getInsertAsText() → booleanGets or sets whether to insert the linked object in text-only format.
setInsertAsText(value: boolean)Sets the insert as text value.
getInsertAsUnicode() → booleanGets or sets whether to insert the linked object as Unicode text.
setInsertAsUnicode(value: boolean)Sets the insert as unicode 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 FieldDdeAuto 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 FieldDdeAuto 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