ClientScriptManager Klasa

Definicja

Definiuje metody zarządzania skryptami klienta w aplikacjach sieci 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
Dziedziczenie
ClientScriptManager

Przykłady

Poniższy przykład kodu demonstruje użycie RegisterClientScriptBlock metody ClientScriptManager klasy.The following code example demonstrates the use of the RegisterClientScriptBlock method of the ClientScriptManager class. Na stronie są zdefiniowane dwa skrypty klienta: PopupScript , która wyświetla komunikat o alercie podczas ładowania strony, i ButtonClickScript definiuje procedurę obsługi klienta dla zdarzenia przycisku HTML onClick .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>

Uwagi

ClientScriptManagerKlasa służy do zarządzania skryptami klienta i dodawania ich do aplikacji sieci Web.The ClientScriptManager class is used to manage client scripts and add them to Web applications. Możesz uzyskać odwołanie do ClientScriptManager klasy z ClientScript właściwości Page obiektu.You can get a reference to the ClientScriptManager class from the ClientScript property of the Page object.

Skrypt klienta można dodać do strony sieci Web deklaratywnie poprzez dołączenie skryptu do znacznika HTML strony.You can add a client script to a Web page declaratively by including the script in the HTML markup of the page. Są jednak sytuacje, w których konieczna jest dynamiczna Dodawanie skryptu klienta.However, there are situations when adding client script dynamically is needed. Aby dynamicznie dodać skrypt, użyj metody, metody, RegisterClientScriptBlock RegisterClientScriptInclude RegisterStartupScript metody lub RegisterOnSubmitStatement metody, w zależności od tego, kiedy i jak chcesz dodać skrypt.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. Aby uzyskać więcej informacji, zobacz jak: dodać skrypt klienta dynamicznie do ASP.NET stron sieci Web.For more information, see How to: Add Client Script Dynamically to ASP.NET Web Pages.

ClientScriptManagerKlasa jednoznacznie identyfikuje skrypty za pomocą klucza String i Type .The ClientScriptManager class uniquely identifies scripts by a key String and a Type. Skrypty z tym samym kluczem i typem są uważane za duplikaty.Scripts with the same key and type are considered duplicates. Użycie typu skryptu pozwala uniknąć pomyłki podobnych skryptów z różnych kontrolek użytkownika, które mogą być używane na stronie.Using the script type helps to avoid confusing similar scripts from different user controls that might be in use on the page.

ClientScriptManagerKlasa może służyć do wywoływania wywołań zwrotnych klienta w sytuacjach, gdy jest to pożądane do uruchomienia kodu serwera z klienta bez konieczności ogłaszania zwrotnego.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. Jest to określane jako przeprowadzenie wywołania zwrotnego poza pasmem do serwera.This is referred to as performing an out-of-band callback to the server. W wywołaniu zwrotnym klienta funkcja skryptu klienta wysyła żądanie asynchroniczne do strony sieci Web ASP.NET.In a client callback, a client script function sends an asynchronous request to an ASP.NET Web page. Na stronie sieci Web jest uruchomiona zmodyfikowana wersja normalnego cyklu życia w celu przetworzenia wywołania zwrotnego.The Web page runs a modified version of its normal life cycle to process the callback. Użyj GetCallbackEventReference metody, aby uzyskać odwołanie do funkcji klienta, która po wywołaniu inicjuje wywołanie zwrotne klienta do zdarzenia serwera.Use the GetCallbackEventReference method to obtain a reference to a client function that, when invoked, initiates a client callback to a server event. Aby uzyskać więcej informacji, zobacz implementowanie wywołań zwrotnych klienta bez ogłaszania zwrotnego.For more information, see Implementing Client Callbacks Without Postbacks.

Uwaga

