PageAdapter.RenderBeginHyperlink メソッド

  • リファレンス

定義

名前空間:
System.Web.UI.Adapters
アセンブリ:
System.Web.dll

応答ストリームに開くハイパーリンク タグをレンダリングします。

オーバーロード

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。

targetUrl
String

リンクのターゲット URL を保持する String 値。

encodeUrl
Boolean

HtmlAttributeEncode(String) を使用してストリーム出力をエンコードする true。それ以外の場合は、falseします。

softkeyLabel
String

ソフト キー ラベルとして使用する String 値。

例

次のコード例では、PageAdapter クラスから CustomPageAdapter という名前のクラスを派生させ、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 メソッドは、開いているハイパーリンク タグを書き込みます。 writer が HtmlTextWriterされている場合、このタグの形式は次のようになります。

<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。

targetUrl
String

リンクのターゲット URL を保持する String 値。

encodeUrl
Boolean

HtmlAttributeEncode(String) を使用してストリーム出力をエンコードする true。それ以外の場合は、falseします。

softkeyLabel
String

ソフト キー ラベルとして使用する String 値。

accessKey
String

作成するリンクの accessKey 属性に割り当てる String 値。

例外

ArgumentOutOfRangeException

accessKey が 1 文字より長くなっています。

例

次のコード例では、PageAdapter クラスから CustomPageAdapter という名前のクラスを派生させ、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 メソッドは、開いているハイパーリンク タグを書き込みます。 writer が HtmlTextWriter オブジェクトの場合、このタグの形式は次のようになります。

<a href=" targetUrl " accessKey=" accessKey ">

注意 (継承者)

PageAdapter クラスから継承する場合は、RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) メソッドをオーバーライドして、開いているハイパーリンク タグの別の形式を書き込んだり、追加のタグ属性を書き込んだりできます。 たとえば、RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) 基本メソッドでは、softkeyLabelの属性は書き込まれません。

こちらもご覧ください

適用対象