GrapeCity.Documents.Word

GrapeCity.Documents.Word.HyperlinkCollection

Class HyperlinkCollection

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a collection of Hyperlink objects.

public class HyperlinkCollection : ContentObjectCollection<Hyperlink>, IContentList<Hyperlink>, IReadOnlyList<Hyperlink>, IReadOnlyCollection<Hyperlink>, IEnumerable<Hyperlink>, IEnumerable

Inheritance: object

ContentCollection<Hyperlink>

ContentObjectCollection<Hyperlink>

HyperlinkCollection

Implements: IContentList<Hyperlink>

IReadOnlyList<Hyperlink>

IReadOnlyCollection<Hyperlink>

IEnumerable<Hyperlink>

IEnumerable

Inherited Members: ContentCollection<Hyperlink>.GetEnumerator()

ContentCollection<Hyperlink>.Print()

ContentCollection<Hyperlink>.DebugPrint()

ContentCollection<Hyperlink>.this[int]

ContentCollection<Hyperlink>.Count

ContentCollection<Hyperlink>.First

ContentCollection<Hyperlink>.Last

ContentCollection<Hyperlink>.Range

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

Add()

Adds a Hyperlink to this collection at the End location.

public Hyperlink Add()

Returns

Hyperlink: The added Hyperlink.

Add(string, string, string, string)

Adds a Hyperlink to this collection at the End location.

public Hyperlink Add(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.

Add(Uri, string, string, string, string)

Adds a Hyperlink to this collection at the End location.

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

Parameters

address 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.

Insert(InsertLocation)

Inserts a Hyperlink into this collection at a specified location.

public Hyperlink Insert(InsertLocation location)

Parameters

location InsertLocation: The target InsertLocation for the insertion.

Returns

Hyperlink: The inserted Hyperlink.

Insert(string, string, InsertLocation, string, string)

Inserts a Hyperlink into this collection at a specified location.

public Hyperlink Insert(string anchor, string text, InsertLocation location, 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.
location InsertLocation: The target InsertLocation for the insertion.
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 inserted Hyperlink.

Insert(Uri, string, string, InsertLocation, string, string)

Inserts a Hyperlink into this collection at a specified location.

public Hyperlink Insert(Uri address, string anchor, string text, InsertLocation location, string screenTip = null, string target = null)

Parameters

address 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.
location InsertLocation: The target InsertLocation for the insertion.
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 inserted Hyperlink.