Wywołania zwrotne skryptu nie będą działały w starszych przeglądarkach, które nie obsługują Document Object Model (DOM) i wymagają włączenia języka ECMAScript na kliencie.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. Aby sprawdzić, czy przeglądarka obsługuje wywołania zwrotne, użyj SupportsCallback właściwości, która jest dostępna za pomocą Browser właściwości obiektu wewnętrznego ASP.NET Request .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.

Użyj GetPostBackEventReference metody i metody, GetPostBackClientHyperlink Aby zdefiniować zdarzenie ogłaszania zwrotnego klienta.Use the GetPostBackEventReference method and the GetPostBackClientHyperlink method to define a client postback event. Te metody umożliwiają włączenie funkcji skryptu klienta, gdy są wywoływane, aby serwer mógł ogłaszać z powrotem na stronie.These methods enable client script functions, when invoked, to cause the server to post back to the page. Zdarzenie ogłaszania zwrotnego klienta różni się od wywołania zwrotnego klienta w przypadku, gdy strona sieci Web zakończy normalny cykl życia, aby przetworzyć zdarzenie ogłaszania zwrotnego klienta.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.

Uwaga

Jeśli używasz Button kontrolki, a UseSubmitBehavior Właściwość jest ustawiona na, możesz false użyć GetPostBackEventReference metody do zwrócenia zdarzenia ogłaszania zwrotnego klienta dla Button kontrolki.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.

OnClientClickWłaściwość Button kontrolki, ImageButton kontrolki i LinkButton kontrolka może służyć do uruchamiania skryptu klienta.The OnClientClick property of the Button control, ImageButton control, and LinkButton control can be used to run client script.

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetCallbackEventReference(Control, String, String, String)

Uzyskuje odwołanie do funkcji klienta, która po wywołaniu inicjuje wywołanie klienta z powrotem do zdarzenia serwera.Obtains a reference to a client function that, when invoked, initiates a client call back to a server event. Funkcja klienta dla tej przeciążonej metody obejmuje określony formant, argument, skrypt klienta i kontekst.The client function for this overloaded method includes a specified control, argument, client script, and context.

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

Uzyskuje odwołanie do funkcji klienta, która po wywołaniu inicjuje wywołanie klienta z powrotem do zdarzeń serwera.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Funkcja klienta dla tej przeciążonej metody obejmuje określony formant, argument, skrypt klienta, kontekst i wartość logiczną.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)

Uzyskuje odwołanie do funkcji klienta, która po wywołaniu inicjuje wywołanie klienta z powrotem do zdarzeń serwera.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Funkcja klienta dla tej przeciążonej metody obejmuje określony formant, argument, skrypt klienta, kontekst, procedurę obsługi błędów i wartość logiczną.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)

Uzyskuje odwołanie do funkcji klienta, która po wywołaniu inicjuje wywołanie klienta z powrotem do zdarzeń serwera.Obtains a reference to a client function that, when invoked, initiates a client call back to server events. Funkcja klienta dla tej przeciążonej metody obejmuje określony element docelowy, argument, skrypt klienta, kontekst, procedurę obsługi błędów i wartość logiczną.The client function for this overloaded method includes a specified target, argument, client script, context, error handler, and Boolean value.

GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetPostBackClientHyperlink(Control, String)

Pobiera odwołanie z javascript: dołączonym do początku, które może być używane w zdarzeniu klienta do ogłaszania zwrotnego na serwerze dla określonej kontrolki i z określonymi argumentami zdarzeń.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)

Pobiera odwołanie, z javascript: dołączonym do początku, które może być używane w zdarzeniu klienta do ogłaszania zwrotnego na serwerze dla określonej kontrolki z określonymi argumentami zdarzeń i wskazywanie wartości logicznej, czy należy zarejestrować ogłoszenie z powrotem dla weryfikacji zdarzeń.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)

