PostBackOptions クラス

定義

ポストバック イベントを実行するためにクライアント側の JavaScript を生成する方法を指定します。Specifies how client-side JavaScript is generated to initiate a postback event.

public ref class PostBackOptions sealed
public sealed class PostBackOptions
type PostBackOptions = class
Public NotInheritable Class PostBackOptions
継承
PostBackOptions

次のコード例では、コントロールのイベントを使用して、コントロールが OnClick Button HyperLink HyperLink ポストバックイベントを発生させることができるようにするコントロールのクライアント側スクリプトを生成します。The following code example uses the OnClick event of a Button control to generate client-side script for a HyperLink control that will allow the HyperLink control to cause a postback event. ActionUrlオブジェクトのプロパティ myPostBackOptions が "page2" に設定されているため、ポストバックによって Web フォームページが "page2. .aspx" という名前の別のページにポストされます。このページはここでは説明されていません。Because the ActionUrl property of the myPostBackOptions object is set to "Page2.aspx", the postback will post the Web Forms page to another page named "Page2.aspx", which is not provided here. この例を使用するには、プロジェクトまたはディレクトリに "Page2 .aspx" という名前の別の Web ページを追加する必要があります。To use this example, you must add another Web page named "Page2.aspx" to your project or directory.

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 ページです。The following code example is a Web page that can be used to run the preceding code-behind file.

<%@ 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 ポストバックイベントを開始するクライアント側スクリプトを生成できます。The PostBackOptions class allows controls to emit client-side script that initiates a postback event. クラスは、 PostBackOptions プロパティを介してポストバックイベントを開始したコントロールへの参照も提供し TargetControl ます。The PostBackOptions class also provides a reference to the control that initiated the postback event through the TargetControl property. ポストバックイベントは、メソッドに渡されたオブジェクトで指定されたオプションに基づいて作成され PostBackOptions ClientScriptManager.GetPostBackEventReference ます。The postback event is created based on the options specified in the PostBackOptions object passed in to the ClientScriptManager.GetPostBackEventReference method.

通常、サーバーへのポストバックは、[送信] ボタンや [画像] ボタンなどの要素によって開始されます。Normally, a postback to the server is initiated by elements such as a Submit button or an Image button. ただし、クライアント側の JavaScript を生成することで、さまざまなコントロールがポストバックイベントを開始できます。However, by emitting client-side JavaScript, different controls can initiate a postback event.

コンストラクター

PostBackOptions(Control)

対象のコントロール データを指定して、PostBackOptions クラスの新しいインスタンスを初期化します。Initializes a new instance of the PostBackOptions class with the specified target control data.

PostBackOptions(Control, String)

対象のコントロールおよび引数データを指定して、PostBackOptions クラスの新しいインスタンスを初期化します。Initializes a new instance of the PostBackOptions class with the specified target control and argument data.

PostBackOptions(Control, String, String, Boolean, Boolean, Boolean, Boolean, Boolean, String)

インスタンスのプロパティに対して指定した値を使用して、PostBackOptions クラスの新しいインスタンスを初期化します。Initializes a new instance of the PostBackOptions class with the specified values for the instance's properties.

プロパティ

ActionUrl

Web フォーム ページのポストバックの対象の URL を取得または設定します。Gets or sets the target URL for the postback of a Web Forms page.

Argument

ポストバック イベントで転送される省略可能な引数を取得または設定します。Gets or sets an optional argument that is transferred in the postback event.

AutoPostBack

ユーザー アクションへの応答としてフォームがサーバーに自動的にポストバックされるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the form will automatically post back to the server in response to a user action.

ClientSubmit

クライアント側スクリプトからポストバック イベントが発生するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the postback event should occur from client-side script.

PerformValidation

ポストバック イベントが発生する前にクライアント側の検証が必要かどうかを示す値を取得または設定します。Gets or sets a value indicating whether client-side validation is required before the postback event occurs.

RequiresJavaScriptProtocol

クライアント側スクリプトに対して javascript: プレフィックスが生成されるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the javascript: prefix is generated for the client-side script.

TargetControl

ポストバック イベントを受け取る対象のコントロールを取得します。Gets the control target that receives the postback event.

TrackFocus

ポストバック イベントが現在のスクロール位置にページを返し、現在のコントロールにフォーカスを返すかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the postback event should return the page to the current scroll position and return focus to the current control.

ValidationGroup

PostBackOptions オブジェクトがサーバーにポストバックされるときに検証が実行されるコントロールのグループを取得または設定します。Gets or sets the group of controls for which the PostBackOptions object causes validation when it posts back to the server.

メソッド

Equals(Object)

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

(継承元 Object)
GetHashCode()

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

(継承元 Object)
GetType()

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

(継承元 Object)
MemberwiseClone()

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

(継承元 Object)
ToString()

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

(継承元 Object)

適用対象

こちらもご覧ください