GrapeCity.Documents.Word

GrapeCity.Documents.Word.Hyperlink

Class Hyperlink

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a hyperlink element in a body content.

public class Hyperlink : ContentObject, IBrowsable<Hyperlink>

Inheritance: object

ContentObject

Hyperlink

Implements: IBrowsable<Hyperlink>

Inherited Members: ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.Delete()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.ToString()

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Properties

Address

Gets or sets the address for the specified link. The address can be an e-mail address, an Internet address, or a file name.

public Uri Address { get; set; }

Property Value

System.Uri

Anchor

Gets or sets the name of a bookmark in the current or linked document which shall be the target of this hyperlink.

public string Anchor { get; set; }

Property Value

string

Location

Gets or sets a location in the target of the hyperlink.

public string Location { get; set; }

Property Value

string

Gets the next hyperlink.

public Hyperlink Next { get; }

Property Value

Hyperlink

Gets the previous hyperlink.

public Hyperlink Previous { get; }

Property Value

Hyperlink

ScreenTip

Gets or sets the text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.

public string ScreenTip { get; set; }

Property Value

string

Target

Gets or sets the name of the frame or window in which you want to load the specified hyperlink.

public string Target { get; set; }

Property Value

string

Viewed

Gets or sets whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked.

public bool Viewed { get; set; }

Property Value

bool

Methods

AddBidirectionalOverride()

Adds a BidirectionalOverride to the end of this hyperlink.

public BidirectionalOverride AddBidirectionalOverride()

Returns

BidirectionalOverride: The added BidirectionalOverride.

AddBidirectionalOverride(BiDirection)

Adds a BidirectionalOverride to the end of this hyperlink.

public BidirectionalOverride AddBidirectionalOverride(BiDirection direction)

Parameters

direction BiDirection: BidirectionalOverride direction value.

Returns

BidirectionalOverride: The added BidirectionalOverride.

AddComplexField(string, string)

Adds a ComplexField to the end of this hyperlink.

public ComplexField AddComplexField(string code, string result)

Parameters

code string: The complex field code.
result string: The result text of the inserted field.

Returns

ComplexField: The added ComplexField.

AddComplexField(string)

Adds a ComplexField to the end of this hyperlink.

public ComplexField AddComplexField(string code)

Parameters

code string: The complex field code.

Returns

ComplexField: The added ComplexField.

AddContentControl(ContentControlType, bool)

Adds a ContentControl to the end of this hyperlink.

public ContentControl AddContentControl(ContentControlType type, bool fillContent = true)

Parameters

type ContentControlType: The new content control type.
fillContent bool: Whether to fill the new control content with default data.

Returns

ContentControl: The added ContentControl.

AddEndnote(string, char, string)

Adds a Endnote to the end of this hyperlink.

public Endnote AddEndnote(string text, char referenceCharacter, string referenceFontName)

Parameters

text string: The endnote text.
referenceCharacter char: The endnote reference symbol.
referenceFontName string: The endnote reference symbol font.

Returns

Endnote: The added Endnote.

AddEndnote(string, string)

Adds a Endnote to the end of this hyperlink.

public Endnote AddEndnote(string text, string reference)

Parameters

text string: The endnote text.
reference string: The endnote reference text.

Returns

Endnote: The added Endnote.

AddEndnote(string)

Adds a Endnote to the end of this hyperlink.

public Endnote AddEndnote(string text = null)

Parameters

text string: The endnote text.

Returns

Endnote: The added Endnote.

AddFootnote(string, char, string)

Adds a Footnote to the end of this hyperlink.

public Footnote AddFootnote(string text, char referenceCharacter, string referenceFontName)

Parameters

text string: The footnote text.
referenceCharacter char: The footnote reference symbol.
referenceFontName string: The footnote reference symbol font.

Returns

Footnote: The added Footnote.

AddFootnote(string, string)

Adds a Footnote to the end of this hyperlink.

public Footnote AddFootnote(string text, string reference)

Parameters

text string: The footnote text.
reference string: The footnote reference text.

Returns

Footnote: The added Footnote.

AddFootnote(string)

Adds a Footnote to the end of this hyperlink.

public Footnote AddFootnote(string text = null)

Parameters

text string: The footnote text.

Returns

Footnote: The added Footnote.

AddHyperlink()

Adds a Hyperlink to the end of this hyperlink.

public Hyperlink AddHyperlink()

Returns

Hyperlink: The added Hyperlink.

AddHyperlink(string, string, string, string)

Adds a Hyperlink to the end of this hyperlink.

public Hyperlink AddHyperlink(string anchor, string text, string screenTip = null, string target = null)

Parameters

anchor string: The name of a bookmark in the current document which shall be the target of this hyperlink.
text string: The display text of the specified hyperlink.
screenTip string: The text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.
target string: The name of the frame or window in which you want to load the specified hyperlink.

Returns

Hyperlink: The added Hyperlink.

AddHyperlink(Uri, string, string, string, string)

Adds a Hyperlink to the end of this hyperlink.

public Hyperlink AddHyperlink(Uri address, string anchor, string text, string screenTip = null, string target = null)

Parameters

address System.Uri: The address for the specified link. The address can be an e-mail address, an Internet address, or a file name.
anchor string: The name of a bookmark in the current document which shall be the target of this hyperlink.
text string: The display text of the specified hyperlink.
screenTip string: The text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.
target string: The name of the frame or window in which you want to load the specified hyperlink.

Returns

Hyperlink: The added Hyperlink.

AddOMath()

Adds an OMath to the end of this hyperlink.

public OMath AddOMath()

Returns

OMath: The added OMath.

AddOMath(OMathBuiltInEquation)

Adds an OMath to the end of this hyperlink.

public OMath AddOMath(OMathBuiltInEquation equation)

Parameters

equation OMathBuiltInEquation: A built-in equation to fill the OMath.

Returns

OMath: The added OMath.

AddOMathParagraph()

Adds an OMathParagraph to the end of this hyperlink.

public OMathParagraph AddOMathParagraph()

Returns

OMathParagraph: The added OMathParagraph.

AddOMathParagraph(OMathBuiltInEquation)

Adds an OMathParagraph to the end of this hyperlink.

public OMathParagraph AddOMathParagraph(OMathBuiltInEquation equation)

Parameters

equation OMathBuiltInEquation: A built-in equation to fill the OMathParagraph.

Returns

OMathParagraph: The added OMathParagraph.

AddRun()

Adds a Run to the end of this hyperlink.

public Run AddRun()

Returns

Run: The added Run.

AddRun(Style)

Adds a Run to the end of this hyperlink.

public Run AddRun(Style style)

Parameters

style Style: The run character or linked paragraph style.

Returns

Run: The added Run.

AddRun(string, Style)

Adds a Run to the end of this hyperlink.

public Run AddRun(string text, Style style)

Parameters

text string: The text of the Run to insert.
style Style: The run character or linked paragraph style.

Returns

Run: The added Run.

AddRun(string)

Adds a Run to the end of this hyperlink.

public Run AddRun(string text)

Parameters

text string: The text of the Run to insert.

Returns

Run: The added Run.

AddSimpleField(string, string)

Adds a SimpleField to the end of this hyperlink.

public SimpleField AddSimpleField(string code, string result)

Parameters

code string: The field code.
result string: The result text of the new field.

Returns

SimpleField: The added SimpleField.

AddSimpleField(string)

Adds a SimpleField to the end of this hyperlink.

public SimpleField AddSimpleField(string code)

Parameters

code string: The field code.

Returns

SimpleField: The added SimpleField.

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int