PageAdapter.RenderBeginHyperlink メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
応答ストリームに対してハイパーリンクの開始タグをレンダリングします。
オーバーロード
RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String) |
応答ストリームに対して、ターゲット URL を含んだハイパーリンクの開始タグをレンダリングします。 |
RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) |
応答ストリームに対して、ターゲット URL とアクセス キーを含んだハイパーリンクの開始タグをレンダリングします。 |
RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String)
応答ストリームに対して、ターゲット URL を含んだハイパーリンクの開始タグをレンダリングします。
public:
virtual void RenderBeginHyperlink(System::Web::UI::HtmlTextWriter ^ writer, System::String ^ targetUrl, bool encodeUrl, System::String ^ softkeyLabel);
public virtual void RenderBeginHyperlink (System.Web.UI.HtmlTextWriter writer, string targetUrl, bool encodeUrl, string softkeyLabel);
abstract member RenderBeginHyperlink : System.Web.UI.HtmlTextWriter * string * bool * string -> unit
override this.RenderBeginHyperlink : System.Web.UI.HtmlTextWriter * string * bool * string -> unit
Public Overridable Sub RenderBeginHyperlink (writer As HtmlTextWriter, targetUrl As String, encodeUrl As Boolean, softkeyLabel As String)
パラメーター
- writer
- HtmlTextWriter
ターゲット固有の出力を表示するメソッドを持つ HtmlTextWriter。
- encodeUrl
- Boolean
HtmlAttributeEncode(String) を使用してストリーム出力をエンコードする場合は true
。それ以外の場合は false
。
例
次のコード例は、クラスから名前付きの CustomPageAdapter
クラスを派生させ、メソッドを PageAdapter オーバーライドする方法を RenderBeginHyperlink 示しています。 このメソッドは RenderBeginHyperlink 、現在のページへの参照を含むハイパーリンクに名前付きの src
属性を追加します。 添付されているページ CustomPageAdapter
に表示されるすべてのハイパーリンクには、属性が src
含まれます。
using System;
using System.IO;
using System.Web;
using System.Web.UI;
using System.Web.UI.Adapters;
// A derived PageAdapter class.
public class CustomPageAdapter : PageAdapter
{
// Override RenderBeginHyperlink to add an attribute that
// references the referring page.
public override void RenderBeginHyperlink(
HtmlTextWriter writer, string targetUrl,
bool encodeUrl, string softkeyLabel,
string accessKey )
{
string url = null;
// Add the src attribute, if referring page URL is available.
if( Page != null && Page.Request != null &&
Page.Request.Url != null )
{
url = Page.Request.Url.AbsoluteUri;
if( encodeUrl )
url = HttpUtility.HtmlAttributeEncode( url );
writer.AddAttribute( "src", url );
}
// Add the accessKey attribute, if caller requested.
if( accessKey != null && accessKey.Length == 1 )
writer.AddAttribute( "accessKey", accessKey );
// Add the href attribute, encode the URL if requested.
if( encodeUrl )
url = HttpUtility.HtmlAttributeEncode( targetUrl );
else
url = targetUrl;
writer.AddAttribute( "href", url );
// Render the hyperlink opening tag with the added attributes.
writer.RenderBeginTag( "a" );
}
}
Imports System.IO
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.Adapters
' A derived PageAdapter class.
Public Class CustomPageAdapter
Inherits PageAdapter
' Override RenderBeginHyperlink to add an attribute that
' references the referring page.
Public Overrides Sub RenderBeginHyperlink( _
ByVal writer As HtmlTextWriter, ByVal targetUrl As String, _
ByVal encodeUrl As Boolean, ByVal softkeyLabel As String, _
ByVal accessKey As String)
Dim url As String
' Add the src attribute, if referring page URL is available.
If Not (Page Is Nothing) Then
If Not (Page.Request Is Nothing) Then
If Not (Page.Request.Url Is Nothing) Then
url = Page.Request.Url.AbsoluteUri
If encodeUrl Then
url = HttpUtility.HtmlAttributeEncode(url)
End If
writer.AddAttribute("src", url)
End If
End If
End If
' Render the accessKey attribute, if requested.
If Not (accessKey Is Nothing) Then
If accessKey.Length = 1 Then
writer.AddAttribute("accessKey", accessKey)
End If
End If
' Add the href attribute, encode the URL if requested.
If (encodeUrl) Then
url = HttpUtility.HtmlAttributeEncode(targetUrl)
Else
url = targetUrl
End If
writer.AddAttribute("href", url)
' Render the hyperlink opening tag with the added attributes.
writer.RenderBeginTag("a")
End Sub
End Class
注釈
このメソッドは RenderBeginHyperlink 、開始ハイパーリンク タグを書き込みます。 このタグの形式はHtmlTextWriter次のとおりです。writer
<a href="
targetUrl
">
注意 (継承者)
クラスから PageAdapter 継承する場合は、開くハイパーリンク タグの別の形式を書き込むか、追加のタグ属性を書き込むためのメソッドをオーバーライド RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String) できます。 たとえば、基本メソッドでは 、次の RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String) 属性 softkeyLabel
は書き込まれません。
こちらもご覧ください
適用対象
RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String)
応答ストリームに対して、ターゲット URL とアクセス キーを含んだハイパーリンクの開始タグをレンダリングします。
public:
virtual void RenderBeginHyperlink(System::Web::UI::HtmlTextWriter ^ writer, System::String ^ targetUrl, bool encodeUrl, System::String ^ softkeyLabel, System::String ^ accessKey);
public virtual void RenderBeginHyperlink (System.Web.UI.HtmlTextWriter writer, string targetUrl, bool encodeUrl, string softkeyLabel, string accessKey);
abstract member RenderBeginHyperlink : System.Web.UI.HtmlTextWriter * string * bool * string * string -> unit
override this.RenderBeginHyperlink : System.Web.UI.HtmlTextWriter * string * bool * string * string -> unit
Public Overridable Sub RenderBeginHyperlink (writer As HtmlTextWriter, targetUrl As String, encodeUrl As Boolean, softkeyLabel As String, accessKey As String)
パラメーター
- writer
- HtmlTextWriter
ターゲット固有の出力を表示するメソッドを持つ HtmlTextWriter。
- encodeUrl
- Boolean
HtmlAttributeEncode(String) を使用してストリーム出力をエンコードする場合は true
。それ以外の場合は false
。
例外
accessKey
が 1 文字を超えています。
例
次のコード例は、クラスから名前付きの CustomPageAdapter
クラスを派生させ、メソッドを PageAdapter オーバーライドする方法を RenderBeginHyperlink 示しています。 RenderBeginHyperlink は、現在のページへの参照を含むハイパーリンクに名前付きの src
属性を追加します。 添付されているページ CustomPageAdapter
に表示されるすべてのハイパーリンクには、属性が src
含まれます。
using System;
using System.IO;
using System.Web;
using System.Web.UI;
using System.Web.UI.Adapters;
// A derived PageAdapter class.
public class CustomPageAdapter : PageAdapter
{
// Override RenderBeginHyperlink to add an attribute that
// references the referring page.
public override void RenderBeginHyperlink(
HtmlTextWriter writer, string targetUrl,
bool encodeUrl, string softkeyLabel,
string accessKey )
{
string url = null;
// Add the src attribute, if referring page URL is available.
if( Page != null && Page.Request != null &&
Page.Request.Url != null )
{
url = Page.Request.Url.AbsoluteUri;
if( encodeUrl )
url = HttpUtility.HtmlAttributeEncode( url );
writer.AddAttribute( "src", url );
}
// Add the accessKey attribute, if caller requested.
if( accessKey != null && accessKey.Length == 1 )
writer.AddAttribute( "accessKey", accessKey );
// Add the href attribute, encode the URL if requested.
if( encodeUrl )
url = HttpUtility.HtmlAttributeEncode( targetUrl );
else
url = targetUrl;
writer.AddAttribute( "href", url );
// Render the hyperlink opening tag with the added attributes.
writer.RenderBeginTag( "a" );
}
}
Imports System.IO
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.Adapters
' A derived PageAdapter class.
Public Class CustomPageAdapter
Inherits PageAdapter
' Override RenderBeginHyperlink to add an attribute that
' references the referring page.
Public Overrides Sub RenderBeginHyperlink( _
ByVal writer As HtmlTextWriter, ByVal targetUrl As String, _
ByVal encodeUrl As Boolean, ByVal softkeyLabel As String, _
ByVal accessKey As String)
Dim url As String
' Add the src attribute, if referring page URL is available.
If Not (Page Is Nothing) Then
If Not (Page.Request Is Nothing) Then
If Not (Page.Request.Url Is Nothing) Then
url = Page.Request.Url.AbsoluteUri
If encodeUrl Then
url = HttpUtility.HtmlAttributeEncode(url)
End If
writer.AddAttribute("src", url)
End If
End If
End If
' Render the accessKey attribute, if requested.
If Not (accessKey Is Nothing) Then
If accessKey.Length = 1 Then
writer.AddAttribute("accessKey", accessKey)
End If
End If
' Add the href attribute, encode the URL if requested.
If (encodeUrl) Then
url = HttpUtility.HtmlAttributeEncode(targetUrl)
Else
url = targetUrl
End If
writer.AddAttribute("href", url)
' Render the hyperlink opening tag with the added attributes.
writer.RenderBeginTag("a")
End Sub
End Class
注釈
このメソッドは RenderBeginHyperlink 、開始ハイパーリンク タグを書き込みます。 オブジェクトのHtmlTextWriter場合writer
、このタグの形式は次のとおりです。
<a href="
targetUrl
" accessKey="
accessKey
">
注意 (継承者)
クラスから PageAdapter 継承する場合は、開くハイパーリンク タグの別の形式を書き込むか、追加のタグ属性を書き込むためのメソッドをオーバーライド RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) できます。 たとえば、基本メソッドでは 、次の RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) 属性 softkeyLabel
は書き込まれません。