ScriptManager.RegisterDataItem ScriptManager.RegisterDataItem ScriptManager.RegisterDataItem Method

Definición

Envía datos personalizados a los controles durante la representación parcial de la página.Sends custom data to controls during partial-page rendering.

Sobrecargas

RegisterDataItem(Control, String) RegisterDataItem(Control, String) RegisterDataItem(Control, String)

Envía datos personalizados a un control durante la representación parcial de la página.Sends custom data to a control during partial-page rendering.

RegisterDataItem(Control, String, Boolean) RegisterDataItem(Control, String, Boolean) RegisterDataItem(Control, String, Boolean)

Envía datos personalizados a un control durante la representación parcial de la página e indica si los datos están en formato JavaScript Object Notation (JSON).Sends custom data to a control during partial-page rendering, and indicates whether the data is in JavaScript Object Notation (JSON) format.

RegisterDataItem(Control, String) RegisterDataItem(Control, String) RegisterDataItem(Control, String)

Envía datos personalizados a un control durante la representación parcial de la página.Sends custom data to a control during partial-page rendering.

public:
 void RegisterDataItem(System::Web::UI::Control ^ control, System::String ^ dataItem);
public void RegisterDataItem (System.Web.UI.Control control, string dataItem);
member this.RegisterDataItem : System.Web.UI.Control * string -> unit

Parámetros

control
Control Control Control

Control que recibe los datos.The control that is receiving the data.

dataItem
String String String

Datos que se envían al control.The data that is sent to the control.

Excepciones

dataItem ya se encuentra registrado para control.dataItem is already registered for control.

Ejemplos

El ejemplo siguiente muestra cómo enviar datos a dos Label controles en una página durante un postback asincrónico.The following example shows how to send data to two Label controls on a page during an asynchronous postback. El Label controles no son dentro un UpdatePanel control.The Label controls are not inside an UpdatePanel control.

Nota

Los datos que se envían en este ejemplo tienen solo fines ilustrativos.The data that is sent in this example is for illustration only. En una aplicación real, se utilizaría el RegisterDataItem método para enviar datos personalizados desde el servidor.In a real-world application, you would use the RegisterDataItem method to send custom data from the server.

<%@ Page Language="C#" %>

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

