.NET Framework Class Library
IPostBackEventHandler..::.RaisePostBackEvent Method

When implemented by a class, enables a server control to process an event raised when a form is posted to the server.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
Syntax

Visual Basic (Declaration)
Sub RaisePostBackEvent ( _
    eventArgument As String _
)
Visual Basic (Usage)
Dim instance As IPostBackEventHandler
Dim eventArgument As String

instance.RaisePostBackEvent(eventArgument)
C#
void RaisePostBackEvent(
    string eventArgument
)
Visual C++
void RaisePostBackEvent(
    String^ eventArgument
)
JScript
function RaisePostBackEvent(
    eventArgument : String
)

Parameters

eventArgument
Type: System..::.String
A String that represents an optional event argument to be passed to the event handler.
Remarks

The page passes the value of the eventArgument parameter to the RaisePostBackEvent method of the control that implements the IPostBackEventHandler interface. This control also renders the HTML element that causes the postback to occur. If the control renders client-side script for postback, the argument from the script is passed in the eventArgument parameter. If the postback is caused by a simple submit operation, the eventArgument parameter is nullNothingnullptra null reference (Nothing in Visual Basic).

This method provides the functionality for many events implemented by HTML and Web server controls.

Examples

The following code example defines a custom button server control that causes postback, captures the postback event using the RaisePostBackEvent method, and raises a Click event on the server.

Visual Basic
Imports System
Imports System.Web.UI
Imports System.Collections
Imports System.Collections.Specialized

Namespace CustomControls    

    <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> Public Class MyButton
        Inherits Control
        Implements IPostBackEventHandler

        ' Define the Click event.
        Public Event Click As EventHandler


        ' Invoke delegates registered with the Click event.
        Protected Overridable Sub OnClick(e As EventArgs)            
            RaiseEvent Click(Me, e)
        End Sub


        ' Define the method of IPostBackEventHandler that raises change events.
        Public Sub RaisePostBackEvent(eventArgument As String) _
        Implements IPostBackEventHandler.RaisePostBackEvent

            OnClick(New EventArgs())
        End Sub       


        Protected Overrides Sub Render(output As HtmlTextWriter)
            output.Write("<INPUT TYPE = submit name = " & Me.UniqueID & _
                " Value = 'Click Me' />")
        End Sub

    End Class
End Namespace

C#
using System;
using System.Web.UI;
using System.Collections;
using System.Collections.Specialized;

namespace CustomControls {

   [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")]   
   public class MyButton: Control, IPostBackEventHandler {

      // Defines the Click event.
      public event EventHandler Click;

      //Invoke delegates registered with the Click event.
      protected virtual void OnClick(EventArgs e) {

         if (Click != null) {
            Click(this, e);
         }   
      }


      // Define the method of IPostBackEventHandler that raises change events.
      public void RaisePostBackEvent(string eventArgument){

         OnClick(new EventArgs());
      }


      protected override void Render(HtmlTextWriter output) {
         output.Write("<INPUT TYPE = submit name = " + this.UniqueID + 
            " Value = 'Click Me' />");   
      }
   }    
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
See Also

Reference

Other Resources

Tags :


Community Content

Tim Babamuratov
Repeater items with controls
Move binding of Repeater to Page_Load() to enable normal event processing by child controls of the Repeater control. Works even when the Repeater is inside the UpdatePanel.

Page view tracker