Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

This class represents a hyperlink field in a document.



{remarks}
{example}{code:csharp|title=C#}

          //--- Add a hyperlink to a document
          WordApplication app = new WordApplication();
          Document doc = app.Open(@"C:\sample.doc");
          Hyperlink link =
               doc.InsertHyperlinkAfter("http://www.softartisans.com", "SoftArtisans");

          //--- Get the first hyperlink from a document
          WordApplication app = new WordApplication();
          Document doc = app.Open(@"C:\sample.doc");
          Hyperlink firstLink =
               doc.GetElements(Element.Type.Hyperlink)[0];
        
{code}
{code:vb.net
|title=vb.net
}

          '--- Add a hyperlink to a document
          Dim app As New WordApplication()
          Dim doc As Document = app.Open("C:\sample.doc")
          Dim link As Hyperlink = _
               doc.InsertHyperlinkAfter("http://www.softartisans.com", "SoftArtisans")

          '--- Get the first hyperlink from a document
          Dim app As New WordApplication()
          Dim doc As Document = app.Open("C:\sample.doc")
          Dim link As Hyperlink = _
               doc.GetElements(Element.Type.Hyperlink)(0)
        
Signature
C#C#
Wiki Markup
{description}
{excerpt}This class represents a hyperlink field in a document.{excerpt}
{signature:C#}
 public sealed class Hyperlink : Field
Signature
{signature}{signature:vb.net
vb.net
}
Public NotInheritable Class Hyperlink
		Inherits Field
Remarks
To create a hyperlink, use
{signature}
{remarks}To create a hyperlink, use [Element.InsertHyperlinkBefore()|Element.InsertHyperlinkBefore(String, String)].  To get the hyperlinks in a [Document|Document], use the [Element.GetElements()|Element.GetElements(Element.Type)] method with a [Element.Type.Hyperlink|Element.Type#Hyperlink] parameter.


The following sample demonstrates creating a hyperlink at the end of a new document and retrieving the first hyperlink of an existing document.
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle
Methods

...

Name

...

Description

...

GetUrlString()

...

{code}

{example}
{methods}
||Name||Description||
|[GetUrlString()|Hyperlink.GetUrlString()

...

]|{excerpt-include:Hyperlink.GetUrlString()

...

|nopanel

...

=true}|