|
Aspose::Words::Fields::FieldGoToButton Class Reference
Implements the GOTOBUTTON field.
- Examples
Shows to insert a GOTOBUTTON field.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
// it will take the text cursor to the bookmark whose name the Location property references.
auto field = System::DynamicCast<FieldGoToButton>(builder->InsertField(FieldType::FieldGoToButton, true));
field->set_DisplayText(u"My Button");
field->set_Location(u"MyBookmark");
ASSERT_EQ(u" GOTOBUTTON MyBookmark My Button", field->GetFieldCode());
// Insert a valid bookmark for the field to reference.
builder->InsertBreak(BreakType::PageBreak);
builder->StartBookmark(field->get_Location());
builder->Writeln(u"Bookmark text contents.");
builder->EndBookmark(field->get_Location());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.GOTOBUTTON.docx");
#include <Aspose.Words.Cpp/Fields/FieldGoToButton.h>
Inheritance diagram for Aspose::Words::Fields::FieldGoToButton:
Public Member Functions | |
| String | get_DisplayText () |
| Gets or sets the text of the "button" that appears in the document, such that it can be selected to activate the jump. More... | |
| String | get_Location () |
| Gets or sets the name of a bookmark, a page number, or some other item to jump to. More... | |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_DisplayText (String value) |
| Setter for get_DisplayText. More... | |
| void | set_Location (String value) |
| Setter for get_Location. 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 () |
| 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... | |
| 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 (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_DisplayText()
| System::String Aspose::Words::Fields::FieldGoToButton::get_DisplayText | ( | ) |
Gets or sets the text of the "button" that appears in the document, such that it can be selected to activate the jump.
- Examples
Shows to insert a GOTOBUTTON field.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
// it will take the text cursor to the bookmark whose name the Location property references.
auto field = System::DynamicCast<FieldGoToButton>(builder->InsertField(FieldType::FieldGoToButton, true));
field->set_DisplayText(u"My Button");
field->set_Location(u"MyBookmark");
ASSERT_EQ(u" GOTOBUTTON MyBookmark My Button", field->GetFieldCode());
// Insert a valid bookmark for the field to reference.
builder->InsertBreak(BreakType::PageBreak);
builder->StartBookmark(field->get_Location());
builder->Writeln(u"Bookmark text contents.");
builder->EndBookmark(field->get_Location());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.GOTOBUTTON.docx");
◆ get_Location()
| System::String Aspose::Words::Fields::FieldGoToButton::get_Location | ( | ) |
Gets or sets the name of a bookmark, a page number, or some other item to jump to.
- Examples
Shows to insert a GOTOBUTTON field.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
// it will take the text cursor to the bookmark whose name the Location property references.
auto field = System::DynamicCast<FieldGoToButton>(builder->InsertField(FieldType::FieldGoToButton, true));
field->set_DisplayText(u"My Button");
field->set_Location(u"MyBookmark");
ASSERT_EQ(u" GOTOBUTTON MyBookmark My Button", field->GetFieldCode());
// Insert a valid bookmark for the field to reference.
builder->InsertBreak(BreakType::PageBreak);
builder->StartBookmark(field->get_Location());
builder->Writeln(u"Bookmark text contents.");
builder->EndBookmark(field->get_Location());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.GOTOBUTTON.docx");
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_DisplayText()
| void Aspose::Words::Fields::FieldGoToButton::set_DisplayText | ( | System::String | value | ) |
◆ set_Location()
| void Aspose::Words::Fields::FieldGoToButton::set_Location | ( | System::String | value | ) |
◆ Type()
|
static |