ClientScriptManager Klasse

Definition

Definiert Methoden zum Verwalten von Clientskripts in Webanwendungen.Defines methods for managing client scripts in Web applications.

public ref class ClientScriptManager sealed
public sealed class ClientScriptManager
type ClientScriptManager = class
Public NotInheritable Class ClientScriptManager
Vererbung
ClientScriptManager

Beispiele

Im folgenden Codebeispiel wird die Verwendung RegisterClientScriptBlock der-Methode ClientScriptManager der-Klasse veranschaulicht.The following code example demonstrates the use of the RegisterClientScriptBlock method of the ClientScriptManager class. Auf der Seite sind zwei Client Skripts definiert PopupScript:, die beim Laden der Seite eine Warnmeldung anzeigt, und ButtonClickScript, der einen Client Handler für das-Ereignis einer HTML onClick -Schaltfläche definiert.Two client scripts are defined in the page: PopupScript, which displays an alert message when the page is loaded, and ButtonClickScript, which defines a client handler for an HTML button's onClick event.

<%@ 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">
  public void Page_Load(Object sender, EventArgs e)
  {
    // Define the name and type of the client scripts on the page.
    String csname1 = "PopupScript";
    String csname2 = "ButtonClickScript";
    Type cstype = this.GetType();
        
    // Get a ClientScriptManager reference from the Page class.
    ClientScriptManager cs = Page.ClientScript;

    // Check to see if the startup script is already registered.
    if (!cs.IsStartupScriptRegistered(cstype, csname1))
    {
      String cstext1 = "alert('Hello World');";
      cs.RegisterStartupScript(cstype, csname1, cstext1, true);
    }

    // Check to see if the client script is already registered.
    if (!cs.IsClientScriptBlockRegistered(cstype, csname2))
    {
      StringBuilder cstext2 = new StringBuilder();
      cstext2.Append("<script type=\"text/javascript\"> function DoClick() {");
      cstext2.Append("Form1.Message.value='Text from client script.'} </");
      cstext2.Append("script>");
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), false);
    }
  }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </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)

    ' Define the name and type of the client scripts on the page.
    Dim csname1 As String = "PopupScript"
    Dim csname2 As String = "ButtonClickScript"
    Dim cstype As Type = Me.GetType()
    
    ' Get a ClientScriptManager reference from the Page class.
    Dim cs As ClientScriptManager = Page.ClientScript

    ' Check to see if the startup script is already registered.
    If (Not cs.IsStartupScriptRegistered(cstype, csname1)) Then
      
      Dim cstext1 As String = "alert('Hello World');"
      cs.RegisterStartupScript(cstype, csname1, cstext1, True)
      
    End If
    
    ' Check to see if the client script is already registered.
    If (Not cs.IsClientScriptBlockRegistered(cstype, csname2)) Then
      
      Dim cstext2 As New StringBuilder()
            cstext2.Append("<script type=""text/javascript""> function DoClick() {")
      cstext2.Append("Form1.Message.value='Text from client script.'} </")
      cstext2.Append("script>")
      cs.RegisterClientScriptBlock(cstype, csname2, cstext2.ToString(), False)
      
    End If
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ClientScriptManager Example</title>
  </head>
  <body>
     <form id="Form1"
         runat="server">
        <input type="text" id="Message" /> <input type="button" value="ClickMe" onclick="DoClick()" />
     </form>
  </body>
</html>

Hinweise

Die ClientScriptManager -Klasse wird zum Verwalten von Client Skripts und zum Hinzufügen zu Webanwendungen verwendet.The ClientScriptManager class is used to manage client scripts and add them to Web applications. Sie können einen Verweis auf die ClientScriptManager -Klasse von der ClientScript -Eigenschaft des Page -Objekts erhalten.You can get a reference to the ClientScriptManager class from the ClientScript property of the Page object.

Sie können einer Webseite ein Client Skript deklarativ hinzufügen, indem Sie das Skript in das HTML-Markup der Seite einschließen.You can add a client script to a Web page declaratively by including the script in the HTML markup of the page. Es gibt jedoch Situationen, in denen das dynamische Hinzufügen von Client Skripts erforderlich ist.However, there are situations when adding client script dynamically is needed. Wenn Sie ein Skript dynamisch hinzufügen möchten RegisterClientScriptBlock , verwenden Sie RegisterClientScriptInclude die-Methode RegisterStartupScript , die-Methode RegisterOnSubmitStatement , die-Methode oder die-Methode, je nachdem, wann und wie Sie das Skript hinzufügen möchten.To add a script dynamically, use the RegisterClientScriptBlock method, the RegisterClientScriptInclude method, the RegisterStartupScript method, or the RegisterOnSubmitStatement method, depending on when and how you want to add the script. Weitere Informationen finden Sie unter Vorgehensweise: Fügen Sie das Client Skript dynamischzu ASP.net Web Pages hinzu.For more information, see How to: Add Client Script Dynamically to ASP.NET Web Pages.

Die ClientScriptManager -Klasse identifiziert Skripts durch einen String Schlüssel und Typeeinen eindeutig.The ClientScriptManager class uniquely identifies scripts by a key String and a Type. Skripts mit demselben Schlüssel und Typ werden als Duplikate angesehen.Scripts with the same key and type are considered duplicates. Mit dem Skripttyp können Sie vermeiden, dass ähnliche Skripts von unterschiedlichen Benutzer Steuerelementen verwechselt werden, die auf der Seite verwendet werden könnten.Using the script type helps to avoid confusing similar scripts from different user controls that might be in use on the page.

Die ClientScriptManager -Klasse kann verwendet werden, um Client Rückrufe in Situationen aufzurufen, in denen es wünschenswert ist, Servercode vom Client auszuführen, ohne ein Postback auszuführen.The ClientScriptManager class can be used to invoke client callbacks in situations when it is desirable to run server code from the client without performing a postback. Dies wird als Ausführen eines Out-of-Band-Rückrufs an den Server bezeichnet.This is referred to as performing an out-of-band callback to the server. Bei einem Client Rückruf sendet eine Client Skriptfunktion eine asynchrone Anforderung an eine ASP.NET-Webseite.In a client callback, a client script function sends an asynchronous request to an ASP.NET Web page. Die Webseite führt eine geänderte Version des normalen Lebenszyklus aus, um den Rückruf zu verarbeiten.The Web page runs a modified version of its normal life cycle to process the callback. Verwenden Sie GetCallbackEventReference die-Methode zum Abrufen eines Verweises auf eine Client Funktion, die beim Aufrufen einen Client Rückruf für ein Server Ereignis auslöst.Use the GetCallbackEventReference method to obtain a reference to a client function that, when invoked, initiates a client callback to a server event. Weitere Informationen finden Sie unter Implementieren von Client Rückrufen ohne Postbacks.For more information, see Implementing Client Callbacks Without Postbacks.

Hinweis

Skript Rückrufe funktionieren in älteren Browsern nicht, die die Dokumentobjektmodell (DOM) nicht unterstützen, und erfordern, dass ECMAScript auf dem Client aktiviert ist.Script callbacks will not work in older browsers that do not support the Document Object Model (DOM), and they require that ECMAScript is enabled on the client. Um zu prüfen, ob der Browser Rückrufe unterstützt SupportsCallback , verwenden Sie die-Eigenschaft, Browser auf die über die- Request Eigenschaft des systeminternen ASP.NET-Objekts zugegriffen werden kann.To check if the browser supports callbacks, use the SupportsCallback property, which is accessible through the Browser property of the ASP.NET intrinsic Request object.

Verwenden Sie GetPostBackEventReference die-Methode GetPostBackClientHyperlink und die-Methode, um ein Client Postback-Ereignis zu definieren.Use the GetPostBackEventReference method and the GetPostBackClientHyperlink method to define a client postback event. Diese Methoden aktivieren Client Skriptfunktionen, wenn Sie aufgerufen werden, um den Server zur Seite zurückzukehren.These methods enable client script functions, when invoked, to cause the server to post back to the page. Ein Client-Post Back Ereignis unterscheidet sich von einem Client Rückruf darin, dass die Webseite einen normalen Lebenszyklus für die Verarbeitung des Client Postback-Ereignisses abschließt.A client postback event is different from a client callback in that the Web page completes a normal life cycle to process the client postback event.

Hinweis

