Aspose::Words::Fields::FieldAsk class

FieldAsk class

Implements the ASK field. To learn more, visit the Working with Fields documentation article.

class FieldAsk : public Field,
                 public IFieldCodeTokenInfoProvider

Methods

MethodDescription
get_BookmarkName()Gets the name of the bookmark.
get_DefaultResponse()Gets default user response (initial value contained in the prompt window).
get_PromptOnceOnMailMerge()Gets whether the user response should be recieved once per a mail merge operation.
get_PromptText()Gets the prompt text (the title of the prompt window).
set_BookmarkName(const System::String &)Sets the name of the bookmark.
set_DefaultResponse(const System::String &)Sets default user response (initial value contained in the prompt window).
set_PromptOnceOnMailMerge(bool)Sets whether the user response should be recieved once per a mail merge operation.
set_PromptText(const System::String &)Sets the prompt text (the title of the prompt window).
GetFieldCode()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.
GetFieldCode(bool)Returns text between field start and field separator (or field end if there is no separator).
virtual Remove()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.
Unlink()Performs the field unlink.
Update()Performs the field update. Throws if the field is being updated already.
Update(bool)Performs a field update. Throws if the field is being updated already.
get_DisplayResult()Gets the text that represents the displayed field result.
get_End() constGets the node that represents the field end.
get_Format()Gets a FieldFormat object that provides typed access to field’s formatting.
get_IsDirty()Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsLocked()Gets or sets whether the field is locked (should not recalculate its result).
get_LocaleId()Gets or sets the LCID of the field.
get_Result()Gets or sets text that is between the field separator and field end.
get_Separator()Gets the node that represents the field separator. Can be null.
get_Start() constGets the node that represents the start of the field.
virtual get_Type() constGets the Microsoft Word field type.
set_IsDirty(bool)Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
set_IsLocked(bool)Sets whether the field is locked (should not recalculate its result).
set_LocaleId(int32_t)Sets the LCID of the field.
set_Result(const System::String &)Sets text that is between the field separator and field end.

Remarks

Prompts the user to enter information and assigns a bookmark to represent the user’s response.

See Also