ClientScriptManager Class

Definition

Définit des méthodes pour gérer des scripts clients dans des applications Web.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
Inheritance
ClientScriptManager

Examples

L’exemple de code suivant illustre l’utilisation de la méthode RegisterClientScriptBlock de la classe ClientScriptManager.The following code example demonstrates the use of the RegisterClientScriptBlock method of the ClientScriptManager class. Deux scripts clients sont définis dans la page : PopupScript, qui affiche un message d’alerte lorsque la page est chargée, et ButtonClickScript, qui définit un gestionnaire client pour l’événement onClick d’un bouton HTML.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>

Remarks

La classe ClientScriptManager permet de gérer les scripts client et de les ajouter aux applications Web.The ClientScriptManager class is used to manage client scripts and add them to Web applications. Vous pouvez obtenir une référence à la classe ClientScriptManager à partir de la propriété ClientScript de l’objet Page.You can get a reference to the ClientScriptManager class from the ClientScript property of the Page object.

Vous pouvez ajouter un script client à une page Web de façon déclarative en incluant le script dans le balisage HTML de la page.You can add a client script to a Web page declaratively by including the script in the HTML markup of the page. Toutefois, il existe des situations dans lesquelles l’ajout dynamique de script client est nécessaire.However, there are situations when adding client script dynamically is needed. Pour ajouter dynamiquement un script, utilisez la méthode RegisterClientScriptBlock, la méthode RegisterClientScriptInclude, la méthode RegisterStartupScript ou la méthode RegisterOnSubmitStatement, en fonction du moment et de la façon dont vous souhaitez ajouter le script.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. Pour plus d’informations, consultez Comment : ajouter dynamiquement un script client à pages Web ASP.net.For more information, see How to: Add Client Script Dynamically to ASP.NET Web Pages.

La classe ClientScriptManager identifie de façon unique les scripts à l’aide d’un String de clé et d’un Type.The ClientScriptManager class uniquely identifies scripts by a key String and a Type. Les scripts avec la même clé et le même type sont considérés comme des doublons.Scripts with the same key and type are considered duplicates. L’utilisation du type de script permet d’éviter la confusion de scripts similaires à partir de différents contrôles utilisateur qui peuvent être en cours d’utilisation sur la page.Using the script type helps to avoid confusing similar scripts from different user controls that might be in use on the page.

La classe ClientScriptManager peut être utilisée pour appeler des rappels de client dans les situations où il est souhaitable d’exécuter du code serveur à partir du client sans effectuer de publication (postback).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. On parle alors d’effectuer un rappel hors bande sur le serveur.This is referred to as performing an out-of-band callback to the server. Dans un rappel de client, une fonction de script client envoie une requête asynchrone à une page Web ASP.NET.In a client callback, a client script function sends an asynchronous request to an ASP.NET Web page. La page Web exécute une version modifiée du cycle de vie normal pour traiter le rappel.The Web page runs a modified version of its normal life cycle to process the callback. Utilisez la méthode GetCallbackEventReference pour obtenir une référence à une fonction cliente qui, lorsqu’elle est appelée, Initialise un rappel client à un événement de serveur.Use the GetCallbackEventReference method to obtain a reference to a client function that, when invoked, initiates a client callback to a server event. Pour plus d’informations, consultez implémentation de rappels clients sans publication (postback).For more information, see Implementing Client Callbacks Without Postbacks.

Note

Les rappels de script ne fonctionnent pas dans les navigateurs plus anciens qui ne prennent pas en charge le Document Object Model (DOM), et ils nécessitent l’activation d’ECMAScript sur le client.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. Pour vérifier si le navigateur prend en charge les rappels, utilisez la propriété SupportsCallback, accessible via la propriété Browser de l’objet Request intrinsèque ASP.NET.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.

Utilisez la méthode GetPostBackEventReference et la méthode GetPostBackClientHyperlink pour définir un événement de publication client.Use the GetPostBackEventReference method and the GetPostBackClientHyperlink method to define a client postback event. Ces méthodes permettent aux fonctions de script client, lorsqu’elles sont appelées, de forcer le serveur à effectuer une publication sur la page.These methods enable client script functions, when invoked, to cause the server to post back to the page. Un événement de publication client est différent d’un rappel de client en ce que la page Web termine un cycle de vie normal pour traiter l’événement de publication client.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.

Note

Si vous utilisez un contrôle Button et que la propriété UseSubmitBehavior a la valeur false, vous pouvez utiliser la méthode GetPostBackEventReference pour retourner l’événement de publication client pour le contrôle Button.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.

