GetPostBackEventReference Method (Control)

Page.GetPostBackEventReference Method (Control)

Note: This API is now obsolete.

Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified Control object.

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

[ObsoleteAttribute("The recommended alternative is ClientScript.GetPostBackEventReference.")]
public string GetPostBackEventReference(
	Control control


Type: System.Web.UI.Control

The server control to process the postback on the server.

Return Value

Type: System.String

A string that, when treated as script on the client, initiates the postback.

This method has been deprecated. Use the GetPostBackEventReference method in the ClientScriptManager class instead.

Legacy Code Example

// This utility method creates a RolloverItem 
// and adds it to a ToolStrip control.
private RolloverItem CreateRolloverItem(
    ToolStrip owningToolStrip,
    string txt,
    Font f,
    string imgKey,
    TextImageRelation tir,
    string backImgKey)
    RolloverItem item = new RolloverItem();

    item.Alignment = ToolStripItemAlignment.Left;
    item.AllowDrop = false;
    item.AutoSize = true;

    item.BackgroundImage = owningToolStrip.ImageList.Images[backImgKey];
    item.BackgroundImageLayout = ImageLayout.Center;
    item.DisplayStyle = ToolStripItemDisplayStyle.ImageAndText;
    item.DoubleClickEnabled = true;
    item.Enabled = true;
    item.Font = f;

    // These assignments are equivalent. Each assigns an
    // image from the owning toolstrip's image list.
    item.ImageKey = imgKey;
    //item.Image = owningToolStrip.ImageList.Images[infoIconKey];
    //item.ImageIndex = owningToolStrip.ImageList.Images.IndexOfKey(infoIconKey);
    item.ImageScaling = ToolStripItemImageScaling.None;

    item.Owner = owningToolStrip;
    item.Padding = new Padding(2);
    item.Text = txt;
    item.TextAlign = ContentAlignment.MiddleLeft;
    item.TextDirection = ToolStripTextDirection.Horizontal;
    item.TextImageRelation = tir;

    return item;

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft