PageAdapter PageAdapter PageAdapter PageAdapter Class

定義

特定のブラウザーに対応するように Web ページを調整し、すべてのページ アダプターの直接または間接的な継承元となる基本クラスを提供します。Adapts a Web page for a specific browser and provides the base class from which all page adapters inherit, directly or indirectly.

public ref class PageAdapter abstract : System::Web::UI::Adapters::ControlAdapter
public abstract class PageAdapter : System.Web.UI.Adapters.ControlAdapter
type PageAdapter = class
    inherit ControlAdapter
Public MustInherit Class PageAdapter
Inherits ControlAdapter
継承

次のコード例は、 CustomPageAdapter PageAdapterクラスからという名前のクラスを派生させRenderBeginHyperlink 、メソッドをオーバーライドする方法を示しています。The following code example demonstrates how to derive a class named CustomPageAdapter from the PageAdapter class and override the RenderBeginHyperlink method. メソッドRenderBeginHyperlinkは、という名前srcの属性をハイパーリンクに追加します。このハイパーリンクには、現在のページへの参照が含まれています。The RenderBeginHyperlink method adds an attribute named src to a hyperlink, which contains a reference to the current page. CustomPageAdapterがアタッチされているページに表示されるすべてsrcのハイパーリンクには、属性があります。All hyperlinks rendered in pages to which CustomPageAdapter is attached will have the src attribute.

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 ' CustomPageAdapter

注釈

PageAdapterクラスは、ブラウザーが使用するマークアップ言語 (HTML や XHTML など) によって定義される、特定のブラウザーのクラスに対して Web ページを適合させる抽象クラスです。The PageAdapter class is an abstract class that adapts a Web page for a specific class of browsers, defined by the markup language that the browser uses (for example, HTML or XHTML). レンダリング動作の適応性の多くは、 HtmlTextWriterクラスから派生した特殊なテキストライタークラスにカプセル化できます。したがって、ページアダプターを必ずしも提供する必要はありません。Much of the adaptability in rendering behavior can be encapsulated in the specialized text writer classes that derive from the HtmlTextWriter class, so it is not always necessary to provide a page adapter.

派生ページアダプターのほとんどのメンバーは、 Pageクラスまたはコントロールアダプターから呼び出されます。Most members of derived page adapters are called from the Page class or from control adapters. まず、 Pageクラスまたはコントロールアダプターは、派生ページアダプターの存在を検出してから、そのメンバーを呼び出します。または、ページアダプターが存在しない場合は機能を提供します。First, the Page class or control adapters detect the presence of the derived page adapter, and then call the member, or provide the functionality if the page adapter is not present.

