Aspose::Words::Fields::FieldGoToButton::get_DisplayText method

FieldGoToButton::get_DisplayText method

Gets or sets the text of the “button” that appears in the document, such that it can be selected to activate the jump.

System::String Aspose::Words::Fields::FieldGoToButton::get_DisplayText()

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::ExplicitCast<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");

See Also

Aspose::Words::Fields::FieldGoToButton::Type method Aspose::Words::Fields::FieldGoToButton::get_Location method