PostBackOptions クラス

リファレンス

定義

名前空間:: System.Web.UI

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ポストバックイベントを実行するためにクライアント側の JavaScript を生成する方法を指定します。

public ref class PostBackOptions sealed

public sealed class PostBackOptions

type PostBackOptions = class

Public NotInheritable Class PostBackOptions

継承: Object
PostBackOptions

例

次のコード例では、 OnClick コントロールのイベントを Button 使用して、コントロールがポストバックイベントを HyperLink 発生させるコントロールの HyperLink クライアント側スクリプトを生成します。 ActionUrlオブジェクトの myPostBackOptions プロパティは "Page2.aspx" に設定されているため、ポストバックでは、Web Forms ページが "Page2.aspx" という名前の別のページにポストされます。このページはここでは提供されません。この例を使用するには、"Page2.aspx" という名前の別の Web ページをプロジェクトまたはディレクトリに追加する必要があります。

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class postbackoptionscs : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {
        if (Page.IsPostBack)
        {
            Label1.Text = "A postback event has occurred.";
        }
    }

    protected void Button1_Click(object sender, EventArgs e)
    {
        // Create a new PostBackOptions object and set its properties.
        PostBackOptions myPostBackOptions = new PostBackOptions(this);
        myPostBackOptions.ActionUrl = "Page2.aspx";
        myPostBackOptions.AutoPostBack = false;
        myPostBackOptions.RequiresJavaScriptProtocol = true;
        myPostBackOptions.PerformValidation = true;

        // Add the client-side script to the HyperLink1 control.
        HyperLink1.NavigateUrl = Page.ClientScript.GetPostBackEventReference(myPostBackOptions);

        Label1.Text = "Click this hyperlink to initiate a postback event.";
    }
}

Partial Class postbackoptionsvb
    Inherits System.Web.UI.Page
    Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)

        ' Create a new PostBackOptions object and set its properties.
        Dim myPostBackOptions As PostBackOptions = New PostBackOptions(Me)
        myPostBackOptions.ActionUrl = "Page2.aspx"
        myPostBackOptions.AutoPostBack = False
        myPostBackOptions.RequiresJavaScriptProtocol = True
        myPostBackOptions.PerformValidation = True

        ' Add the client-side script to the HyperLink1 control.
        HyperLink1.NavigateUrl = Page.ClientScript.GetPostBackEventReference(myPostBackOptions)

        Label1.Text = "Click this hyperlink to initiate a postback event."

    End Sub

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load

        If Page.IsPostBack Then
            Label1.Text = "A postback event has occurred."
        End If

    End Sub
End Class

次のコード例は、上記の分離コードファイルを実行するために使用できる Web ページです。

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="postbackoptions.aspx.cs" Inherits="postbackoptionscs" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head id="Head1" runat="server">
    <title>PostBackOptions Example</title>
  </head>
  <body>
    <form id="form1" runat="server">
    <h3>PostBackOptions Example Page</h3>
      Click this button to create client-side script for the 
      Postback hyperlink that causes a postback event to occur.
      <br />
      <asp:Button id="Button1" 
        runat="server" 
        text="Create Script" 
        onclick="Button1_Click" />
      <br /><br />
      <asp:Label id="Label1" 
        runat="server" 
        text="">
      </asp:Label>
      <br />
      <asp:HyperLink id="HyperLink1" 
        runat="server" 
        text="Postback">
      </asp:HyperLink>
    </form>
  </body>
</html>

<%@ Page Language="VB" AutoEventWireup="true" CodeFile="postbackoptions.aspx.vb" Inherits="postbackoptionsvb" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>PostBackOptions Example</title>
  </head>
  <body>
    <form id="form1" runat="server">
    <h3>PostBackOptions Example Page</h3>
      Click this button to create client-side script for the 
      Postback hyperlink that causes a postback event to occur.
      <br />
      <asp:Button id="Button1" 
        runat="server" 
        text="Create Script" 
        onclick="Button1_Click" />
      <br /><br />
      <asp:Label id="Label1" 
        runat="server" 
        text=""></asp:Label>
      <br />
      <asp:HyperLink id="HyperLink1" 
        runat="server" 
        text="Postback"></asp:HyperLink>
      <br />
    </form>
  </body>
</html>

注釈

クラスを PostBackOptions 使用すると、コントロールはポストバックイベントを開始するクライアント側スクリプトを出力できます。クラスは PostBackOptions 、プロパティを介して TargetControl ポストバックイベントを開始したコントロールへの参照も提供します。ポストバックイベントは、メソッドに渡されるオブジェクトで PostBackOptions 指定されたオプションに ClientScriptManager.GetPostBackEventReference 基づいて作成されます。

通常、サーバーへのポストバックは、[送信] ボタンや [イメージ] ボタンなどの要素によって開始されます。ただし、クライアント側の JavaScript を出力することで、さまざまなコントロールでポストバックイベントを開始できます。

コンストラクター

PostBackOptions(Control)	対象のコントロールデータを指定して、PostBackOptions クラスの新しいインスタンスを初期化します。
PostBackOptions(Control, String)	対象のコントロールおよび引数データを指定して、PostBackOptions クラスの新しいインスタンスを初期化します。
PostBackOptions(Control, String, String, Boolean, Boolean, Boolean, Boolean, Boolean, String)	インスタンスのプロパティに対して指定した値を使用して、PostBackOptions クラスの新しいインスタンスを初期化します。

プロパティ

ActionUrl	Web フォームページのポストバックの対象の URL を取得または設定します。
Argument	ポストバックイベントで転送される省略可能な引数を取得または設定します。
AutoPostBack	ユーザーアクションへの応答としてフォームがサーバーに自動的にポストバックされるかどうかを示す値を取得または設定します。
ClientSubmit	クライアント側スクリプトからポストバックイベントが発生するかどうかを示す値を取得または設定します。
PerformValidation	ポストバックイベントが発生する前にクライアント側の検証が必要かどうかを示す値を取得または設定します。
RequiresJavaScriptProtocol	クライアント側スクリプトに対して `javascript:` プレフィックスが生成されるかどうかを示す値を取得または設定します。
TargetControl	ポストバックイベントを受け取る対象のコントロールを取得します。
TrackFocus	ポストバックイベントが現在のスクロール位置にページを返し、現在のコントロールにフォーカスを返すかどうかを示す値を取得または設定します。
ValidationGroup	PostBackOptions オブジェクトがサーバーにポストバックされるときに検証が実行されるコントロールのグループを取得または設定します。

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

こちらもご覧ください

GetPostBackEventReference(PostBackOptions)

次の方法で共有