InsertHyperlink メソッド

web サイトなどの外部リソースへのハイパーリンクを挿入します。

シンタックス

Visual Basic

public HyperlinkNode InsertHyperlink( 
   int documentOffset,
   string targetUri,
   out string error,
   string displayText,
   string tooltip
)

C#

'宣言
 
Public Function InsertHyperlink( _
   ByVal documentOffset As Integer, _
   ByVal targetUri As String, _
   ByRef error As String, _
   Optional ByVal displayText As String, _
   Optional ByVal tooltip As String _
) As HyperlinkNode

 

パラメータ

documentOffset

テキストを挿入するドキュメント オフセット。

targetUri

リンクのターゲット URI。

error

エラーがある場合、この出力パラメーターはエラー情報に設定されます。

displayText

ドキュメントでこのハイパーリンクのために表示するテキスト。null が指定した場合、 targetUri は使用されます。

tooltip

ユーザーがリンクの上にマウスをホバーするときに表示するツールチップ。

戻り値の型

この操作の結果で挿入されたハイパーリンク ノード。エラーが発生する場合、null を返します。