<script runat="server">

    protected void Page_Load(object sender, EventArgs e)
    {
        if (ScriptManager1.IsInAsyncPostBack)
        {
            System.Web.Script.Serialization.JavaScriptSerializer json =
                new System.Web.Script.Serialization.JavaScriptSerializer();
            ScriptManager1.RegisterDataItem(Label1, DateTime.Now.ToString());
            ScriptManager1.RegisterDataItem(Label2, json.Serialize("more data"), true);
        }
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ScriptManager RegisterDataItem Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    <asp:ScriptManager ID="ScriptManager1" runat="server" />
    <script type="text/javascript" language="javascript">
        Sys.WebForms.PageRequestManager.getInstance().add_pageLoading(PageLoadingHandler);
        function PageLoadingHandler(sender, args) {
            var dataItems = args.get_dataItems();
            if ($get('Label1') !== null)
                $get('Label1').innerHTML = dataItems['Label1'];
            if ($get('Label2') !== null)
                $get('Label2').innerHTML = dataItems['Label2'];
        }
    </script>
    <asp:UpdatePanel ID="UpdatePanel1" UpdateMode="Conditional" runat="server">
    <ContentTemplate>
       UpdatePanel content.
       <asp:Button ID="Button1" Text="Submit" runat="server" />
    </ContentTemplate>
    </asp:UpdatePanel>
    <hr />
    <asp:Label ID="Label1" runat="server" /> <br />
    <asp:Label ID="Label2" runat="server" />
    </div>
    </form>
</body>
</html>
<%@ Page Language="VB" %>

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

<script runat="server">

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        If (ScriptManager1.IsInAsyncPostBack) Then
            Dim json As New System.Web.Script.Serialization.JavaScriptSerializer
            ScriptManager1.RegisterDataItem(Label1, DateTime.Now.ToString())
            ScriptManager1.RegisterDataItem(Label2, json.Serialize("more data"), True)
        End If
    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ScriptManager RegisterDataItem Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    <asp:ScriptManager ID="ScriptManager1" runat="server" />
    <script type="text/javascript" language="javascript">
        Sys.WebForms.PageRequestManager.getInstance().add_pageLoading(PageLoadingHandler);
        function PageLoadingHandler(sender, args) {
            var dataItems = args.get_dataItems();
            if ($get('Label1') !== null)
                $get('Label1').innerHTML = dataItems['Label1'];
            if ($get('Label2') !== null)
                $get('Label2').innerHTML = dataItems['Label2'];
        }
    </script>
    <asp:UpdatePanel ID="UpdatePanel1" UpdateMode="Conditional" runat="server">
    <ContentTemplate>
       UpdatePanel content.
       <asp:Button ID="Button1" Text="Submit" runat="server" />
    </ContentTemplate>
    </asp:UpdatePanel>
    <hr />
    <asp:Label ID="Label1" runat="server" /> <br />
    <asp:Label ID="Label2" runat="server" />
    </div>
    </form>
</body>
</html>

Comentarios

Use la RegisterDataItem método para enviar datos desde el servidor al cliente durante los postbacks asincrónicos, independientemente de si es el control que recibe los datos dentro de un UpdatePanel control.Use the RegisterDataItem method to send data from the server to the client during asynchronous postbacks, regardless of whether the control receiving the data is inside an UpdatePanel control.

El RegisterDataItem se puede llamar el método solo durante un postback asincrónico.The RegisterDataItem method can be called only during an asynchronous postback. Para determinar si una devolución de datos es asincrónica, use la IsInAsyncPostBack propiedad.To determine whether a postback is asynchronous, use the IsInAsyncPostBack property. Este método invoca la sobrecarga que toma un parámetro denominado isJsonSerialized que se establece en false.This method invokes the overload that takes a parameter named isJsonSerialized that is set to false. Cuando el isJsonSerialized parámetro se establece en false, la cadena no se serializa como JavaScript Object Notation (JSON).When the isJsonSerialized parameter is set to false, the string is not serialized as JavaScript Object Notation (JSON). Para obtener más información sobre el formato JSON, consulte el Introducción a JSON sitio Web.For more information about the JSON format, see the Introducing JSON Web site.

Los elementos de datos que están registrados con el RegisterDataItem puede tener acceso a método en el script de cliente durante la pageLoading, pageLoaded, y endRequest eventos de la PageRequestManager objeto.The data items that are registered with the RegisterDataItem method can be accessed in client script during the pageLoading, pageLoaded, and endRequest events of the PageRequestManager object. Al controlar estos eventos, los datos personalizados se pasan en un objeto de argumento de evento.When you handle these events, the custom data is passed in an event argument object. Por ejemplo, si proporciona un controlador para el pageLoading eventos, los datos personalizados se pasan en el PageLoadingEventArgs (clase), que expone una propiedad.For example, if you provide a handler for the pageLoading event, the custom data is passed in the PageLoadingEventArgs class, which exposes a property.

Consulte también:

RegisterDataItem(Control, String, Boolean) RegisterDataItem(Control, String, Boolean) RegisterDataItem(Control, String, Boolean)

Envía datos personalizados a un control durante la representación parcial de la página e indica si los datos están en formato JavaScript Object Notation (JSON).Sends custom data to a control during partial-page rendering, and indicates whether the data is in JavaScript Object Notation (JSON) format.

public:
 void RegisterDataItem(System::Web::UI::Control ^ control, System::String ^ dataItem, bool isJsonSerialized);
public void RegisterDataItem (System.Web.UI.Control control, string dataItem, bool isJsonSerialized);
member this.RegisterDataItem : System.Web.UI.Control * string * bool -> unit

Parámetros

control
Control Control Control

Control de página que recibe los datos.The page control that is receiving the data.

dataItem
String String String

Datos que se envían al control.The data that is sent to the control.

isJsonSerialized
Boolean Boolean Boolean

Es true para indicar que dataItem se serializa como JSON; en caso contrario es false.true to indicate that dataItem is serialized as JSON; otherwise, false.

Excepciones

dataItem ya se encuentra registrado para control.dataItem is already registered for control.

Ejemplos

El ejemplo siguiente muestra cómo enviar datos a dos Label controles en una página durante un postback asincrónico.The following example shows how to send data to two Label controls on a page during an asynchronous postback. El Label controles no son dentro un UpdatePanel control.The Label controls are not inside an UpdatePanel control. En este ejemplo se muestra la sobrecarga que no tome el isJsonSerialized parámetro.This example shows the overload that does not take the isJsonSerialized parameter. En caso contrario, el procedimiento para recuperar el dataItems propiedad de la PageLoadingEventArgs objeto es igual que si no utilizó esa sobrecarga.Otherwise, the procedure for retrieving the dataItems property of the PageLoadingEventArgs object is the same as if you did not use that overload.

Nota

Los datos que se envían en este ejemplo tienen solo fines ilustrativos.The data that is sent in this example is for illustration only. En una aplicación real, se utilizaría el RegisterDataItem método para enviar datos personalizados desde el servidor.In a real-world application, you would use the RegisterDataItem method to send custom data from the server. Por ejemplo, podría utilizar el elemento de datos para enviar información sobre si se debe ocultar o mostrar elementos que no están dentro de cliente un UpdatePanel control.For example, you could use the data item to send information about whether to hide or show client elements that are not inside an UpdatePanel control.

<%@ Page Language="C#" %>

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

<script runat="server">

    protected void Page_Load(object sender, EventArgs e)
    {
        if (ScriptManager1.IsInAsyncPostBack)
        {
            System.Web.Script.Serialization.JavaScriptSerializer json =
                new System.Web.Script.Serialization.JavaScriptSerializer();
            ScriptManager1.RegisterDataItem(Label1, DateTime.Now.ToString());
            ScriptManager1.RegisterDataItem(Label2, json.Serialize("more data"), true);
        }
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ScriptManager RegisterDataItem Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    <asp:ScriptManager ID="ScriptManager1" runat="server" />
    <script type="text/javascript" language="javascript">
        Sys.WebForms.PageRequestManager.getInstance().add_pageLoading(PageLoadingHandler);
        function PageLoadingHandler(sender, args) {
            var dataItems = args.get_dataItems();
            if ($get('Label1') !== null)
                $get('Label1').innerHTML = dataItems['Label1'];
            if ($get('Label2') !== null)
                $get('Label2').innerHTML = dataItems['Label2'];
        }
    </script>
    <asp:UpdatePanel ID="UpdatePanel1" UpdateMode="Conditional" runat="server">
    <ContentTemplate>
       UpdatePanel content.
       <asp:Button ID="Button1" Text="Submit" runat="server" />
    </ContentTemplate>
    </asp:UpdatePanel>
    <hr />
    <asp:Label ID="Label1" runat="server" /> <br />
    <asp:Label ID="Label2" runat="server" />
    </div>
    </form>
</body>
</html>
<%@ Page Language="VB" %>

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

<script runat="server">

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        If (ScriptManager1.IsInAsyncPostBack) Then
            Dim json As New System.Web.Script.Serialization.JavaScriptSerializer
            ScriptManager1.RegisterDataItem(Label1, DateTime.Now.ToString())
            ScriptManager1.RegisterDataItem(Label2, json.Serialize("more data"), True)
        End If
    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ScriptManager RegisterDataItem Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    <asp:ScriptManager ID="ScriptManager1" runat="server" />
    <script type="text/javascript" language="javascript">
        Sys.WebForms.PageRequestManager.getInstance().add_pageLoading(PageLoadingHandler);
        function PageLoadingHandler(sender, args) {
            var dataItems = args.get_dataItems();
            if ($get('Label1') !== null)
                $get('Label1').innerHTML = dataItems['Label1'];
            if ($get('Label2') !== null)
                $get('Label2').innerHTML = dataItems['Label2'];
        }
    </script>
    <asp:UpdatePanel ID="UpdatePanel1" UpdateMode="Conditional" runat="server">
    <ContentTemplate>
       UpdatePanel content.
       <asp:Button ID="Button1" Text="Submit" runat="server" />
    </ContentTemplate>
    </asp:UpdatePanel>
    <hr />
    <asp:Label ID="Label1" runat="server" /> <br />
    <asp:Label ID="Label2" runat="server" />
    </div>
    </form>
</body>
</html>

Comentarios

Usa el RegisterDataItem método para enviar datos desde el servidor al cliente durante los postbacks asincrónicos, independientemente de si es el control que recibe los datos dentro de un UpdatePanel control.You use the RegisterDataItem method to send data from the server to the client during asynchronous postbacks, regardless of whether the control receiving the data is inside an UpdatePanel control.

Si el dataItem parámetro que se registra para control no se serializa como JSON, establezca el isJsonSerialized parámetro false.If the dataItem parameter that you register for control is not serialized as JSON, set the isJsonSerialized parameter to false. Esto evita la necesidad de usar el eval función para cada cadena que se envía al cliente.This avoids the need to use the eval function for each string that is sent to the client. Para obtener más información sobre el formato JSON, consulte el Introducción a JSON sitio Web.For more information about the JSON format, see the Introducing JSON Web site.

El RegisterDataItem se puede llamar el método solo durante un postback asincrónico.The RegisterDataItem method can be called only during an asynchronous postback. Para determinar si una devolución de datos es asincrónica, use la IsInAsyncPostBack propiedad.To determine whether a postback is asynchronous, use the IsInAsyncPostBack property.

Los elementos de datos que se registran mediante el RegisterDataItem puede tener acceso a método en el script de cliente durante la pageLoading, pageLoaded, y endRequest eventos de la PageRequestManager objeto.The data items that are registered by using the RegisterDataItem method can be accessed in client script during the pageLoading, pageLoaded, and endRequest events of the PageRequestManager object. Al controlar estos eventos, los datos personalizados se pasan en un objeto de argumento de evento.When you handle these events, the custom data is passed in an event argument object. Por ejemplo, si proporciona un controlador para el pageLoading eventos, los datos personalizados se pasan en el PageLoadingEventArgs (clase), que expone una propiedad.For example, if you provide a handler for the pageLoading event, the custom data is passed in the PageLoadingEventArgs class, which exposes a property.

Consulte también:

Se aplica a