Language

TemplateControl.LoadControl メソッド

定義

名前空間:
System.Web.UI
アセンブリ:
System.Web.dll

Controlを読み込みます。

オーバーロード

名前 説明
LoadControl(String)

指定した仮想パスに基づいて、ファイルから Control オブジェクトを読み込みます。
LoadControl(Type, Object[])

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

注釈

コンテナー コントロールにコントロールを読み込むと、コンテナーは、現在のイベントに追いつくまで、追加されたすべてのコントロールのイベントを発生させます。 ただし、追加されたコントロールはポストバック データ処理に追いつきません。 追加されたコントロールが検証を含むポストバック データ処理に参加するには、Init イベントではなく、Load イベントにコントロールを追加する必要があります。

LoadControl(String)

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

public:
 System::Web::UI::Control ^ LoadControl(System::String ^ virtualPath);
public System.Web.UI.Control LoadControl(string virtualPath);
member this.LoadControl : string -> System.Web.UI.Control
Public Function LoadControl (virtualPath As String) As Control

パラメーター

virtualPath
String

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

返品

Control

指定した Controlを返します。

例外

ArgumentNullException

仮想パスが null または空です。

例

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

OnInit イベント メソッドでは、このページでは、LoadControl メソッドを使用して、プログラムによってページ上にユーザー コントロールを作成します。 このメソッドは、Controls という名前の PlaceHolder Web サーバー コントロールのPlaceholder1 プロパティにコントロールを追加します。

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

void Page_Init(object sender, System.EventArgs e)
{
    // Instantiate the UserControl object
    MyControl myControl1 =
        (MyControl)LoadControl("TempControl_Samples1.ascx.cs");
    PlaceHolder1.Controls.Add(myControl1);
}

Sub Page_Load(ByVal Sender As Object, ByVal e As EventArgs)
    ' Obtain a UserControl object MyControl from the
    ' user control file TempControl_Samples1.ascx.vb
    Dim myControl1 As MyControl = CType(LoadControl("TempControl_Samples1.vb.ascx"), MyControl)
    Controls.Add(myControl1)
End Sub

注釈

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

コンテナー コントロールにコントロールを読み込むと、コンテナーは、現在のイベントに追いつくまで、追加されたすべてのコントロールのイベントを発生させます。 ただし、追加されたコントロールはポストバック データ処理に追いつきません。 追加されたコントロールが検証を含むポストバック データ処理に参加するには、Init イベントではなく、Load イベントにコントロールを追加する必要があります。

こちらもご覧ください

適用対象

LoadControl(Type, Object[])

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

public:
 System::Web::UI::Control ^ LoadControl(Type ^ t, cli::array <System::Object ^> ^ parameters);
public System.Web.UI.Control LoadControl(Type t, object[] parameters);
member this.LoadControl : Type * obj[] -> System.Web.UI.Control
Public Function LoadControl (t As Type, parameters As Object()) As Control

パラメーター

t
Type

コントロールの型。

parameters
Object[]

呼び出すコンストラクターのパラメーターを数値、順序、および型で一致する引数の配列。 parametersが空の配列またはnullの場合、パラメーターを受け取っていないコンストラクター (パラメーターなしのコンストラクター) が呼び出されます。

返品

Control

指定した UserControlを返します。

注釈

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

コンテナー コントロールにコントロールを読み込むと、コンテナーは、現在のイベントに追いつくまで、追加されたすべてのコントロールのイベントを発生させます。 ただし、追加されたコントロールはポストバック データ処理に追いつきません。 追加されたコントロールが検証を含むポストバック データ処理に参加するには、Init イベントではなく、Load イベントにコントロールを追加する必要があります。

こちらもご覧ください

適用対象