La propriété OnClientClick du contrôle Button, du contrôle ImageButton et du contrôle LinkButton peut être utilisée pour exécuter le script client.The OnClientClick property of the Button control, ImageButton control, and LinkButton control can be used to run client script.

Methods

Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetCallbackEventReference(Control, String, String, String)

Obtient la référence à une fonction cliente qui, lorsqu'elle est appelée, entraîne un rappel d'un événement serveur par le client.Obtains a reference to a client function that, when invoked, initiates a client call back to a server event. La fonction cliente de cette méthode surchargée inclut un contrôle, un argument, un script client et un contexte spécifiés.The client function for this overloaded method includes a specified control, argument, client script, and context.

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

Obtient la référence à une fonction cliente qui, lorsqu'elle est appelée, entraîne un rappel d'événements serveur par le client.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. La fonction cliente de cette méthode surchargée inclut un contrôle, un argument, un script client, un contexte et une valeur booléenne spécifiés.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)

Obtient la référence à une fonction cliente qui, lorsqu'elle est appelée, entraîne un rappel d'événements serveur par le client.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. La fonction cliente de cette méthode surchargée inclut un contrôle, un argument, un script client, un contexte, un gestionnaire d'erreurs et une valeur booléenne spécifiés.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)

Obtient la référence à une fonction cliente qui, lorsqu'elle est appelée, entraîne un rappel d'événements serveur par le client.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. La fonction cliente de cette méthode surchargée inclut une cible, un argument, un script client, un contexte, un gestionnaire d'erreurs et une valeur booléenne spécifiés.The client function for this overloaded method includes a specified target, argument, client script, context, error handler, and Boolean value.

GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetPostBackClientHyperlink(Control, String)

Obtient une référence, avec javascript: ajouté en début, pouvant être utilisée dans un événement client pour republier sur le serveur pour le contrôle spécifié et avec les arguments d'événement spécifiés.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)

Obtient une référence, avec javascript: ajouté en début, pouvant être utilisée dans un événement client pour republier sur le serveur pour le contrôle spécifié avec les arguments d'événement spécifiés et une indication booléenne précisant s'il faut inscrire la publication pour la validation d'événement.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)

Retourne une chaîne qui peut être utilisée dans un événement client pour provoquer une publication (postback) sur le serveur.Returns a string that can be used in a client event to cause postback to the server. La chaîne de référence est définie par le contrôle spécifié qui gère la publication (postback) et un argument de chaîne d'autres informations d'événement.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)

Retourne une chaîne à utiliser dans un événement client pour provoquer une publication sur le serveur.Returns a string to use in a client event to cause postback to the server. La chaîne de référence est définie par le contrôle spécifié qui gère la publication (postback) et un argument de chaîne d'autres informations d'événement.The reference string is defined by the specified control that handles the postback and a string argument of additional event information. Inscrit en option la référence d'événement pour la validation.Optionally, registers the event reference for validation.

GetPostBackEventReference(PostBackOptions)

Retourne une chaîne qui peut être utilisée dans un événement client pour provoquer une publication (postback) sur le serveur.Returns a string that can be used in a client event to cause postback to the server. La chaîne de référence est définie par l'instance de PostBackOptions spécifiée.The reference string is defined by the specified PostBackOptions instance.

GetPostBackEventReference(PostBackOptions, Boolean)

Retourne une chaîne qui peut être utilisée dans un événement client pour provoquer une publication (postback) sur le serveur.Returns a string that can be used in a client event to cause postback to the server. La chaîne de référence est définie par l'objet PostBackOptions spécifié.The reference string is defined by the specified PostBackOptions object. Inscrit en option la référence d'événement pour la validation.Optionally, registers the event reference for validation.

GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
GetWebResourceUrl(Type, String)

Obtient une référence de type URL à une ressource dans un assembly.Gets a URL reference to a resource in an assembly.

IsClientScriptBlockRegistered(String)

Détermine si le bloc de script client est inscrit avec l'objet Page à l'aide de la clé spécifiée.Determines whether the client script block is registered with the Page object using the specified key.

IsClientScriptBlockRegistered(Type, String)

Détermine si le bloc de script client est inscrit avec l'objet Page à l'aide d'une clé et d'un type.Determines whether the client script block is registered with the Page object using a key and type.

IsClientScriptIncludeRegistered(String)

Détermine si le script client Include est inscrit avec l'objet Page à l'aide de la clé spécifiée.Determines whether the client script include is registered with the Page object using the specified key.

IsClientScriptIncludeRegistered(Type, String)

Détermine si le script client Include est inscrit avec l'objet Page à l'aide d'une clé et d'un type.Determines whether the client script include is registered with the Page object using a key and type.

IsOnSubmitStatementRegistered(String)

