TemplateControl.LoadControl メソッド

ユーザー コントロール ファイルから UserControl オブジェクトを取得します。

Public Function LoadControl( _
   ByVal virtualPath As String _) As Control
[C#]
public Control LoadControl(stringvirtualPath);
[C++]
public: Control* LoadControl(String* virtualPath);
[JScript]
public function LoadControl(
   virtualPath : String) : Control;

パラメータ

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

戻り値

指定した UserControl オブジェクトを返します。

解説

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

使用例

[Visual Basic, C#] LoadControl メソッドを使用して LogOnControl ユーザー コントロールを ASP.NET ページに追加する例を次に示します。 LogOnControl は、C# の場合は Logonformcs.ascx ファイル、Visual Basic の場合は Logonformvb.ascx ファイルに格納されています。その後、このユーザー コントロールは myPlaceholder という名前の PlaceHolder Web サーバー コントロールの Controls プロパティに追加されます。

 
' 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)
  Controls.Add(myControl1)
              
End Sub

[C#] 
// 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");
    Controls.Add(myControl1);
    
  }

[C++, JScript] C++ および JScript のサンプルはありません。Visual Basic および C# のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。

必要条件

プラットフォーム: Windows 2000, Windows XP Professional, Windows Server 2003 ファミリ

参照

TemplateControl クラス | TemplateControl メンバ | System.Web.UI 名前空間