Button Wenn Sie ein-Steuerelement verwenden und UseSubmitBehavior die-Eigenschaft auf falsefestgelegt ist, können Sie GetPostBackEventReference die-Methode verwenden, um das Client Postback Button -Ereignis für das-Steuerelement zurückzugeben.If you are using a Button control and the UseSubmitBehavior property is set to false, then you can use the GetPostBackEventReference method to return the client postback event for the Button control.

Die OnClientClick -Eigenschaft Button des Steuer Elements ImageButton , des Steuer LinkButton Elements und des Steuer Elements kann zum Ausführen des Client Skripts verwendet werden.The OnClientClick property of the Button control, ImageButton control, and LinkButton control can be used to run client script.

Methoden

Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetCallbackEventReference(Control, String, String, String)

Ruft einen Verweis auf eine Clientfunktion ab, die beim Aufruf einen Clientrückruf für ein Serverereignis initiiert.Obtains a reference to a client function that, when invoked, initiates a client call back to a server event. Die Clientfunktion für diese überladene Methode schließt ein angegebenes Steuerelement, ein Argument, ein Clientskript sowie einen Kontext ein.The client function for this overloaded method includes a specified control, argument, client script, and context.

GetCallbackEventReference(Control, String, String, String, Boolean)

Ruft einen Verweis auf eine Clientfunktion ab, die beim Aufruf einen Clientrückruf für Serverereignisse initiiert.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Die Clientfunktion für diese überladene Methode schließt ein angegebenes Steuerelement, ein Argument, ein Clientskript, einen Kontext sowie einen booleschen Wert ein.The client function for this overloaded method includes a specified control, argument, client script, context, and Boolean value.

GetCallbackEventReference(Control, String, String, String, String, Boolean)

Ruft einen Verweis auf eine Clientfunktion ab, die beim Aufruf einen Clientrückruf für Serverereignisse initiiert.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Die Clientfunktion für diese überladene Methode schließt ein angegebenes Steuerelement, ein Argument, ein Clientskript, einen Kontext, einen Fehlerhandler sowie einen booleschen Wert ein.The client function for this overloaded method includes a specified control, argument, client script, context, error handler, and Boolean value.

GetCallbackEventReference(String, String, String, String, String, Boolean)

Ruft einen Verweis auf eine Clientfunktion ab, die beim Aufruf einen Clientrückruf für Serverereignisse initiiert.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Die Clientfunktion für diese überladene Methode schließt ein angegebenes Ziel, ein Argument, ein Clientskript, einen Kontext, einen Fehlerhandler sowie einen booleschen Wert ein.The client function for this overloaded method includes a specified target, argument, client script, context, error handler, and Boolean value.

GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetPostBackClientHyperlink(Control, String)

Ruft einen Verweis ab, an dessen Beginn javascript: angefügt ist und der in einem Clientereignis verwendet werden kann, das für das angegebene Steuerelement und mit den angegebenen Ereignisargumenten an den Server zurückgesendet werden soll.Gets a reference, with javascript: appended to the beginning of it, that can be used in a client event to post back to the server for the specified control and with the specified event arguments.

GetPostBackClientHyperlink(Control, String, Boolean)

Ruft einen Verweis ab, an dessen Beginn javascript: angefügt ist und der in einem Clientereignis verwendet werden kann, das für das angegebene Steuerelement mit den angegebenen Ereignisargumenten und dem booleschen Wert, der angibt, ob das Postback für die Ereignisvalidierung registriert werden soll, an den Server zurückgesendet wird.Gets a reference, with javascript: appended to the beginning of it, that can be used in a client event to post back to the server for the specified control with the specified event arguments and Boolean indication whether to register the post back for event validation.

GetPostBackEventReference(Control, String)

Gibt eine Zeichenfolge zurück, die in einem Clientereignis zum Auslösen eines Postbacks an den Server verwendet werden kann.Returns a string that can be used in a client event to cause postback to the server. Die Verweiszeichenfolge wird durch das angegebene Steuerelement definiert, das das Postback behandelt, und einem Zeichenfolgenargument mit weiteren Ereignisinformationen.The reference string is defined by the specified control that handles the postback and a string argument of additional event information.

GetPostBackEventReference(Control, String, Boolean)