Détermine si l'instruction OnSubmit est inscrite avec l'objet Page à l'aide de la clé spécifiée.Determines whether the OnSubmit statement is registered with the Page object using the specified key.

IsOnSubmitStatementRegistered(Type, String)

Détermine si l'instruction OnSubmit est inscrite avec l'objet Page à l'aide de la clé et du type spécifiés.Determines whether the OnSubmit statement is registered with the Page object using the specified key and type.

IsStartupScriptRegistered(String)

Détermine si le script de démarrage est inscrit avec l'objet Page à l'aide de la clé spécifiée.Determines whether the startup script is registered with the Page object using the specified key.

IsStartupScriptRegistered(Type, String)

Détermine si le script de démarrage est inscrit avec l'objet Page à l'aide de la clé et du type spécifiés.Determines whether the startup script is registered with the Page object using the specified key and type.

MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
RegisterArrayDeclaration(String, String)

Inscrit une déclaration de tableau JavaScript avec l'objet Page à l'aide d'un nom de tableau et d'une valeur de tableau.Registers a JavaScript array declaration with the Page object using an array name and array value.

RegisterClientScriptBlock(Type, String, String)

Inscrit le script client avec l'objet Page à l'aide d'un type, d'une clé et d'un littéral de script.Registers the client script with the Page object using a type, key, and script literal.

RegisterClientScriptBlock(Type, String, String, Boolean)

Inscrit le script client avec l'objet Page à l'aide d'un type, d'une clé, d'un littéral de script et d'une valeur Boolean indiquant s'il faut ajouter des balises de script.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)

Enregistre le script client avec l'objet Page, à l'aide d'une clé et d'une URL, qui active le script à appeler à partir du client.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)

Inscrit le script client Include avec l'objet Page à l'aide d'un type, d'une clé et d'une URL.Registers the client script include with the Page object using a type, a key, and a URL.

RegisterClientScriptResource(Type, String)

Inscrit la ressource de script client avec l'objet Page à l'aide d'un type et d'un nom de ressource.Registers the client script resource with the Page object using a type and a resource name.

RegisterExpandoAttribute(String, String, String)

Inscrit une paire nom/valeur en tant qu'attribut personnalisé (expando) du contrôle spécifié en fonction d'un ID de contrôle, d'un nom d'attribut et d'une valeur d'attribut.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)

Inscrit une paire nom/valeur en tant qu'attribut personnalisé (expando) du contrôle spécifié selon un ID de contrôle, un nom d'attribut, une valeur d'attribut et une valeur Boolean qui indique s'il faut ou non encoder la valeur d'attribut.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)

Inscrit une référence d'événement pour la validation avec PostBackOptions.Registers an event reference for validation with PostBackOptions.

RegisterForEventValidation(String)

Inscrit une référence d'événement pour la validation avec un ID de contrôle unique qui représente le contrôle client qui génère l'événement.Registers an event reference for validation with a unique control ID representing the client control generating the event.

RegisterForEventValidation(String, String)

Inscrit une référence d'événement pour la validation avec un ID de contrôle unique et des arguments d'événement représentant le contrôle client qui génère l'événement.Registers an event reference for validation with a unique control ID and event arguments representing the client control generating the event.

RegisterHiddenField(String, String)

Inscrit une valeur masquée avec l'objet Page.Registers a hidden value with the Page object.

RegisterOnSubmitStatement(Type, String, String)

Inscrit une instruction OnSubmit avec l'objet Page à l'aide d'un type, d'une clé et d'un littéral de script.Registers an OnSubmit statement with the Page object using a type, a key, and a script literal. L'instruction s'exécute lorsque le HtmlForm est envoyé.The statement executes when the HtmlForm is submitted.

RegisterStartupScript(Type, String, String)

Inscrit le script de démarrage avec l'objet Page à l'aide d'un type, d'une clé et d'un littéral de script.Registers the startup script with the Page object using a type, a key, and a script literal.

RegisterStartupScript(Type, String, String, Boolean)

Inscrit le script de démarrage avec l'objet Page à l'aide d'un type, d'une clé, d'un littéral de script et d'une valeur Boolean indiquant s'il faut ajouter des balises de script.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()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)
ValidateEvent(String)

Valide un événement client qui a été inscrit pour la validation d'événement à l'aide de la méthode RegisterForEventValidation(String).Validates a client event that was registered for event validation using the RegisterForEventValidation(String) method.

ValidateEvent(String, String)

Valide un événement client qui a été inscrit pour la validation d'événement à l'aide de la méthode RegisterForEventValidation(String, String).Validates a client event that was registered for event validation using the RegisterForEventValidation(String, String) method.

Applies to

See also