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
| Name | Type | Access | Description |
|---|---|---|---|
progId | String | Read/Write | Gets or sets the application type of the link information. |
sourceFullName | String | Read/Write | Gets or sets the name and location of the source file. |
sourceItem | String | Read/Write | Gets or sets the portion of the source file that’s being linked. |
insertAsBitmap | boolean | Read/Write | Gets or sets whether to insert the linked object as a bitmap. |
linked | boolean | Read/Write | Gets or sets whether to reduce the file size by not storing graphics data with the document. |
insertAsHtml | boolean | Read/Write | Gets or sets whether to insert the linked object as HTML format text. |
insertAsPicture | boolean | Read/Write | Gets or sets whether to insert the linked object as a picture. |
insertAsRtf | boolean | Read/Write | Gets or sets whether to insert the linked object in rich-text format (RTF). |
insertAsText | boolean | Read/Write | Gets or sets whether to insert the linked object in text-only format. |
insertAsUnicode | boolean | Read/Write | Gets or sets whether to insert the linked object as Unicode text. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
start | FieldStart | Read | Gets the node that represents the start of the field. |
separator | FieldSeparator | Read | Gets the node that represents the field separator. |
end | FieldEnd | Read | Gets the node that represents the field end. |
type | int | Read | Gets the type. |
result | String | Read/Write | Gets or sets text that is between the field separator and field end. |
displayResult | String | Read | Gets the text that represents the displayed field result. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
localeId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
getProgId() → String | Gets or sets the application type of the link information. |
setProgId(value: String) | Sets the prog id value. |
getSourceFullName() → String | Gets or sets the name and location of the source file. |
setSourceFullName(value: String) | Sets the source full name value. |
getSourceItem() → String | Gets or sets the portion of the source file that’s being linked. |
setSourceItem(value: String) | Sets the source item value. |
getInsertAsBitmap() → boolean | Gets or sets whether to insert the linked object as a bitmap. |
setInsertAsBitmap(value: boolean) | Sets the insert as bitmap value. |
isLinked() → boolean | Gets 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() → boolean | Gets or sets whether to insert the linked object as HTML format text. |
setInsertAsHtml(value: boolean) | Sets the insert as html value. |
getInsertAsPicture() → boolean | Gets or sets whether to insert the linked object as a picture. |
setInsertAsPicture(value: boolean) | Sets the insert as picture value. |
getInsertAsRtf() → boolean | Gets or sets whether to insert the linked object in rich-text format (RTF). |
setInsertAsRtf(value: boolean) | Sets the insert as rtf value. |
getInsertAsText() → boolean | Gets or sets whether to insert the linked object in text-only format. |
setInsertAsText(value: boolean) | Sets the insert as text value. |
getInsertAsUnicode() → boolean | Gets or sets whether to insert the linked object as Unicode text. |
setInsertAsUnicode(value: boolean) | Sets the insert as unicode value. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getType() → int | Returns the type. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldDdeAuto instance. |
isDirty() → boolean | Gets 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() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |