Aspose::Words::Fields::FieldAsk Class Reference
Detailed Description
Implements the ASK field.
#include <Aspose.Words.Cpp/Fields/FieldAsk.h>
Inheritance diagram for Aspose::Words::Fields::FieldAsk:
Public Member Functions | |
| String | get_BookmarkName () |
| Gets the name of the bookmark. More... | |
| String | get_DefaultResponse () |
| Gets default user response (initial value contained in the prompt window). More... | |
| bool | get_PromptOnceOnMailMerge () |
| Gets whether the user response should be recieved once per a mail merge operation. More... | |
| String | get_PromptText () |
| Gets the prompt text (the title of the prompt window). More... | |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_BookmarkName (const String &value) |
| Sets the name of the bookmark. More... | |
| void | set_DefaultResponse (const String &value) |
| Sets default user response (initial value contained in the prompt window). More... | |
| void | set_PromptOnceOnMailMerge (bool value) |
| Sets whether the user response should be recieved once per a mail merge operation. More... | |
| void | set_PromptText (const String &value) |
| Sets the prompt text (the title of the prompt window). More... | |
| Public Member Functions inherited from Field | |
| String | get_DisplayResult () |
| Gets the text that represents the displayed field result. More... | |
| SharedPtr< FieldEnd > | get_End () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldEnd > | get_FieldEnd () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldStart > | get_FieldStart () const |
| Gets the node that represents the start of the field. More... | |
| SharedPtr< FieldFormat > | get_Format () |
| Gets a FieldFormat object that provides typed access to field's formatting. More... | |
| bool | 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. More... | |
| bool | get_IsLocked () |
| Gets or sets whether the field is locked (should not recalculate its result). More... | |
| int32_t | get_LocaleId () |
| Gets or sets the LCID of the field. More... | |
| String | get_Result () |
| Gets or sets text that is between the field separator and field end. More... | |
| SharedPtr< FieldSeparator > | get_Separator () |
| Gets the node that represents the field separator. Can be null. More... | |
| SharedPtr< FieldStart > | get_Start () const |
| Gets the node that represents the start of the field. More... | |
| virtual FieldType | get_Type () const |
| Gets the Microsoft Word field type. More... | |
| String | 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. More... | |
| String | GetFieldCode (bool includeChildFieldCodes) |
| Returns text between field start and field separator (or field end if there is no separator). More... | |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| SharedPtr< Node > | 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. More... | |
| void | set_IsDirty (bool value) |
| Setter for get_IsDirty. More... | |
| void | set_IsLocked (bool value) |
| Setter for get_IsLocked. More... | |
| void | set_LocaleId (int32_t value) |
| Setter for get_LocaleId. More... | |
| void | set_Result (const String &value) |
| Setter for get_Result. More... | |
| bool | Unlink () |
| Performs the field unlink. More... | |
| void | Update () |
| Performs the field update. Throws if the field is being updated already. More... | |
| void | Update (bool ignoreMergeFormat) |
| Performs a field update. Throws if the field is being updated already. More... | |
Static Public Member Functions | |
| static const TypeInfo & | Type () |
| Static Public Member Functions inherited from Field | |
| static const TypeInfo & | Type () |
Member Function Documentation
◆ get_BookmarkName()
| System::String Aspose::Words::Fields::FieldAsk::get_BookmarkName | ( | ) |
Gets the name of the bookmark.
◆ get_DefaultResponse()
| System::String Aspose::Words::Fields::FieldAsk::get_DefaultResponse | ( | ) |
Gets default user response (initial value contained in the prompt window).
◆ get_PromptOnceOnMailMerge()
| bool Aspose::Words::Fields::FieldAsk::get_PromptOnceOnMailMerge | ( | ) |
Gets whether the user response should be recieved once per a mail merge operation.
◆ get_PromptText()
| System::String Aspose::Words::Fields::FieldAsk::get_PromptText | ( | ) |
Gets the prompt text (the title of the prompt window).
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_BookmarkName()
| void Aspose::Words::Fields::FieldAsk::set_BookmarkName | ( | const System::String & | value | ) |
Sets the name of the bookmark.
◆ set_DefaultResponse()
| void Aspose::Words::Fields::FieldAsk::set_DefaultResponse | ( | const System::String & | value | ) |
Sets default user response (initial value contained in the prompt window).
◆ set_PromptOnceOnMailMerge()
| void Aspose::Words::Fields::FieldAsk::set_PromptOnceOnMailMerge | ( | bool | value | ) |
Sets whether the user response should be recieved once per a mail merge operation.
◆ set_PromptText()
| void Aspose::Words::Fields::FieldAsk::set_PromptText | ( | const System::String & | value | ) |
Sets the prompt text (the title of the prompt window).
◆ Type()
|
static |