Aspose::Words::Fields::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

MethodDescription
get_Address()Gets a location where this hyperlink jumps.
get_DisplayResult()Gets the text that represents the displayed field result.
get_End() constGets the node that represents the field end.
get_FieldEnd() constGets the node that represents the field end.
get_FieldStart() constGets 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 whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsImageMap()Gets 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 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 the ScreenTip text for the hyperlink.
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.
get_SubAddress()Gets a location in the file, such as a bookmark, where this hyperlink jumps.
get_Target()Gets the target to which the link should be redirected.
virtual get_Type() constGets 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&)Sets a location where this hyperlink jumps.
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_IsImageMap(bool)Sets whether to append coordinates to the hyperlink for a server-side image map.
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)Sets whether to open the destination site in a new web browser window.
set_Result(const System::String&)Setter for Aspose::Words::Fields::Field::get_Result.
set_ScreenTip(const System::String&)Sets the ScreenTip text for the hyperlink.
set_SubAddress(const System::String&)Sets a location in the file, such as a bookmark, where this hyperlink jumps.
set_Target(const System::String&)Sets the target to which the link should be redirected.
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.

See Also