PageAdapterクラスのメンバーは、次の機能を提供します。The members of the PageAdapter class provide the following functionality:

  • プロパティCacheVaryByHeadersCacheVaryByParamsプロパティは、追加の http ヘッダー GETPOST 、キャッシュを変更するために使用できる http およびパラメーターを定義します。The CacheVaryByHeaders and CacheVaryByParams properties define additional HTTP headers and HTTP GET and POST parameters that can be used to vary caching. これらは、 Pageクラスからのキャッシュの初期化中に呼び出されます。They are called during cache initialization from the Page class.

  • メソッドGetStatePersisterは、ページのビューとコントロールの状態の組み合わせを永続化するために使用できるオブジェクトを返します。The GetStatePersister method returns an object that can be used to persist the combined view and control states of the page. 派生ページアダプターが存在PageStatePersisterする場合は、プロパティから参照されます。It is referenced from the PageStatePersister property if a derived page adapter is present.

  • GetPostBackFormReferenceメソッドには、スクリプト内のフォームを参照するために使用できる DHTML コードフラグメントが用意されています。The GetPostBackFormReference method provides a DHTML code fragment that can be used to reference forms in scripts.

  • ページDeterminePostBackModeがポストバック中の場合、メソッドはポストバック変数のコレクションを返します。The DeterminePostBackMode method returns a collection of the postback variables if the page is in postback. 派生ページアダプターが存在する場合、 Page.DeterminePostBackModeメソッドの代わりに .NET Framework によって呼び出されます。It is called by the .NET Framework instead of the Page.DeterminePostBackMode method if a derived page adapter is present.

  • メソッドRenderBeginHyperlinkRenderEndHyperlinkメソッドは、派生ページアダプターが存在する場合にハイパーリンクを表示するために、コントロールアダプターによって使用されます。The RenderBeginHyperlink and RenderEndHyperlink methods are used by control adapters to render hyperlinks if a derived page adapter is present.

  • メソッドRenderPostBackEventは、フォームを送信できるハイパーリンクまたはポストバッククライアントタグをレンダリングします。The RenderPostBackEvent method renders a hyperlink or postback client tag that can submit the form.

  • およびRegisterRadioButton RadioButtonメソッドは、ラジオボタングループ内の他のコントロールを参照するために、ラジオボタンコントロールアダプターによって使用されます。 GetRadioButtonsByGroupThe RegisterRadioButton and GetRadioButtonsByGroup methods are used by radio button control adapters to reference the other RadioButton controls in a radio button group.

  • プロパティClientStateClientState 、クラスPageの内部プロパティを使用して、 Pageオブジェクトのコントロールとビューステートの組み合わせにアクセスできるようにします。The ClientState property provides access to the combined control and view states of the Page object through the internal ClientState property of the Page class.

  • メソッドTransformTextは、デバイス固有のテキスト変換を実行するために、コントロールアダプターによって使用されます。The TransformText method is used by control adapters to perform device-specific text transformation.

コンストラクター

PageAdapter() PageAdapter() PageAdapter() PageAdapter()

PageAdapter クラスの新しいインスタンスを初期化します。Initializes a new instance of the PageAdapter class.

プロパティ

Browser Browser Browser Browser

現在の HTTP 要求の作成元であるクライアントのブラウザー機能への参照を取得します。Gets a reference to the browser capabilities of the client making the current HTTP request.

(Inherited from ControlAdapter)
CacheVaryByHeaders CacheVaryByHeaders CacheVaryByHeaders CacheVaryByHeaders

この派生ページ アダプターが割り当てられた Web ページのキャッシュを変更する、追加の HTTP ヘッダーのリストを取得します。Gets a list of additional HTTP headers by which caching is varied for the Web page to which this derived page adapter is attached.

CacheVaryByParams CacheVaryByParams CacheVaryByParams CacheVaryByParams

この派生ページ アダプターが割り当てられた Web ページのキャッシュを変更する、HTTP の GET 要求および POST 要求からの追加パラメーターのリストを取得します。Gets a list of additional parameters from HTTP GET and POST requests by which caching is varied for the Web page to which this derived page adapter is attached.

ClientState ClientState ClientState ClientState

この派生ページ アダプターが割り当てられた Web ページのビューとコントロールの状態データを含んだ、エンコード済みの文字列を取得します。Gets an encoded string that contains the view and control states data of the Web page to which this derived page adapter is attached.

Control Control Control Control

このコントロール アダプターの割り当て先コントロールへの参照を取得します。Gets a reference to the control to which this control adapter is attached.

(Inherited from ControlAdapter)
Page Page Page Page

このアダプターに関連付けられたコントロールが配置されているページへの参照を取得します。Gets a reference to the page where the control associated with this adapter resides.

(Inherited from ControlAdapter)
PageAdapter PageAdapter PageAdapter PageAdapter

関連付けられたコントロールが配置されているページのページ アダプターへの参照を取得します。Gets a reference to the page adapter for the page where the associated control resides.

(Inherited from ControlAdapter)

メソッド

BeginRender(HtmlTextWriter) BeginRender(HtmlTextWriter) BeginRender(HtmlTextWriter) BeginRender(HtmlTextWriter)

コントロールの表示前に呼び出されます。Called prior to the rendering of a control. 派生アダプター クラスで、HTML ブラウザーには必要ではなくても特定のターゲットには必要な開始タグを生成します。In a derived adapter class, generates opening tags that are required by a specific target but not needed by HTML browsers.