Gibt eine Zeichenfolge zurück, die in einem Clientereignis zum Auslösen eines Postbacks an den Server verwendet werden kann.Returns a string to use in a client event to cause postback to the server. Die Verweiszeichenfolge wird durch das angegebene Steuerelement definiert, das das Postback behandelt, und einem Zeichenfolgenargument mit weiteren Ereignisinformationen.The reference string is defined by the specified control that handles the postback and a string argument of additional event information. Registriert den Ereignisverweis optional für die Validierung.Optionally, registers the event reference for validation.

GetPostBackEventReference(PostBackOptions)

Gibt eine Zeichenfolge zurück, die in einem Clientereignis zum Auslösen eines Postbacks an den Server verwendet werden kann.Returns a string that can be used in a client event to cause postback to the server. Die Verweiszeichenfolge wird von der angegebenen PostBackOptions-Instanz definiert.The reference string is defined by the specified PostBackOptions instance.

GetPostBackEventReference(PostBackOptions, Boolean)

Gibt eine Zeichenfolge zurück, die in einem Clientereignis zum Auslösen eines Postbacks an den Server verwendet werden kann.Returns a string that can be used in a client event to cause postback to the server. Die Verweiszeichenfolge wird vom angegebenen PostBackOptions-Objekt definiert.The reference string is defined by the specified PostBackOptions object. Registriert den Ereignisverweis optional für die Validierung.Optionally, registers the event reference for validation.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
GetWebResourceUrl(Type, String)

Ruft einen URL-Verweis auf eine Ressource in einer Assembly ab.Gets a URL reference to a resource in an assembly.

IsClientScriptBlockRegistered(String)

Bestimmt unter Verwendung des angegebenen Schlüssels, ob der Clientskriptblock für das Page-Objekt registriert ist.Determines whether the client script block is registered with the Page object using the specified key.

IsClientScriptBlockRegistered(Type, String)

Bestimmt unter Verwendung des Schlüssels und des Typs, ob der Clientskriptblock für das Page-Objekt registriert ist.Determines whether the client script block is registered with the Page object using a key and type.

IsClientScriptIncludeRegistered(String)

Bestimmt unter Verwendung des angegebenen Schlüssels, ob der Clientskriptinclude für das Page-Objekt registriert ist.Determines whether the client script include is registered with the Page object using the specified key.

IsClientScriptIncludeRegistered(Type, String)

Bestimmt unter Verwendung des Schlüssels und des Typs, ob der Clientskriptinclude für das Page-Objekt registriert ist.Determines whether the client script include is registered with the Page object using a key and type.

IsOnSubmitStatementRegistered(String)

Bestimmt anhand des angegebenen Schlüssels, ob die OnSubmit-Anweisung für das Page-Objekt registriert ist.Determines whether the OnSubmit statement is registered with the Page object using the specified key.

IsOnSubmitStatementRegistered(Type, String)

Bestimmt unter Verwendung des angegebenen Schlüssels und Typs, ob die OnSubmit-Anweisung für das Page-Objekt registriert ist.Determines whether the OnSubmit statement is registered with the Page object using the specified key and type.

IsStartupScriptRegistered(String)

Bestimmt unter Verwendung des angegebenen Schlüssels, ob das Startskript für das Page-Objekt registriert ist.Determines whether the startup script is registered with the Page object using the specified key.

IsStartupScriptRegistered(Type, String)

Bestimmt unter Verwendung des angegebenen Schlüssels und Typs, ob das Startskript für das Page-Objekt registriert ist.Determines whether the startup script is registered with the Page object using the specified key and type.

MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
RegisterArrayDeclaration(String, String)

Registriert unter Verwendung eines Arraynamens und eines Arraytyps eine JavaScript-Arraydeklaration für ein Page-Objekt.Registers a JavaScript array declaration with the Page object using an array name and array value.