Zwraca ciąg, który może zostać użyty w zdarzeniu klienta w celu wypróbowania ogłaszania zwrotnego na serwerze.Returns a string that can be used in a client event to cause postback to the server. Ciąg odwołania jest definiowany przez określony formant, który obsługuje ogłaszanie zwrotne i argument ciągu dodatkowych informacji o zdarzeniu.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)

Zwraca ciąg, który ma być używany w zdarzeniu klienta, aby spowodować ogłaszanie zwrotne na serwerze.Returns a string to use in a client event to cause postback to the server. Ciąg odwołania jest definiowany przez określony formant, który obsługuje ogłaszanie zwrotne i argument ciągu dodatkowych informacji o zdarzeniu.The reference string is defined by the specified control that handles the postback and a string argument of additional event information. Opcjonalnie rejestruje odwołanie do zdarzenia na potrzeby walidacji.Optionally, registers the event reference for validation.

GetPostBackEventReference(PostBackOptions)

Zwraca ciąg, który może zostać użyty w zdarzeniu klienta w celu wypróbowania ogłaszania zwrotnego na serwerze.Returns a string that can be used in a client event to cause postback to the server. Ciąg odwołania jest definiowany przez określone PostBackOptions wystąpienie.The reference string is defined by the specified PostBackOptions instance.

GetPostBackEventReference(PostBackOptions, Boolean)

Zwraca ciąg, który może zostać użyty w zdarzeniu klienta w celu wypróbowania ogłaszania zwrotnego na serwerze.Returns a string that can be used in a client event to cause postback to the server. Ciąg odwołania jest definiowany przez określony PostBackOptions obiekt.The reference string is defined by the specified PostBackOptions object. Opcjonalnie rejestruje odwołanie do zdarzenia na potrzeby walidacji.Optionally, registers the event reference for validation.

GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
GetWebResourceUrl(Type, String)

Pobiera odwołanie do adresu URL do zasobu w zestawie.Gets a URL reference to a resource in an assembly.

IsClientScriptBlockRegistered(String)

Określa, czy blok skryptu klienta jest zarejestrowany w Page obiekcie przy użyciu określonego klucza.Determines whether the client script block is registered with the Page object using the specified key.

IsClientScriptBlockRegistered(Type, String)

Określa, czy blok skryptu klienta jest zarejestrowany w Page obiekcie przy użyciu klucza i typu.Determines whether the client script block is registered with the Page object using a key and type.

IsClientScriptIncludeRegistered(String)

Określa, czy skrypt klienta ma być zarejestrowany w Page obiekcie przy użyciu określonego klucza.Determines whether the client script include is registered with the Page object using the specified key.

IsClientScriptIncludeRegistered(Type, String)

Określa, czy skrypt klienta ma być zarejestrowany w Page obiekcie przy użyciu klucza i typu.Determines whether the client script include is registered with the Page object using a key and type.

IsOnSubmitStatementRegistered(String)

Określa, czy instrukcja onsubmit jest zarejestrowana w Page obiekcie przy użyciu określonego klucza.Determines whether the OnSubmit statement is registered with the Page object using the specified key.

IsOnSubmitStatementRegistered(Type, String)

Określa, czy instrukcja onsubmit jest zarejestrowana w Page obiekcie przy użyciu określonego klucza i typu.Determines whether the OnSubmit statement is registered with the Page object using the specified key and type.

IsStartupScriptRegistered(String)

Określa, czy skrypt uruchamiania jest zarejestrowany z Page obiektem przy użyciu określonego klucza.Determines whether the startup script is registered with the Page object using the specified key.

IsStartupScriptRegistered(Type, String)

Określa, czy skrypt uruchamiania jest zarejestrowany z Page obiektem przy użyciu określonego klucza i typu.Determines whether the startup script is registered with the Page object using the specified key and type.

MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
RegisterArrayDeclaration(String, String)

Rejestruje deklarację tablicy JavaScript z Page obiektem przy użyciu nazwy tablicy i wartości tablicy.Registers a JavaScript array declaration with the Page object using an array name and array value.