(Inherited from ControlAdapter)
CreateChildControls() CreateChildControls() CreateChildControls() CreateChildControls()

複合コントロールのターゲット固有の子コントロールを作成します。Creates the target-specific child controls for a composite control.

(Inherited from ControlAdapter)
DeterminePostBackMode() DeterminePostBackMode() DeterminePostBackMode() DeterminePostBackMode()

Web ページがポストバック中で、ポストバック変数の名前/値コレクションを返すかどうかを判断します。Determines whether the Web page is in postback and returns a name/value collection of the postback variables.

DeterminePostBackModeUnvalidated() DeterminePostBackModeUnvalidated() DeterminePostBackModeUnvalidated() DeterminePostBackModeUnvalidated()

要求に対して ASP.NET 要求の検証を実行せずに、POST また GET コマンドを使用して、ページにポストされたデータの名前と値のコレクションを返します。Returns a name-value collection of data that was posted to the page using either a POST or a GET command, without performing ASP.NET request validation on the request.

EndRender(HtmlTextWriter) EndRender(HtmlTextWriter) EndRender(HtmlTextWriter) EndRender(HtmlTextWriter)

コントロールの表示後に呼び出されます。Called after the rendering of a control. 派生アダプター クラスで、HTML ブラウザーには必要ではなくても特定のターゲットには必要な終了タグを生成します。In a derived adapter class, generates closing tags that are required by a specific target but not needed by HTML browsers.

(Inherited from ControlAdapter)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetPostBackFormReference(String) GetPostBackFormReference(String) GetPostBackFormReference(String) GetPostBackFormReference(String)

送信されたページ上のフォームを参照するためにクライアント ブラウザーが使用できる DHTML のコード片を返します。Returns a DHTML code fragment that the client browser can use to reference the form on the page that was posted.

GetRadioButtonsByGroup(String) GetRadioButtonsByGroup(String) GetRadioButtonsByGroup(String) GetRadioButtonsByGroup(String)

groupName で指定したオプション ボタン コントロールのコレクションを取得します。Retrieves a collection of radio button controls specified by groupName.

GetStatePersister() GetStatePersister() GetStatePersister() GetStatePersister()

コントロールおよびビューステートを維持するために Web ページで使用されるオブジェクトを返します。Returns an object that is used by the Web page to maintain the control and view states.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
LoadAdapterControlState(Object) LoadAdapterControlState(Object) LoadAdapterControlState(Object) LoadAdapterControlState(Object)

このコントロール アダプターに関連付けられたコントロールが配置されているページに対する以前の要求時に SaveAdapterControlState() によって保存された、アダプターのコントロール状態情報を読み込みます。Loads adapter control state information that was saved by SaveAdapterControlState() during a previous request to the page where the control associated with this control adapter resides.

(Inherited from ControlAdapter)
LoadAdapterViewState(Object) LoadAdapterViewState(Object) LoadAdapterViewState(Object) LoadAdapterViewState(Object)

このコントロール アダプターに関連付けられたコントロールが配置されているページに対する以前の要求時に SaveAdapterViewState() によって保存された、アダプターのビューステートを読み込みます。Loads adapter view state information that was saved by SaveAdapterViewState() during a previous request to the page where the control associated with this control adapter resides.

(Inherited from ControlAdapter)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs)

関連付けられたコントロールの OnInit(EventArgs) メソッドをオーバーライドします。Overrides the OnInit(EventArgs) method for the associated control.

(Inherited from ControlAdapter)
OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs)

関連付けられたコントロールの OnLoad(EventArgs) メソッドをオーバーライドします。Overrides the OnLoad(EventArgs) method for the associated control.

(Inherited from ControlAdapter)
OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs)

関連付けられたコントロールの OnPreRender(EventArgs) メソッドをオーバーライドします。Overrides the OnPreRender(EventArgs) method for the associated control.

(Inherited from ControlAdapter)
OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs)

