ClientScriptManager.RegisterStartupScript Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Zaregistruje spouštěcí skript u objektu Page .
Přetížení
RegisterStartupScript(Type, String, String) |
Zaregistruje spouštěcí skript s Page objektem pomocí typu, klíče a literálu skriptu. |
RegisterStartupScript(Type, String, String, Boolean) |
Zaregistruje spouštěcí skript s Page objektem pomocí typu, klíče, literálu skriptu a logické hodnoty označující, jestli chcete přidat značky skriptu. |
RegisterStartupScript(Type, String, String)
Zaregistruje spouštěcí skript s Page objektem pomocí typu, klíče a literálu skriptu.
public:
void RegisterStartupScript(Type ^ type, System::String ^ key, System::String ^ script);
public void RegisterStartupScript (Type type, string key, string script);
member this.RegisterStartupScript : Type * string * string -> unit
Public Sub RegisterStartupScript (type As Type, key As String, script As String)
Parametry
- type
- Type
Typ spouštěcího skriptu, který se má zaregistrovat.
- key
- String
Klíč spouštěcího skriptu, který se má zaregistrovat.
- script
- String
Literál spouštěcího skriptu, který se má zaregistrovat.
Příklady
Následující příklad kódu ukazuje použití RegisterStartupScript metody. Všimněte si, že značky počátečních a závěrečných skriptů jsou součástí parametru script
. Pokud chcete mít značky skriptu přidané na základě dalšího nastavení parametrů, podívejte se na metodu RegisterStartupScript .
<%@ 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";
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))
{
StringBuilder cstext1 = new StringBuilder();
cstext1.Append("<script type=text/javascript> alert('Hello World!') </");
cstext1.Append("script>");
cs.RegisterStartupScript(cstype, csname1, cstext1.ToString());
}
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<title>RegisterStartupScript</title>
</head>
<body>
<form id="form1" runat="server">
<div>
</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">
Public Sub Page_Load(ByVal sender As [Object], ByVal e As EventArgs)
' Define the name and type of the client scripts on the page.
Dim csname1 As [String] = "PopupScript"
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 New StringBuilder()
cstext1.Append("<script type=text/javascript> alert('Hello World!') </")
cstext1.Append("script>")
cs.RegisterStartupScript(cstype, csname1, cstext1.ToString())
End If
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
<title>RegisterStartupScript</title>
</head>
<body>
<form id="form1" runat="server">
<div>
</div>
</form>
</body>
</html>
Poznámky
Klientský skript je jednoznačně identifikován jeho klíčem a jeho typem. Skripty se stejným klíčem a typem se považují za duplicitní. Na stránce lze zaregistrovat pouze jeden skript s daným typem a párem klíčů. Pokus o registraci skriptu, který je již zaregistrovaný, nevytváří duplikát skriptu.
Zavolejte metodu IsStartupScriptRegistered , která určí, jestli je spouštěcí skript s daným klíčem a párem typů již zaregistrovaný, a vyhněte se zbytečnému pokusu o přidání skriptu.
V tomto přetížení RegisterStartupScript metody je nutné zajistit, aby skript zadaný v script
parametru byl zabalen s blokem elementu <script>
.
Blok skriptu přidaný metodou RegisterStartupScript se spustí, když se stránka dokončí načítání, ale před vyvoláním události stránky OnLoad . Bloky skriptů nejsou zaručené, že budou výstupem v pořadí, v jakém jsou zaregistrované. Pokud je pořadí bloků skriptů důležité, pomocí objektu StringBuilder shromážděte skripty společně v jednom řetězci a pak je zaregistrujte v jednom bloku klientského skriptu.
Viz také
Platí pro
RegisterStartupScript(Type, String, String, Boolean)
Zaregistruje spouštěcí skript s Page objektem pomocí typu, klíče, literálu skriptu a logické hodnoty označující, jestli chcete přidat značky skriptu.
public:
void RegisterStartupScript(Type ^ type, System::String ^ key, System::String ^ script, bool addScriptTags);
public void RegisterStartupScript (Type type, string key, string script, bool addScriptTags);
member this.RegisterStartupScript : Type * string * string * bool -> unit
Public Sub RegisterStartupScript (type As Type, key As String, script As String, addScriptTags As Boolean)
Parametry
- type
- Type
Typ spouštěcího skriptu, který se má zaregistrovat.
- key
- String
Klíč spouštěcího skriptu, který se má zaregistrovat.
- script
- String
Literál spouštěcího skriptu, který se má zaregistrovat.
- addScriptTags
- Boolean
Logická hodnota označující, jestli se mají přidat značky skriptu.
Výjimky
type
je null
.
Příklady
Následující příklad kódu ukazuje použití RegisterStartupScript metody. Všimněte si, že parametr je nastavený tak, addScriptTags
aby false
se do parametru script
zahrnuly značky počátečních a závěrečných skriptů.
<%@ 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>
Poznámky
Spouštěcí skript je jednoznačně identifikován jeho klíčem a jeho typem. Skripty se stejným klíčem a typem se považují za duplicitní. Na stránce lze zaregistrovat pouze jeden skript s daným typem a párem klíčů. Pokus o registraci skriptu, který je již zaregistrovaný, nevytváří duplikát skriptu.
Zavolejte metodu IsStartupScriptRegistered , která určí, jestli je spouštěcí skript s daným klíčem a párem typů již zaregistrovaný, a vyhněte se zbytečnému pokusu o přidání skriptu.
V tomto přetížení RegisterStartupScript metody můžete určit, zda je skript zadaný v script
parametru zabalen <script>
s blokem elementu pomocí parametru addScriptTags
. Nastavení addScriptTags
označující true
, že značky skriptů budou přidány automaticky.
Blok skriptu přidaný metodou RegisterStartupScript se spustí, když se stránka dokončí načítání, ale před vyvoláním události stránky OnLoad . Bloky skriptů nejsou zaručené, že budou výstupem v pořadí, v jakém jsou zaregistrované. Pokud je pořadí bloků skriptů důležité, pomocí objektu StringBuilder shromážděte skripty společně v jednom řetězci a pak je zaregistrujte v jednom bloku klientského skriptu.