WebControl クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
System.Web.UI.WebControls 名前空間内のすべてのコントロールに共通するメソッド、プロパティ、およびイベントを定義する基本クラスとして機能します。
public ref class WebControl : System::Web::UI::Control, System::Web::UI::IAttributeAccessor
public class WebControl : System.Web.UI.Control, System.Web.UI.IAttributeAccessor
[System.Web.UI.Themeable(true)]
public class WebControl : System.Web.UI.Control, System.Web.UI.IAttributeAccessor
type WebControl = class
inherit Control
interface IAttributeAccessor
[<System.Web.UI.Themeable(true)>]
type WebControl = class
inherit Control
interface IAttributeAccessor
Public Class WebControl
Inherits Control
Implements IAttributeAccessor
- 継承
- 派生
- 属性
- 実装
例
namespace ControlTest
{
using System;
using System.Web.UI;
using System.Web.UI.WebControls;
// Renders the following HTML:
// <span onclick="alert('Hello');" style="color:Red;">Custom Contents</span>
public class MyWebControl: WebControl {
public MyWebControl() : base(HtmlTextWriterTag.Span)
{ }
[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")]
protected override void AddAttributesToRender(HtmlTextWriter writer)
{
writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");
writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red");
base.AddAttributesToRender(writer);
}
[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name="FullTrust")]
protected override void RenderContents(HtmlTextWriter writer)
{
writer.Write("Custom Contents");
base.RenderContents(writer);
}
}
}
Imports System.Web.UI
Imports System.Web.UI.WebControls
Namespace ControlTest
' Renders the following HTML:
' <span onclick="alert('Hello');" style="color:Red;">Custom Contents</span>
Public Class MyWebControl
Inherits WebControl
Public Sub New()
MyBase.New(HtmlTextWriterTag.Span)
End Sub
<System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
Protected Overrides Sub AddAttributesToRender(writer As HtmlTextWriter)
writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');")
writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red")
MyBase.AddAttributesToRender(writer)
End Sub
<System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
Protected Overrides Sub RenderContents(writer As HtmlTextWriter)
writer.Write("Custom Contents")
MyBase.RenderContents(writer)
End Sub
End Class
End Namespace 'ControlTest
注釈
WebControl クラスは、すべての Web サーバー コントロールに共通するプロパティ、メソッド、およびイベントを提供します。 このクラスで定義されているプロパティを設定することで、Web サーバー コントロールの外観と動作を制御できます。 たとえば、コントロールの背景色とフォントの色は、それぞれ BackColor プロパティと ForeColor プロパティを使用して制御されます。 罫線を表示できるコントロールでは、BorderWidth、BorderStyle、および BorderColor プロパティを設定することで、罫線の幅、罫線のスタイル、および罫線の色を制御できます。 Web サーバー コントロールのサイズは、Height プロパティと Width プロパティを使用して指定できます。
コントロールの動作は、特定のプロパティを設定することで指定できます。 Enabled プロパティを設定することで、コントロールを有効または無効にすることができます。 タブ オーダー内のコントロールの場所は、TabIndex プロパティを設定することによって制御されます。 ToolTip プロパティを設定することで、コントロールのツールヒントを指定できます。
手記
すべてのコントロールがこのクラスで定義されているすべてのプロパティをサポートしているわけではありません。 プロパティがサポートされているかどうかの詳細については、特定のコントロールのドキュメントを参照してください。
手記
このクラスの一部のプロパティは、ブラウザーによってレンダリング方法が異なります。 一部のプロパティはレンダリングされず、他のプロパティはレンダリングされますが、効果はありません。
HttpBrowserCapabilities オブジェクトの TagWriter プロパティによって、Web サーバー コントロールのレンダリング方法が決まります。 HTML 4.0 をサポートするブラウザーの場合、TagWriter プロパティには通常の HttpBrowserCapabilities オブジェクトが含まれており、ほとんどのプロパティは HTML 4.0 スタイル属性を使用してレンダリングされます。 HTML 4.0 をサポートしていないブラウザーでは、Html32TextWriter オブジェクトが使用されます。 これにより、スタイル属性が関連する HTML 3.2 タグ属性に自動的にマップされます。
ForeColor プロパティなど、場合によっては、スタイル属性は、<font>
タグなどの追加のタグに変換されます。 場合によっては、マッピングは実行されません。 さまざまなブラウザーでプロパティをレンダリングする方法の詳細については、特定のプロパティのドキュメントを参照してください。
WebControlのインスタンスの初期プロパティ値の一覧については、WebControl コンストラクターを参照してください。
コンストラクター
WebControl() |
|
WebControl(HtmlTextWriterTag) |
指定した HTML タグを使用して、WebControl クラスの新しいインスタンスを初期化します。 |
WebControl(String) |
指定した HTML タグを使用して、WebControl クラスの新しいインスタンスを初期化します。 |
プロパティ
AccessKey |
Web サーバー コントロールにすばやく移動できるアクセス キーを取得または設定します。 |
Adapter |
コントロールのブラウザー固有のアダプターを取得します。 (継承元 Control) |
AppRelativeTemplateSourceDirectory |
このコントロールを含む Page または UserControl オブジェクトのアプリケーション相対仮想ディレクトリを取得または設定します。 (継承元 Control) |
Attributes |
コントロールのプロパティに対応しない任意の属性のコレクションを取得します (レンダリングのみ)。 |
BackColor |
Web サーバー コントロールの背景色を取得または設定します。 |
BindingContainer |
このコントロールのデータ バインディングを含むコントロールを取得します。 (継承元 Control) |
BorderColor |
Web コントロールの境界線の色を取得または設定します。 |
BorderStyle |
Web サーバー コントロールの境界線スタイルを取得または設定します。 |
BorderWidth |
Web サーバー コントロールの境界線の幅を取得または設定します。 |
ChildControlsCreated |
サーバー コントロールの子コントロールが作成されているかどうかを示す値を取得します。 (継承元 Control) |
ClientID |
ASP.NET によって生成される HTML マークアップのコントロール ID を取得します。 (継承元 Control) |
ClientIDMode |
ClientID プロパティの値を生成するために使用するアルゴリズムを取得または設定します。 (継承元 Control) |
ClientIDSeparator |
ClientID プロパティで使用される区切り文字を表す文字値を取得します。 (継承元 Control) |
Context |
現在の Web 要求のサーバー コントロールに関連付けられている HttpContext オブジェクトを取得します。 (継承元 Control) |
Controls |
UI 階層内の指定したサーバー コントロールの子コントロールを表す ControlCollection オブジェクトを取得します。 (継承元 Control) |
ControlStyle |
Web サーバー コントロールのスタイルを取得します。 このプロパティは、主にコントロール開発者によって使用されます。 |
ControlStyleCreated |
ControlStyle プロパティに対して Style オブジェクトが作成されているかどうかを示す値を取得します。 このプロパティは、主にコントロール開発者によって使用されます。 |
CssClass |
クライアント上の Web サーバー コントロールによってレンダリングされるカスケード スタイル シート (CSS) クラスを取得または設定します。 |
DataItemContainer |
名前付けコンテナーが IDataItemContainerを実装している場合は、名前付けコンテナーへの参照を取得します。 (継承元 Control) |
DataKeysContainer |
名前付けコンテナーが IDataKeysControlを実装している場合は、名前付けコンテナーへの参照を取得します。 (継承元 Control) |
DesignMode |
コントロールがデザイン サーフェイスで使用されているかどうかを示す値を取得します。 (継承元 Control) |
DisabledCssClass |
コントロールが無効な場合に、レンダリングされた HTML 要素に適用する CSS クラスを取得または設定します。 |
Enabled |
Web サーバー コントロールが有効かどうかを示す値を取得または設定します。 |
EnableTheming |
テーマがこのコントロールに適用されるかどうかを示す値を取得または設定します。 |
EnableTheming |
テーマがこのコントロールに適用されるかどうかを示す値を取得または設定します。 (継承元 Control) |
EnableViewState |
サーバー コントロールがそのビューステートを保持するかどうか、およびそれに含まれる子コントロールのビューステートを要求側クライアントに保持するかどうかを示す値を取得または設定します。 (継承元 Control) |
Events |
コントロールのイベント ハンドラー デリゲートの一覧を取得します。 このプロパティは読み取り専用です。 (継承元 Control) |
Font |
Web サーバー コントロールに関連付けられているフォント プロパティを取得します。 |
ForeColor |
Web サーバー コントロールの前景色 (通常はテキストの色) を取得または設定します。 |
HasAttributes |
コントロールに属性が設定されているかどうかを示す値を取得します。 |
HasChildViewState |
現在のサーバー コントロールの子コントロールに保存されたビューステート設定があるかどうかを示す値を取得します。 (継承元 Control) |
Height |
Web サーバー コントロールの高さを取得または設定します。 |
ID |
サーバー コントロールに割り当てられたプログラム識別子を取得または設定します。 (継承元 Control) |
IdSeparator |
コントロール識別子を分離するために使用する文字を取得します。 (継承元 Control) |
IsChildControlStateCleared |
このコントロール内に含まれるコントロールがコントロールの状態を持っているかどうかを示す値を取得します。 (継承元 Control) |
IsEnabled |
コントロールが有効かどうかを示す値を取得します。 |
IsTrackingViewState |
サーバー コントロールがビュー ステートへの変更を保存するかどうかを示す値を取得します。 (継承元 Control) |
IsViewStateEnabled |
このコントロールに対してビューステートが有効かどうかを示す値を取得します。 (継承元 Control) |
LoadViewStateByID |
インデックスの代わりに ID して、コントロールがビューステートの読み込みに関与するかどうかを示す値を取得します。 (継承元 Control) |
NamingContainer |
サーバー コントロールの名前付けコンテナーへの参照を取得します。このコンテナーは、同じ ID プロパティ値を持つサーバー コントロール間で区別するための一意の名前空間を作成します。 (継承元 Control) |
Page |
サーバー コントロールを含む Page インスタンスへの参照を取得します。 (継承元 Control) |
Parent |
ページ コントロール階層内のサーバー コントロールの親コントロールへの参照を取得します。 (継承元 Control) |
RenderingCompatibility |
レンダリングされた HTML と互換性のある ASP.NET バージョンを指定する値を取得します。 (継承元 Control) |
Site |
デザイン サーフェイスにレンダリングされるときに、現在のコントロールをホストするコンテナーに関する情報を取得します。 (継承元 Control) |
SkinID |
コントロールに適用するスキンを取得または設定します。 |
SkinID |
コントロールに適用するスキンを取得または設定します。 (継承元 Control) |
Style |
Web サーバー コントロールの外部タグのスタイル属性としてレンダリングされるテキスト属性のコレクションを取得します。 |
SupportsDisabledAttribute |
コントロールの IsEnabled プロパティが |
TabIndex |
Web サーバー コントロールのタブ インデックスを取得または設定します。 |
TagKey |
この Web サーバー コントロールに対応する HtmlTextWriterTag 値を取得します。 このプロパティは、主にコントロール開発者によって使用されます。 |
TagName |
コントロール タグの名前を取得します。 このプロパティは、主にコントロール開発者によって使用されます。 |
TemplateControl |
このコントロールを含むテンプレートへの参照を取得または設定します。 (継承元 Control) |
TemplateSourceDirectory |
現在のサーバー コントロールを含む Page または UserControl の仮想ディレクトリを取得します。 (継承元 Control) |
ToolTip |
マウス ポインターが Web サーバー コントロールの上に置いたときに表示されるテキストを取得または設定します。 |
UniqueID |
サーバー コントロールの階層的に修飾された一意の識別子を取得します。 (継承元 Control) |
ValidateRequestMode |
コントロールがブラウザーからのクライアント入力で潜在的に危険な値をチェックするかどうかを示す値を取得または設定します。 (継承元 Control) |
ViewState |
同じページに対する複数の要求にわたってサーバー コントロールのビューステートを保存および復元できる状態情報のディクショナリを取得します。 (継承元 Control) |
ViewStateIgnoresCase |
StateBag オブジェクトで大文字と小文字が区別されないかどうかを示す値を取得します。 (継承元 Control) |
ViewStateMode |
このコントロールのビューステート モードを取得または設定します。 (継承元 Control) |
Visible |
サーバー コントロールがページ上の UI としてレンダリングされるかどうかを示す値を取得または設定します。 (継承元 Control) |
Width |
Web サーバー コントロールの幅を取得または設定します。 |
メソッド
AddAttributesToRender(HtmlTextWriter) |
指定した HtmlTextWriterTagにレンダリングする必要がある HTML 属性とスタイルを追加します。 このメソッドは、主にコントロール開発者によって使用されます。 |
AddedControl(Control, Int32) |
子コントロールが Control オブジェクトの Controls コレクションに追加された後に呼び出されます。 (継承元 Control) |
AddParsedSubObject(Object) |
XML または HTML のいずれかの要素が解析されたことをサーバー コントロールに通知し、その要素をサーバー コントロールの ControlCollection オブジェクトに追加します。 (継承元 Control) |
ApplyStyle(Style) |
指定したスタイルの空白以外の要素を Web コントロールにコピーし、コントロールの既存のスタイル要素を上書きします。 このメソッドは、主にコントロール開発者によって使用されます。 |
ApplyStyleSheetSkin(Page) |
ページ スタイル シートで定義されているスタイル プロパティをコントロールに適用します。 (継承元 Control) |
BeginRenderTracing(TextWriter, Object) |
レンダリング データのデザイン時トレースを開始します。 (継承元 Control) |
BuildProfileTree(String, Boolean) |
サーバー コントロールに関する情報を収集し、ページのトレースが有効になっているときに表示される Trace プロパティに渡します。 (継承元 Control) |
ClearCachedClientID() |
キャッシュされた ClientID 値を |
ClearChildControlState() |
サーバー コントロールの子コントロールのコントロール状態情報を削除します。 (継承元 Control) |
ClearChildState() |
すべてのサーバー コントロールの子コントロールのビューステート情報とコントロール状態情報を削除します。 (継承元 Control) |
ClearChildViewState() |
すべてのサーバー コントロールの子コントロールのビューステート情報を削除します。 (継承元 Control) |
ClearEffectiveClientIDMode() |
現在のコントロール インスタンスおよび子コントロールの ClientIDMode プロパティを Inheritに設定します。 (継承元 Control) |
CopyBaseAttributes(WebControl) |
Style オブジェクトによってカプセル化されていないプロパティを、指定した Web サーバー コントロールから、このメソッドが呼び出される Web サーバー コントロールにコピーします。 このメソッドは、主にコントロール開発者によって使用されます。 |
CreateChildControls() |
ASP.NET ページ フレームワークによって呼び出され、コンポジション ベースの実装を使用して、ポスト バックまたはレンダリングの準備として含まれる子コントロールを作成するサーバー コントロールに通知します。 (継承元 Control) |
CreateControlCollection() |
サーバー コントロールの子コントロール (リテラルとサーバーの両方) を保持する新しい ControlCollection オブジェクトを作成します。 (継承元 Control) |
CreateControlStyle() |
すべてのスタイル関連プロパティを実装するために、WebControl クラスによって内部的に使用されるスタイル オブジェクトを作成します。 このメソッドは、主にコントロール開発者によって使用されます。 |
DataBind() |
呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。 (継承元 Control) |
DataBind(Boolean) |
DataBinding イベントを発生させるオプションを使用して、呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。 (継承元 Control) |
DataBindChildren() |
データ ソースをサーバー コントロールの子コントロールにバインドします。 (継承元 Control) |
Dispose() |
サーバー コントロールがメモリから解放される前に、最終的なクリーンアップを実行できるようにします。 (継承元 Control) |
EndRenderTracing(TextWriter, Object) |
レンダリング データのデザイン時トレースを終了します。 (継承元 Control) |
EnsureChildControls() |
サーバー コントロールに子コントロールが含まれているかどうかを判断します。 そうでない場合は、子コントロールが作成されます。 (継承元 Control) |
EnsureID() |
識別子が割り当てられないコントロールの識別子を作成します。 (継承元 Control) |
Equals(Object) |
指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
FindControl(String, Int32) |
|
FindControl(String) |
指定した |
Focus() |
入力フォーカスをコントロールに設定します。 (継承元 Control) |
GetDesignModeState() |
コントロールのデザイン時データを取得します。 (継承元 Control) |
GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
GetRouteUrl(Object) |
ルート パラメーターのセットに対応する URL を取得します。 (継承元 Control) |
GetRouteUrl(RouteValueDictionary) |
ルート パラメーターのセットに対応する URL を取得します。 (継承元 Control) |
GetRouteUrl(String, Object) |
ルート パラメーターとルート名のセットに対応する URL を取得します。 (継承元 Control) |
GetRouteUrl(String, RouteValueDictionary) |
ルート パラメーターとルート名のセットに対応する URL を取得します。 (継承元 Control) |
GetType() |
現在のインスタンスの Type を取得します。 (継承元 Object) |
GetUniqueIDRelativeTo(Control) |
指定したコントロールの UniqueID プロパティのプレフィックス部分を返します。 (継承元 Control) |
HasControls() |
サーバー コントロールに子コントロールが含まれているかどうかを判断します。 (継承元 Control) |
HasEvents() |
コントロールまたは子コントロールのイベントが登録されているかどうかを示す値を返します。 (継承元 Control) |
IsLiteralContent() |
サーバー コントロールがリテラル コンテンツのみを保持するかどうかを決定します。 (継承元 Control) |
LoadControlState(Object) |
SaveControlState() メソッドによって保存された前のページ要求から制御状態情報を復元します。 (継承元 Control) |
LoadViewState(Object) |
SaveViewState() メソッドで保存された以前の要求からビューステート情報を復元します。 |
MapPathSecure(String) |
仮想パス (絶対パスまたは相対パス) がマップされる物理パスを取得します。 (継承元 Control) |
MemberwiseClone() |
現在の Objectの簡易コピーを作成します。 (継承元 Object) |
MergeStyle(Style) |
指定したスタイルの空白以外の要素を Web コントロールにコピーしますが、コントロールの既存のスタイル要素は上書きしません。 このメソッドは、主にコントロール開発者によって使用されます。 |
OnBubbleEvent(Object, EventArgs) |
サーバー コントロールのイベントがページの UI サーバー コントロール階層に渡されるかどうかを判断します。 (継承元 Control) |
OnDataBinding(EventArgs) |
DataBinding イベントを発生させます。 (継承元 Control) |
OnInit(EventArgs) |
Init イベントを発生させます。 (継承元 Control) |
OnLoad(EventArgs) |
Load イベントを発生させます。 (継承元 Control) |
OnPreRender(EventArgs) |
PreRender イベントを発生させます。 (継承元 Control) |
OnUnload(EventArgs) |
Unload イベントを発生させます。 (継承元 Control) |
OpenFile(String) |
ファイルの読み取りに使用する Stream を取得します。 (継承元 Control) |
RaiseBubbleEvent(Object, EventArgs) |
イベントのソースとその情報をコントロールの親に割り当てます。 (継承元 Control) |
RemovedControl(Control) |
Control オブジェクトの Controls コレクションから子コントロールが削除された後に呼び出されます。 (継承元 Control) |
Render(HtmlTextWriter) |
指定した HTML ライターにコントロールをレンダリングします。 |
RenderBeginTag(HtmlTextWriter) |
コントロールの HTML 開始タグを指定されたライターにレンダリングします。 このメソッドは、主にコントロール開発者によって使用されます。 |
RenderChildren(HtmlTextWriter) |
指定した HtmlTextWriter オブジェクトにサーバー コントロールの子のコンテンツを出力します。このオブジェクトは、クライアントにレンダリングされるコンテンツを書き込みます。 (継承元 Control) |
RenderContents(HtmlTextWriter) |
コントロールの内容を指定したライターにレンダリングします。 このメソッドは、主にコントロール開発者によって使用されます。 |
RenderControl(HtmlTextWriter, ControlAdapter) |
指定された ControlAdapter オブジェクトを使用して、指定された HtmlTextWriter オブジェクトにサーバー コントロールのコンテンツを出力します。 (継承元 Control) |
RenderControl(HtmlTextWriter) |
指定された HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力し、トレースが有効になっている場合は、コントロールに関するトレース情報を格納します。 (継承元 Control) |
RenderEndTag(HtmlTextWriter) |
コントロールの HTML 終了タグを指定されたライターにレンダリングします。 このメソッドは、主にコントロール開発者によって使用されます。 |
ResolveAdapter() |
指定したコントロールのレンダリングを担当するコントロール アダプターを取得します。 (継承元 Control) |
ResolveClientUrl(String) |
ブラウザーで使用できる URL を取得します。 (継承元 Control) |
ResolveUrl(String) |
URL を、要求側クライアントで使用できる URL に変換します。 (継承元 Control) |
SaveControlState() |
ページがサーバーにポストバックされた時刻以降に発生したすべてのサーバー 制御状態の変更を保存します。 (継承元 Control) |
SaveViewState() |
TrackViewState() メソッドが呼び出された後に変更されたすべての状態を保存します。 |
SetDesignModeState(IDictionary) |
コントロールのデザイン時データを設定します。 (継承元 Control) |
SetRenderMethodDelegate(RenderMethod) |
サーバー コントロールとそのコンテンツを親コントロールにレンダリングするイベント ハンドラー デリゲートを割り当てます。 (継承元 Control) |
SetTraceData(Object, Object, Object) |
トレース オブジェクト、トレース データ キー、およびトレース データ値を使用して、レンダリング データのデザイン時トレース用のトレース データを設定します。 (継承元 Control) |
SetTraceData(Object, Object) |
トレース データ キーとトレース データ値を使用して、レンダリング データのデザイン時トレース用のトレース データを設定します。 (継承元 Control) |
ToString() |
現在のオブジェクトを表す文字列を返します。 (継承元 Object) |
TrackViewState() |
コントロールがビューステートの変更を追跡し、オブジェクトの ViewState プロパティに格納できるようにします。 |
イベント
DataBinding |
サーバー コントロールがデータ ソースにバインドされるときに発生します。 (継承元 Control) |
Disposed |
サーバー コントロールがメモリから解放されたときに発生します。これは、ASP.NET ページが要求されたときに、サーバー コントロールライフサイクルの最後のステージです。 (継承元 Control) |
Init |
サーバー コントロールが初期化されるときに発生します。これは、そのライフサイクルの最初のステップです。 (継承元 Control) |
Load |
サーバー コントロールが Page オブジェクトに読み込まれるときに発生します。 (継承元 Control) |
PreRender |
Control オブジェクトが読み込まれた後、レンダリングの前に発生します。 (継承元 Control) |
Unload |
サーバー コントロールがメモリからアンロードされるときに発生します。 (継承元 Control) |
明示的なインターフェイスの実装
拡張メソッド
FindDataSourceControl(Control) |
指定したコントロールのデータ コントロールに関連付けられているデータ ソースを返します。 |
FindFieldTemplate(Control, String) |
指定したコントロールの名前付けコンテナー内の指定した列のフィールド テンプレートを返します。 |
FindMetaTable(Control) |
格納されているデータ コントロールのメタテーブル オブジェクトを返します。 |
適用対象
こちらもご覧ください
- BackColor
- ForeColor
- BorderWidth
- BorderStyle
- BorderColor
- Height
- Width
- Enabled
- TabIndex
- ToolTip
- ASP.NET サーバー コントロールとブラウザー機能の
- カスタム ASP.NET サーバー コントロールの開発 の
.NET