FieldAsk

Overview

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

Implements the ASK 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 FieldAsk objects in Java programs. Available methods include: getBookmarkName, getDefaultResponse, getDisplayResult, getEnd, getFieldCode, getFormat, getLocaleId, getPromptOnceOnMailMerge, getPromptText, getResult, getSeparator, getStart, and 12 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bookmarkName, defaultResponse, dirty, displayResult, end, fieldCode, and 9 more.

Properties

NameTypeAccessDescription
bookmarkNameStringRead/WriteGets or sets the name of the bookmark.
promptTextStringRead/WriteGets or sets the prompt text (the title of the prompt window).
defaultResponseStringRead/WriteGets or sets default user response (initial value contained in the prompt window).
promptOnceOnMailMergebooleanRead/WriteGets or sets whether the user response should be recieved once per a mail merge operation.
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
getBookmarkName() → StringGets or sets the name of the bookmark.
setBookmarkName(value: String)Sets the bookmark name value.
getPromptText() → StringGets or sets the prompt text (the title of the prompt window).
setPromptText(value: String)Sets the prompt text value.
getDefaultResponse() → StringGets or sets default user response (initial value contained in the prompt window).
setDefaultResponse(value: String)Sets the default response value.
getPromptOnceOnMailMerge() → booleanGets or sets whether the user response should be recieved once per a mail merge operation.
setPromptOnceOnMailMerge(value: boolean)Sets the prompt once on mail merge 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 FieldAsk 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 FieldAsk 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