RegisterClientScriptBlock(Type, String, String)

Rejestruje skrypt klienta z Page obiektem przy użyciu typu, klucza i literału skryptu.Registers the client script with the Page object using a type, key, and script literal.

RegisterClientScriptBlock(Type, String, String, Boolean)

Rejestruje skrypt klienta z Page obiektem przy użyciu typu, klucza, literału skryptu i wartości logicznej wskazującej, czy dodać tagi skryptu.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)

Rejestruje skrypt klienta z Page obiektem przy użyciu klucza i adresu URL, co umożliwia wywoływanie skryptu z klienta programu.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)

Rejestruje skrypt klienta Dołącz do Page obiektu przy użyciu typu, klucza i adresu URL.Registers the client script include with the Page object using a type, a key, and a URL.

RegisterClientScriptResource(Type, String)

Rejestruje zasób skryptu klienta z Page obiektem przy użyciu typu i nazwy zasobu.Registers the client script resource with the Page object using a type and a resource name.

RegisterExpandoAttribute(String, String, String)

Rejestruje parę nazwa/wartość jako atrybut niestandardowy (Expand) dla określonej kontrolki, który ma identyfikator formantu, nazwę atrybutu i wartość atrybutu.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)

Rejestruje parę nazwa/wartość jako atrybut niestandardowy (Expand) dla określonej kontrolki, podając identyfikator kontrolki, nazwę atrybutu, wartość atrybutu i wartość logiczną wskazującą, czy należy zakodować wartość atrybutu.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)

Rejestruje odwołanie do zdarzenia na potrzeby walidacji za pomocą PostBackOptions .Registers an event reference for validation with PostBackOptions.

RegisterForEventValidation(String)

Rejestruje odwołanie do zdarzenia na potrzeby walidacji z unikatowym IDENTYFIKATORem formantu reprezentującym kontrolę klienta generującą zdarzenie.Registers an event reference for validation with a unique control ID representing the client control generating the event.

RegisterForEventValidation(String, String)

Rejestruje odwołanie do zdarzenia na potrzeby walidacji z unikatowym IDENTYFIKATORem kontrolki i argumentami zdarzeń reprezentującymi kontrolkę klienta generującą zdarzenie.Registers an event reference for validation with a unique control ID and event arguments representing the client control generating the event.

RegisterHiddenField(String, String)

Rejestruje ukrytą wartość przy użyciu Page obiektu.Registers a hidden value with the Page object.

RegisterOnSubmitStatement(Type, String, String)

Rejestruje instrukcję onsubmit z Page obiektem przy użyciu typu, klucza i literału skryptu.Registers an OnSubmit statement with the Page object using a type, a key, and a script literal. Instrukcja jest wykonywana, gdy HtmlForm zostanie przesłane.The statement executes when the HtmlForm is submitted.

RegisterStartupScript(Type, String, String)

Rejestruje skrypt uruchamiania z Page obiektem przy użyciu typu, klucza i literału skryptu.Registers the startup script with the Page object using a type, a key, and a script literal.

RegisterStartupScript(Type, String, String, Boolean)

Rejestruje skrypt uruchamiania z Page obiektem przy użyciu typu, klucza, literału skryptu i wartości logicznej wskazującej, czy dodać tagi skryptu.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()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)
ValidateEvent(String)

Sprawdza poprawność zdarzenia klienta zarejestrowanego pod kątem walidacji zdarzenia przy użyciu RegisterForEventValidation(String) metody.Validates a client event that was registered for event validation using the RegisterForEventValidation(String) method.

ValidateEvent(String, String)

Sprawdza poprawność zdarzenia klienta zarejestrowanego pod kątem walidacji zdarzenia przy użyciu RegisterForEventValidation(String, String) metody.Validates a client event that was registered for event validation using the RegisterForEventValidation(String, String) method.

Dotyczy

Zobacz też