関連付けられたコントロールの OnUnload(EventArgs) メソッドをオーバーライドします。Overrides the OnUnload(EventArgs) method for the associated control.

(Inherited from ControlAdapter)
RegisterRadioButton(RadioButton) RegisterRadioButton(RadioButton) RegisterRadioButton(RadioButton) RegisterRadioButton(RadioButton)

オプション ボタン コントロールを、指定したオプション ボタン グループのコレクションに追加します。Adds a radio button control to the collection for a specified radio button group.

Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter)

コントロール アダプターがアタッチされるコントロール用にターゲット固有のマークアップを生成します。Generates the target-specific markup for the control to which the control adapter is attached.

(Inherited from ControlAdapter)
RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String) RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String) RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String) RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String)

応答ストリームに対して、ターゲット URL を含んだハイパーリンクの開始タグをレンダリングします。Renders an opening hyperlink tag that includes the target URL to the response stream.

RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String) RenderBeginHyperlink(HtmlTextWriter, String, Boolean, String, String)

応答ストリームに対して、ターゲット URL とアクセス キーを含んだハイパーリンクの開始タグをレンダリングします。Renders an opening hyperlink tag that includes the target URL and an access key to the response stream.

RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter)

コントロール アダプターの割り当て先である複合コントロールに含まれる子コントロールのターゲット固有のマークアップを生成します。Generates the target-specific markup for the child controls in a composite control to which the control adapter is attached.

(Inherited from ControlAdapter)
RenderEndHyperlink(HtmlTextWriter) RenderEndHyperlink(HtmlTextWriter) RenderEndHyperlink(HtmlTextWriter) RenderEndHyperlink(HtmlTextWriter)

応答ストリームに対してハイパーリンクの終了タグをレンダリングします。Renders a closing hyperlink tag to the response stream.

RenderPostBackEvent(HtmlTextWriter, String, String, String, String) RenderPostBackEvent(HtmlTextWriter, String, String, String, String) RenderPostBackEvent(HtmlTextWriter, String, String, String, String) RenderPostBackEvent(HtmlTextWriter, String, String, String, String)

ポストバック イベントをハイパーリンクとして応答ストリームにレンダリングします。これには、必要に応じて暗号化されたエンコード済みのビューステート、およびイベントのターゲットと引数も含まれます。Renders a postback event into the response stream as a hyperlink, including the encoded and possibly encrypted view state, and event target and argument.

RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String) RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String) RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String) RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String)

ポストバック イベントをハイパーリンクとして応答ストリームにレンダリングします。これには、必要に応じて暗号化されたエンコード済みのビューステート、イベントのターゲットと引数、前回のページのパラメーター、およびアクセス キーも含まれます。Renders a postback event into the response stream as a hyperlink, including the encoded and possibly encrypted view state, an event target and argument, a previous-page parameter, and an access key.

RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String, Boolean) RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String, Boolean) RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String, Boolean) RenderPostBackEvent(HtmlTextWriter, String, String, String, String, String, String, Boolean)

ポストバック イベントをハイパーリンクとして応答ストリームにレンダリングします。これには、エンコード済みのビューステート、イベントのターゲットと引数、前回のページのパラメーター、およびアクセス キーも含まれます。Renders a postback event into the response stream as a hyperlink, including the encoded view state, an event target and argument, a previous-page parameter, and an access key.

SaveAdapterControlState() SaveAdapterControlState() SaveAdapterControlState() SaveAdapterControlState()

コントロール アダプターのコントロール状態情報を保存します。Saves control state information for the control adapter.

(Inherited from ControlAdapter)
SaveAdapterViewState() SaveAdapterViewState() SaveAdapterViewState() SaveAdapterViewState()

コントロール アダプターのビューステート情報を保存します。Saves view state information for the control adapter.

(Inherited from ControlAdapter)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)
TransformText(String) TransformText(String) TransformText(String) TransformText(String)

対象ブラウザー用にテキストを変換します。Transforms text for the target browser.

適用対象

こちらもご覧ください