Page.RegisterArrayDeclaration(String, String) Method

Definition

Warning

This API is now obsolete.

Declares a value that is declared as an ECMAScript array declaration when the page is rendered.

public:
 void RegisterArrayDeclaration(System::String ^ arrayName, System::String ^ arrayValue);
[System.Obsolete("The recommended alternative is ClientScript.RegisterArrayDeclaration(string arrayName, string arrayValue). https://go.microsoft.com/fwlink/?linkid=14202")]
public void RegisterArrayDeclaration (string arrayName, string arrayValue);
member this.RegisterArrayDeclaration : string * string -> unit
Public Sub RegisterArrayDeclaration (arrayName As String, arrayValue As String)

Parameters

arrayName
String

The name of the array in which to declare the value.

arrayValue
String

The value to place in the array.

Attributes

Examples

The following code example uses the RegisterArrayDeclaration method to declare an array, myArray, that contains three objects named x, y, and z. The example defines and registers a startup script using the RegisterStartupScript method. When the ECMAScript doClick function is called from the page that contains this code, the array and its objects are initialized.

void Page_Load(Object sender, EventArgs e) 
{ 
   String scriptString = "<script language=\"JavaScript\"> function doClick() {";
   scriptString += "for(var index=0;index < myArray.length;index++)";
   scriptString += " myArray[index].show(); } <";
   scriptString += "/" + "script>";
     
   RegisterStartupScript("arrayScript", scriptString); 
   RegisterArrayDeclaration("myArray", "new obj('x'),new obj('y'),new obj('z')"); 
} 

      Dim scriptString As String = "<script language=""JavaScript""> function doClick() {"
 scriptString += "for(var index=0;index < myArray.length;index++)"
 scriptString += " myArray[index].show(); } <"
 scriptString += "/" + "script>"
   
 RegisterStartupScript("arrayScript", scriptString)
 RegisterArrayDeclaration("myArray", "new obj('x'),new obj('y'),new obj('z')")

Remarks

This method can be used by script-based controls to declare themselves within an array so that a client script library can work with all the controls of the same type.

The RegisterArrayDeclaration method has been deprecated. Use the RegisterArrayDeclaration method in the ClientScriptManager class.

Applies to

See also