Aspose::Words::Fields::FieldHyperlink class
Contents
[
Hide
]FieldHyperlink class
Implements the HYPERLINK field To learn more, visit the Working with Fields documentation article.
class FieldHyperlink : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
public Aspose::Words::Fields::IFieldResultFormatProvider
Methods
| Method | Description |
|---|---|
| get_Address() | Gets or sets a location where this hyperlink jumps. |
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_End() const | Gets the node that represents the field end. |
| get_FieldEnd() const | Gets the node that represents the field end. |
| get_FieldStart() const | Gets the node that represents the start of the field. |
| 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_IsImageMap() | Gets or sets whether to append coordinates to the hyperlink for a server-side image map. |
| 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_OpenInNewWindow() | Gets or sets whether to open the destination site in a new web browser window. |
| get_Result() | Gets or sets text that is between the field separator and field end. |
| get_ScreenTip() | Gets or sets the ScreenTip text for the hyperlink. |
| get_Separator() | Gets the node that represents the field separator. Can be null. |
| get_Start() const | Gets the node that represents the start of the field. |
| get_SubAddress() | Gets or sets a location in the file, such as a bookmark, where this hyperlink jumps. |
| get_Target() | Gets or sets the target to which the link should be redirected. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| 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). |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| 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. |
| set_Address(const System::String&) | Setter for Aspose::Words::Fields::FieldHyperlink::get_Address. |
| set_IsDirty(bool) | Setter for Aspose::Words::Fields::Field::get_IsDirty. |
| set_IsImageMap(bool) | Setter for Aspose::Words::Fields::FieldHyperlink::get_IsImageMap. |
| set_IsLocked(bool) | Setter for Aspose::Words::Fields::Field::get_IsLocked. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_OpenInNewWindow(bool) | Setter for Aspose::Words::Fields::FieldHyperlink::get_OpenInNewWindow. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_ScreenTip(const System::String&) | Setter for Aspose::Words::Fields::FieldHyperlink::get_ScreenTip. |
| set_SubAddress(const System::String&) | Setter for Aspose::Words::Fields::FieldHyperlink::get_SubAddress. |
| set_Target(const System::String&) | Setter for Aspose::Words::Fields::FieldHyperlink::get_Target. |
| static Type() | |
| 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. |
Examples
Shows how to use HYPERLINK fields to link to documents in the local file system.
auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);
auto field = System::ExplicitCast<Aspose::Words::Fields::FieldHyperlink>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldHyperlink, true));
// When we click this HYPERLINK field in Microsoft Word,
// it will open the linked document and then place the cursor at the specified bookmark.
field->set_Address(get_MyDir() + u"Bookmarks.docx");
field->set_SubAddress(u"MyBookmark3");
field->set_ScreenTip(System::String(u"Open ") + field->get_Address() + u" on bookmark " + field->get_SubAddress() + u" in a new window");
builder->Writeln();
// When we click this HYPERLINK field in Microsoft Word,
// it will open the linked document, and automatically scroll down to the specified iframe.
field = System::ExplicitCast<Aspose::Words::Fields::FieldHyperlink>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldHyperlink, true));
field->set_Address(get_MyDir() + u"Iframes.html");
field->set_ScreenTip(System::String(u"Open ") + field->get_Address());
field->set_Target(u"iframe_3");
field->set_OpenInNewWindow(true);
field->set_IsImageMap(false);
doc->UpdateFields();
doc->Save(get_ArtifactsDir() + u"Field.HYPERLINK.docx");
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++