Skip to content

Latest commit

 

History

History
218 lines (128 loc) · 4.66 KB

officeimo.word.wordhyperlink.md

File metadata and controls

218 lines (128 loc) · 4.66 KB

WordHyperLink

Namespace: OfficeIMO.Word

public class WordHyperLink

Inheritance ObjectWordHyperLink

Properties

Uri

public Uri Uri { get; set; }

Property Value

Uri

Id

Specifies a location in the target of the hyperlink, in the case in which the link is an external link.

public string Id { get; set; }

Property Value

String

IsEmail

public bool IsEmail { get; }

Property Value

Boolean

EmailAddress

public string EmailAddress { get; }

Property Value

String

History

public bool History { get; set; }

Property Value

Boolean

DocLocation

Specifies a location in the target of the hyperlink, in the case in which the link is an external link.

public string DocLocation { get; set; }

Property Value

String

Anchor

Specifies the name of a bookmark within the document. See Bookmark. If the attribute is omitted, then the default behavior is to navigate to the start of the document. If the r:id attribute is specified, then the anchor attribute is ignored.

public string Anchor { get; set; }

Property Value

String

Tooltip

public string Tooltip { get; set; }

Property Value

String

TargetFrame

public Nullable<TargetFrame> TargetFrame { get; set; }

Property Value

Nullable<TargetFrame>

IsHttp

public bool IsHttp { get; }

Property Value

Boolean

Scheme

public string Scheme { get; }

Property Value

String

Text

public string Text { get; set; }

Property Value

String

Constructors

WordHyperLink(WordDocument, Paragraph, Hyperlink)

public WordHyperLink(WordDocument document, Paragraph paragraph, Hyperlink hyperlink)

Parameters

document WordDocument

paragraph Paragraph

hyperlink Hyperlink

Methods

Remove(Boolean)

Removes hyperlink. When specified to remove paragraph it will only do so, if paragraph is empty or contains only paragraph properties.

public void Remove(bool includingParagraph)

Parameters

includingParagraph Boolean

AddHyperLink(WordParagraph, String, String, Boolean, String, Boolean)

public static WordParagraph AddHyperLink(WordParagraph paragraph, string text, string anchor, bool addStyle, string tooltip, bool history)

Parameters

paragraph WordParagraph

text String

anchor String

addStyle Boolean

tooltip String

history Boolean

Returns

WordParagraph

AddHyperLink(WordParagraph, String, Uri, Boolean, String, Boolean)

public static WordParagraph AddHyperLink(WordParagraph paragraph, string text, Uri uri, bool addStyle, string tooltip, bool history)

Parameters

paragraph WordParagraph

text String

uri Uri

addStyle Boolean

tooltip String

history Boolean

Returns

WordParagraph