ClientScriptItem

.NET Framework クラス ライブラリ リファレンス

ClientScriptItem クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

デザイン時に Web フォームまたはユーザー コントロール内のクライアント スクリプト要素を表します。このクラスは継承できません。

名前空間: System.Web.UI.Design
アセンブリ: System.Design (system.design.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 ClientScriptItem

Visual Basic (使用法)

Dim instance As ClientScriptItem

C#

public sealed class ClientScriptItem

C++

public ref class ClientScriptItem sealed

J#

public final class ClientScriptItem

JScript

public final class ClientScriptItem

解説

ClientScriptItem クラスは、デザイン時に Web ドキュメントに含まれている script 要素を表します。カスタム コントロール デザイナ実装は、ClientScriptItem オブジェクトを使用して、クライアント スクリプト要素を Web フォームまたはユーザー コントロールに追加できます。

デザイン時に、WebFormsRootDesigner クラスを使用して、デザイン サーフェイスで Web フォーム、Web サーバー コントロール、コンテンツ ページ、マスタ ページなどのドキュメントに含まれるクライアント スクリプト要素を設定または確認します。Web ドキュメントに含まれているクライアント スクリプト要素のコレクションを取得するには、GetClientScriptsInDocument メソッドを使用します。クライアント スクリプト要素を Web ドキュメントに追加するには、AddClientScriptToDocument メソッドを使用します。

通常、script 要素は、スクリプト ステートメントを含むか、またはスクリプト ステートメントの外部位置を指定します。script 要素には、オプションでスクリプト ステートメントの言語を指定できます。ClientScriptItem コンストラクタは、新しいスクリプト オブジェクトのプロパティを初期化するために使用します。ClientScriptItem プロパティは、script オブジェクトの属性および内容を確認するために使用します。Language プロパティは、script 要素の language 属性を表します。Source プロパティは、src 属性を表します。Text プロパティは、script 要素に含まれ、クライアント上で実行されるスクリプト ステートメントを表します。

ClientScriptItem クラスを使用して、デザイン時に実行されるスクリプトを管理します。

実行時にクライアント スクリプト要素を管理するには、ClientScriptManager クラスを使用します。実行時のクライアント スクリプトの使用方法の詳細については、「ASP.NET Web ページのクライアント スクリプト」を参照してください。

メモ
ClientScriptItem クラスは、最終的にクライアントのブラウザで解析および実行される script 要素をデザイン時に表します。ClientScriptItem オブジェクトに対して生成される script 要素はサーバー上で実行されないため、要素は runat="server" 属性を含みません。

継承階層

System.Object
  System.Web.UI.Design.ClientScriptItem

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ClientScriptItem メンバ
System.Web.UI.Design 名前空間
ClientScriptItemCollection
AddClientScriptToDocument
GetClientScriptsInDocument
その他の技術情報
クライアント スクリプトを使用する ASP.NET Web ページのプログラミング

ClientScriptItem コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定されたパラメータを使用して、ClientScriptItem クラスの新しいインスタンスを初期化します。

名前空間: System.Web.UI.Design
アセンブリ: System.Design (system.design.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    text As String, _
    source As String, _
    language As String, _
    type As String, _
    id As String _
)

Visual Basic (使用法)

Dim text As String
Dim source As String
Dim language As String
Dim type As String
Dim id As String

Dim instance As New ClientScriptItem(text,
 source, language, type, id)

C#

public ClientScriptItem (
    string text,
    string source,
    string language,
    string type,
    string id
)

C++

public:
ClientScriptItem (
    String^ text, 
    String^ source, 
    String^ language, 
    String^ type, 
    String^ id
)

J#

public ClientScriptItem (
    String text, 
    String source, 
    String language, 
    String type, 
    String id
)

JScript

public function ClientScriptItem (
    text : String, 
    source : String, 
    language : String, 
    type : String, 
    id : String
)

パラメータ

text

script 要素の内容。クライアント上で実行されるスクリプト ステートメントの文字列です。

source

script 要素の src 属性値。クライアント スクリプトの内容の外部ソースの位置を指定します。

language

script 要素の language 属性値。スクリプト ステートメントの言語を指定します。

type

関連付けられたスクリプト エンジンの MIME タイプを示す script 要素の型属性値。

id

script 要素の ID。この引数は、デザイン ホスト (Visual Studio 2005 など) では必須です。

例外

例外の種類	条件
ArgumentNullException	id が null です (デザイン ホストによってスローされました)。

解説

text パラメータまたは source パラメータのいずれか 1 つを使用して、ClientScriptItem オブジェクトのステートメントを初期化します。text は、ステートメントが含まれている入力文字列を使用してスクリプトを初期化するために使用します。source は、スクリプト ステートメントが含まれているパスを使用してスクリプトを初期化するために使用します。

いずれのパラメータにも null 参照 (Visual Basic では Nothing) または空の文字列 ("") を指定できます。その場合、対応するプロパティが入力値に基づいて設定され、そのプロパティがない状態で script 要素が生成されます。null 参照 (Visual Basic では Nothing) または空の文字列 ("") を使用した場合の結果は次のようになります。

• text の場合、対応する script 要素はスクリプト ステートメントを格納しません。

• source の場合、src 属性が script 要素に設定されません。

• language の場合、language 属性が script 要素に設定されません。

  クライアント スクリプト ブロックでスクリプト言語が指定されていない場合、言語はクライアント ブラウザによって判定されます。

• type の場合、type 属性はスクリプト要素に設定されません。

  クライアント スクリプト ブロックでスクリプトの種類が指定されていない場合、種類はクライアント ブラウザによって判定されます。

• id については、デザイン ホスト (Visual Studio 2005 など) が ArgumentNullException をスローします。

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ClientScriptItem クラス
ClientScriptItem メンバ
System.Web.UI.Design 名前空間
Text
Language
Source
Type
Id
その他の技術情報
クライアント スクリプトを使用する ASP.NET Web ページのプログラミング

ClientScriptItem プロパティ

パブリック プロパティ

	名前	説明
	Id	クライアント スクリプト要素の ID 属性値を取得します。
	Language	クライアント スクリプト要素の language 属性値を取得します。
	Source	クライアント スクリプト要素の src 属性値を取得します。
	Text	クライアント スクリプト要素に含まれているスクリプト ステートメントを取得します。
	Type	クライアント スクリプト要素の type 属性値を取得します。

参照

関連項目

ClientScriptItem クラス
System.Web.UI.Design 名前空間
ClientScriptItemCollection
AddClientScriptToDocument
GetClientScriptsInDocument

その他の技術情報

クライアント スクリプトを使用する ASP.NET Web ページのプログラミング

ClientScriptItem メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

ClientScriptItem クラス
System.Web.UI.Design 名前空間
ClientScriptItemCollection
AddClientScriptToDocument
GetClientScriptsInDocument

その他の技術情報

クライアント スクリプトを使用する ASP.NET Web ページのプログラミング

ClientScriptItem メンバ

デザイン時に Web フォームまたはユーザー コントロール内のクライアント スクリプト要素を表します。このクラスは継承できません。

ClientScriptItem データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	ClientScriptItem	指定されたパラメータを使用して、ClientScriptItem クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Id	クライアント スクリプト要素の ID 属性値を取得します。
	Language	クライアント スクリプト要素の language 属性値を取得します。
	Source	クライアント スクリプト要素の src 属性値を取得します。
	Text	クライアント スクリプト要素に含まれているスクリプト ステートメントを取得します。
	Type	クライアント スクリプト要素の type 属性値を取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

ClientScriptItem クラス
System.Web.UI.Design 名前空間
ClientScriptItemCollection
AddClientScriptToDocument
GetClientScriptsInDocument

その他の技術情報

クライアント スクリプトを使用する ASP.NET Web ページのプログラミング