TemplateControl.LoadControl メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

TemplateControl.LoadControl メソッド (Type, Object[])

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

指定された型とコンストラクタパラメータに基づいて Control オブジェクトを読み込みます。

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

Visual Basic (宣言)

Public Function LoadControl ( _
    t As Type, _
    parameters As Object() _
) As Control

Visual Basic (使用法)

Dim instance As TemplateControl
Dim t As Type
Dim parameters As Object()
Dim returnValue As Control

returnValue = instance.LoadControl(t, parameters)

public Control LoadControl (
    Type t,
    Object[] parameters
)

C++

public:
Control^ LoadControl (
    Type^ t, 
    array<Object^>^ parameters
)

public Control LoadControl (
    Type t, 
    Object[] parameters
)

JScript

public function LoadControl (
    t : Type, 
    parameters : Object[]
) : Control

パラメータ

t: コントロールの型。

parameters: 呼び出すコンストラクタのパラメータと、数、順序、および型が一致する引数の配列。parameters が空の配列または null 参照 (Visual Basic では Nothing) である場合は、パラメータをとらないコンストラクタ (既定のコンストラクタ) が呼び出されます。

戻り値
指定された UserControl を返します。

解説

コントロールがキャッシュをサポートする場合、LoadControl メソッドから返されるオブジェクトは、実際には、UserControl オブジェクトではなく PartialCachingControl オブジェクトになります。

プラットフォーム

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

参照

関連項目
TemplateControl クラス
TemplateControl メンバ
System.Web.UI 名前空間
UserControl
LoadControl

TemplateControl.LoadControl メソッド

Control を読み込みます。
オーバーロードの一覧

名前	説明
TemplateControl.LoadControl (String)	指定された仮想パスに基づいてファイルから Control オブジェクトを読み込みます。
TemplateControl.LoadControl (Type, Object[])	指定された型とコンストラクタパラメータに基づいて Control オブジェクトを読み込みます。

参照

TemplateControl.LoadControl メソッド (String)

指定された仮想パスに基づいてファイルから Control オブジェクトを読み込みます。

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

Visual Basic (宣言)

Public Function LoadControl ( _
    virtualPath As String _
) As Control

Visual Basic (使用法)

Dim instance As TemplateControl
Dim virtualPath As String
Dim returnValue As Control

returnValue = instance.LoadControl(virtualPath)

public Control LoadControl (
    string virtualPath
)

C++

public:
Control^ LoadControl (
    String^ virtualPath
)

public Control LoadControl (
    String virtualPath
)

JScript

public function LoadControl (
    virtualPath : String
) : Control

パラメータ

virtualPath: コントロールファイルへの仮想パス。

戻り値
指定された Control を返します。

例外

例外の種類	条件
ArgumentNullException	仮想パスが null 参照 (Visual Basic では Nothing) または空です。

解説

コントロールがキャッシュをサポートする場合、LoadControl メソッドから返されるオブジェクトは、実際には、Control オブジェクトではなく PartialCachingControl オブジェクトになります。virtualPath パラメータが相対パスの場合、読み込まれるコントロールのパスは TemplateControl のパスに対しての相対になります。

使用例

LoadControl メソッドを使用して、ASP.NET ページにユーザーコントロールを追加する方法を次のコード例に示します。ユーザーコントロールは次のファイルに格納されています。

[C#]

TempControl_Samples1.cs.ascx

[Visual Basic]

TempControl_Samples1.vb.ascx

その後、このユーザーコントロールは Placeholder1 という名前の PlaceHolder Web サーバーコントロールの Controls プロパティに追加されます。

このコード例で使用されている MyControl クラスの定義については、「TemplateControl」を参照してください。

Visual Basic

' When this page is loaded, it uses the TemplateControl.LoadControl
' method to programmatically create a user control. The user control
' is contained in the .ascx file that is passed as a parameter 
' in the LoadControl call. The page then adds the control to its
' ControlCollection.
Sub  Page_Load(Sender As Object,
 e As EventArgs)
         
  ' Obtain a UserControl object MyControl from the
  ' user control file TempControl_Samples1.vb.ascx.
  Dim myControl1 As MyControl = CType(LoadControl("TempControl_Samples1.vb.ascx")
,MyControl)
  PlaceHolder1.Controls.Add(myControl1)
              
End Sub

// When this page is loaded, it uses the TemplateControl.LoadControl
// method to programmatically create a user control. The user control
// is contained in the .ascx file that is passed as a parameter 
// in the LoadControl call. The page then adds the control to its
// ControlCollection.
void Page_Load(object sender, System.EventArgs e)
  {
    // Obtain the UserControl object MyControl from the
    // user control file UserControl_Init.ascx.
    MyControl myControl1 = (MyControl)LoadControl("TempControl_Samples1.cs.ascx");
    PlaceHolder1.Controls.Add(myControl1);
    
  }