RegisterClientScriptBlock(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels und eines Skriptliterals das Clientskript für das Page-Objekt.Registers the client script with the Page object using a type, key, and script literal.

RegisterClientScriptBlock(Type, String, String, Boolean)

Registriert unter Verwendung eines Typs, eines Schlüssels, eines Skriptliterals sowie eines booleschen Werts, der angibt, ob Skripttags hinzugefügt werden sollen, das Clientskript für das Page-Objekt.Registers the client script with the Page object using a type, key, script literal, and Boolean value indicating whether to add script tags.

RegisterClientScriptInclude(String, String)

Registriert das Clientskript beim Page-Objekt mit einem Schlüssel und einer URL, wodurch das Skript vom Client aufgerufen werden kann.Registers the client script with the Page object using a key and a URL, which enables the script to be called from the client.

RegisterClientScriptInclude(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels sowie einer URL den Clientskriptinclude für das Page-Objekt.Registers the client script include with the Page object using a type, a key, and a URL.

RegisterClientScriptResource(Type, String)

Registriert die Clientskriptressource unter Verwendung eines Typ und eines Ressourcennamens für das Page-Objekt.Registers the client script resource with the Page object using a type and a resource name.

RegisterExpandoAttribute(String, String, String)

Registriert ein Name-Wert-Paar mithilfe einer bestimmten Steuerelement-ID, eines Attributnamens und eines Attributwerts als benutzerdefiniertes Attribut (Expando-Attribut) des angegebenen Steuerelements.Registers a name/value pair as a custom (expando) attribute of the specified control given a control ID, attribute name, and attribute value.

RegisterExpandoAttribute(String, String, String, Boolean)

Registriert ein Name-Wert-Paar mithilfe einer bestimmten Steuerelement-ID, eines Attributnamens und eines Attributwerts sowie eines booleschen Werts (der angibt, ob der Attributwert codiert werden soll) als benutzerdefiniertes Attribut (Expando-Attribut) des angegebenen Steuerelements.Registers a name/value pair as a custom (expando) attribute of the specified control given a control ID, an attribute name, an attribute value, and a Boolean value indicating whether to encode the attribute value.

RegisterForEventValidation(PostBackOptions)

Registriert einen Ereignisverweis für die Validierung bei PostBackOptions.Registers an event reference for validation with PostBackOptions.

RegisterForEventValidation(String)

Registriert einen Ereignisverweis für die Validierung bei einer eindeutigen Steuerelement-ID, die das Clientsteuerelement darstellt, das das Ereignis generiert.Registers an event reference for validation with a unique control ID representing the client control generating the event.

RegisterForEventValidation(String, String)

Registriert einen Ereignisverweis für die Validierung bei einer eindeutigen Steuerelement-ID und Ereignisargumenten, die das Clientsteuerelement darstellen, das das Ereignis generiert.Registers an event reference for validation with a unique control ID and event arguments representing the client control generating the event.

RegisterHiddenField(String, String)

Registriert einen ausgeblendeten Wert für das Page-Objekt.Registers a hidden value with the Page object.

RegisterOnSubmitStatement(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels sowie eines Skriptliterals eine OnSubmit-Anweisung für das Page-Objekt.Registers an OnSubmit statement with the Page object using a type, a key, and a script literal. Die Anweisung wird beim Übermitteln des HtmlForm ausgeführt.The statement executes when the HtmlForm is submitted.

RegisterStartupScript(Type, String, String)

Registriert unter Verwendung eines Typs, eines Schlüssels und eines Skriptliterals das Startskript für das Page-Objekt.Registers the startup script with the Page object using a type, a key, and a script literal.

RegisterStartupScript(Type, String, String, Boolean)

Registriert unter Verwendung eines Typs, eines Schlüssels, eines Skriptliterals sowie eines booleschen Werts, der angibt, ob Skripttags hinzugefügt werden sollen, das Startskript für das Page-Objekt.Registers the startup script with the Page object using a type, a key, a script literal, and a Boolean value indicating whether to add script tags.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)
ValidateEvent(String)

Validiert ein Clientereignis, das mit der RegisterForEventValidation(String)-Methode für die Ereignisvalidierung registriert wurde.Validates a client event that was registered for event validation using the RegisterForEventValidation(String) method.

ValidateEvent(String, String)

Validiert ein Clientereignis, das mit der RegisterForEventValidation(String, String)-Methode für die Ereignisvalidierung registriert wurde.Validates a client event that was registered for event validation using the RegisterForEventValidation(String, String) method.

Gilt für:

Siehe auch