Page tree

Versions Compared

Key

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

Excerpt

Creates and returns a Hyperlink at the beginning of this Element. This hyperlink will have the specified url and displayed text.

Signature
C#C#
Wiki Markup
{description}
{excerpt}Creates and returns a [Hyperlink|Hyperlink] at the beginning of this Element. This hyperlink will have the specified url and displayed text.{excerpt}
{signature:C#}
 public virtual Hyperlink InsertHyperlinkBefore(System.String url, System.String display)
Signature
{signature}{signature:vb.net
vb.net
}
Public Overridable Function InsertHyperlinkBefore(ByVal url As String, ByVal display As String) As Hyperlink
Parameters

...

A String representing the url to link to.

...

A String representing the text that will be displayed in the document for this hyperlink.

Returns

A Hyperlink object representing the newly created hyperlink.

Exceptions
{signature}
{parameters}
{param:url}A {{String}} representing the url to link to.{param}
{param:display}A {{String}} representing the text that will be displayed in the document for this hyperlink.{param}
{returns}A {{Hyperlink}} object representing the newly created hyperlink.{returns}
{exceptions}
{exception:System.Exception}{exception}
{example}{code:csharp|title=C#}
Hyperlink link = e.InsertHyperlinkBefore("http://www.softartisans.com", "SoftArtisans");
{code}
{code:vb.net
|title=vb.net
}
Dim link As Hyperlink = e.InsertHyperlinkBefore("http://www.softartisans.com", "SoftArtisans"){code}

{example}
Exception
System.ExceptionSystem.Exception
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle