Control.Invoke メソッド

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、デリゲートを実行します。

オーバーロード

Invoke(Action)	コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。
Invoke(Delegate)	コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。
Invoke(Delegate, Object[])	コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定した引数リストを使用して、指定したデリゲートを実行します。
Invoke<T>(Func<T>)	コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。

Invoke(Action)

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。

public:
 void Invoke(Action ^ method);

public void Invoke (Action method);

member this.Invoke : Action -> unit

Public Sub Invoke (method As Action)

パラメーター

method

Action

コントロールのスレッド コンテキストで呼び出されるメソッドを格納しているデリゲート。

Invoke(Delegate)

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。

public:
 System::Object ^ Invoke(Delegate ^ method);

public object Invoke (Delegate method);

member this.Invoke : Delegate -> obj

Public Function Invoke (method As Delegate) As Object

パラメーター

method

Delegate

コントロールのスレッド コンテキストで呼び出されるメソッドを格納しているデリゲート。

戻り値

Object

呼び出されるデリゲートからの戻り値。デリゲートに戻り値がない場合は null。

例

次のコード例は、デリゲートを含むコントロールを示しています。 デリゲートはリスト ボックスに項目を追加するメソッドをカプセル化し、このメソッドはフォームの基になるハンドルを所有するスレッドで実行されます。 ユーザーがボタンをクリックすると、 Invoke デリゲートが実行されます。

/*
The following example demonstrates the 'Invoke(Delegate*)' method of 'Control class.
A 'ListBox' and a 'Button' control are added to a form, containing a delegate
which encapsulates a method that adds items to the listbox. This function is executed
on the thread that owns the underlying handle of the form. When user clicks on button
the above delegate is executed using 'Invoke' method.
*/

#using <System.dll>
#using <System.Drawing.dll>
#using <System.Windows.Forms.dll>

using namespace System;
using namespace System::Drawing;
using namespace System::Windows::Forms;
using namespace System::Threading;

public ref class MyFormControl: public Form
{
public:
   delegate void AddListItem();
   AddListItem^ myDelegate;

private:
   Button^ myButton;
   Thread^ myThread;
   ListBox^ myListBox;

public:
   MyFormControl();
   void AddListItemMethod()
   {
      String^ myItem;
      for ( int i = 1; i < 6; i++ )
      {
         myItem = "MyListItem {0}",i;
         myListBox->Items->Add( myItem );
         myListBox->Update();
         Thread::Sleep( 300 );
      }
   }

private:
   void Button_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      myThread = gcnew Thread( gcnew ThreadStart( this, &MyFormControl::ThreadFunction ) );
      myThread->Start();
   }

   void ThreadFunction();
};


// The following code assumes a 'ListBox' and a 'Button' control are added to a form,
// containing a delegate which encapsulates a method that adds items to the listbox.
public ref class MyThreadClass
{
private:
   MyFormControl^ myFormControl1;

public:
   MyThreadClass( MyFormControl^ myForm )
   {
      myFormControl1 = myForm;
   }

   void Run()
   {
      // Execute the specified delegate on the thread that owns
      // 'myFormControl1' control's underlying window handle.
      myFormControl1->Invoke( myFormControl1->myDelegate );
   }
};


MyFormControl::MyFormControl()
{
   myButton = gcnew Button;
   myListBox = gcnew ListBox;
   myButton->Location = Point( 72, 160 );
   myButton->Size = System::Drawing::Size( 152, 32 );
   myButton->TabIndex = 1;
   myButton->Text = "Add items in list box";
   myButton->Click += gcnew EventHandler( this, &MyFormControl::Button_Click );
   myListBox->Location = Point( 48, 32 );
   myListBox->Name = "myListBox";
   myListBox->Size = System::Drawing::Size( 200, 95 );
   myListBox->TabIndex = 2;
   ClientSize = System::Drawing::Size( 292, 273 );
   array<Control^>^ temp0 = {myListBox,myButton};
   Controls->AddRange( temp0 );
   Text = " 'Control_Invoke' example";
   myDelegate = gcnew AddListItem( this, &MyFormControl::AddListItemMethod );
}

void MyFormControl::ThreadFunction()
{
   MyThreadClass^ myThreadClassObject = gcnew MyThreadClass( this );
   myThreadClassObject->Run();
}

int main()
{
   MyFormControl^ myForm = gcnew MyFormControl;
   myForm->ShowDialog();
}

/*
The following example demonstrates the 'Invoke(Delegate)' method of 'Control class.
A 'ListBox' and a 'Button' control are added to a form, containing a delegate
which encapsulates a method that adds items to the listbox. This function is executed
on the thread that owns the underlying handle of the form. When user clicks on button
the above delegate is executed using 'Invoke' method.


*/

using System;
using System.Drawing;
using System.Windows.Forms;
using System.Threading;

   public class MyFormControl : Form
   {
      public delegate void AddListItem();
      public AddListItem myDelegate;
      private Button myButton;
      private Thread myThread;
      private ListBox myListBox;
      public MyFormControl()
      {
         myButton = new Button();
         myListBox = new ListBox();
         myButton.Location = new Point(72, 160);
         myButton.Size = new Size(152, 32);
         myButton.TabIndex = 1;
         myButton.Text = "Add items in list box";
         myButton.Click += new EventHandler(Button_Click);
         myListBox.Location = new Point(48, 32);
         myListBox.Name = "myListBox";
         myListBox.Size = new Size(200, 95);
         myListBox.TabIndex = 2;
         ClientSize = new Size(292, 273);
         Controls.AddRange(new Control[] {myListBox,myButton});
         Text = " 'Control_Invoke' example";
         myDelegate = new AddListItem(AddListItemMethod);
      }
      static void Main()
      {
         MyFormControl myForm = new MyFormControl();
         myForm.ShowDialog();
      }
      public void AddListItemMethod()
      {
         String myItem;
         for(int i=1;i<6;i++)
         {
            myItem = "MyListItem" + i.ToString();
            myListBox.Items.Add(myItem);
            myListBox.Update();
            Thread.Sleep(300);
         }
      }
      private void Button_Click(object sender, EventArgs e)
      {
         myThread = new Thread(new ThreadStart(ThreadFunction));
         myThread.Start();
      }
      private void ThreadFunction()
      {
         MyThreadClass myThreadClassObject  = new MyThreadClass(this);
         myThreadClassObject.Run();
      }
   }

// The following code assumes a 'ListBox' and a 'Button' control are added to a form, 
// containing a delegate which encapsulates a method that adds items to the listbox.

   public class MyThreadClass
   {
      MyFormControl myFormControl1;
      public MyThreadClass(MyFormControl myForm)
      {
         myFormControl1 = myForm;
      }

      public void Run()
      {
         // Execute the specified delegate on the thread that owns
         // 'myFormControl1' control's underlying window handle.
         myFormControl1.Invoke(myFormControl1.myDelegate);
      }
   }

' The following example demonstrates the 'Invoke(Delegate)' method of 'Control class.
' A 'ListBox' and a 'Button' control are added to a form, containing a delegate
' which encapsulates a method that adds items to the listbox. This function is executed
' on the thread that owns the underlying handle of the form. When user clicks on button
' the above delegate is executed using 'Invoke' method.

Imports System.Drawing
Imports System.Windows.Forms
Imports System.Threading

Public Class MyFormControl
   Inherits Form

   Delegate Sub AddListItem()
   Public myDelegate As AddListItem
   Private myButton As Button
   Private myThread As Thread
   Private myListBox As ListBox

   Public Sub New()
      myButton = New Button()
      myListBox = New ListBox()
      myButton.Location = New Point(72, 160)
      myButton.Size = New Size(152, 32)
      myButton.TabIndex = 1
      myButton.Text = "Add items in list box"
      AddHandler myButton.Click, AddressOf Button_Click
      myListBox.Location = New Point(48, 32)
      myListBox.Name = "myListBox"
      myListBox.Size = New Size(200, 95)
      myListBox.TabIndex = 2
      ClientSize = New Size(292, 273)
      Controls.AddRange(New Control() {myListBox, myButton})
      Text = " 'Control_Invoke' example"
      myDelegate = New AddListItem(AddressOf AddListItemMethod)
   End Sub

   Shared Sub Main()
      Dim myForm As New MyFormControl()
      myForm.ShowDialog()
   End Sub

   Public Sub AddListItemMethod()
      Dim myItem As String
      Dim i As Integer
      For i = 1 To 5
         myItem = "MyListItem" + i.ToString()
         myListBox.Items.Add(myItem)
         myListBox.Update()
         Thread.Sleep(300)
      Next i
   End Sub

   Private Sub Button_Click(sender As Object, e As EventArgs)
      myThread = New Thread(New ThreadStart(AddressOf ThreadFunction))
      myThread.Start()
   End Sub

   Private Sub ThreadFunction()
      Dim myThreadClassObject As New MyThreadClass(Me)
      myThreadClassObject.Run()
   End Sub
End Class


' The following code assumes a 'ListBox' and a 'Button' control are added to a form, 
' containing a delegate which encapsulates a method that adds items to the listbox.
Public Class MyThreadClass
   Private myFormControl1 As MyFormControl

   Public Sub New(myForm As MyFormControl)
      myFormControl1 = myForm
   End Sub

   Public Sub Run()
      ' Execute the specified delegate on the thread that owns
      ' 'myFormControl1' control's underlying window handle.
      myFormControl1.Invoke(myFormControl1.myDelegate)
   End Sub

End Class

注釈

デリゲートは、C 言語または C++ 言語の関数ポインターに似ています。 デリゲートは、デリゲート オブジェクト内のメソッドへの参照をカプセル化します。 その後、参照先のメソッドを呼び出すコードにデリゲート オブジェクトを渡すことができます。また、呼び出されるメソッドはコンパイル時に不明になる可能性があります。 C または C++ の関数ポインターとは異なり、デリゲートはオブジェクト指向で、型セーフで、より安全です。

メソッドは Invoke 、現在のコントロールの基になるウィンドウ ハンドルがまだ存在しない場合に、ウィンドウ ハンドルを持つコントロールまたはフォームが見つかるまで、コントロールの親チェーンを検索します。 適切なハンドルが見つからない場合、 Invoke メソッドは例外をスローします。 呼び出し中に発生する例外は、呼び出し元に反映されます。

注意

プロパティにInvokeRequired加えて、スレッド セーフEndInvokeInvokeBeginInvokeなコントロールには、および CreateGraphics コントロールのハンドルが既に作成されている場合の 4 つのメソッドがあります。 コントロールのハンドルがバックグラウンド スレッドで作成される前に を呼び出 CreateGraphics すと、スレッド間の呼び出しが無効になる可能性があります。 他のすべてのメソッド呼び出しでは、いずれかの呼び出しメソッドを使用して、コントロールのスレッドへの呼び出しをマーシャリングする必要があります。

デリゲートには の EventHandlerインスタンスを指定できます。この場合、sender パラメーターにはこのコントロールが含まれます。イベント パラメーターには が含まれます EventArgs.Empty。 デリゲートには、 の MethodInvokerインスタンス、または void パラメーター リストを受け取るその他のデリゲートを指定することもできます。 または MethodInvoker デリゲートのEventHandler呼び出しは、別の種類のデリゲートの呼び出しよりも高速になります。

注意

メッセージを処理するスレッドがアクティブでなくなった場合は、例外がスローされる可能性があります。

こちらもご覧ください

• MethodInvoker
• InvokeRequired

Invoke(Delegate, Object[])

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定した引数リストを使用して、指定したデリゲートを実行します。

public:
 virtual System::Object ^ Invoke(Delegate ^ method, ... cli::array <System::Object ^> ^ args);

public object Invoke (Delegate method, params object?[]? args);

abstract member Invoke : Delegate * obj[] -> obj
override this.Invoke : Delegate * obj[] -> obj

Public Function Invoke (method As Delegate, ParamArray args As Object()) As Object

パラメーター

method

Delegate

args パラメーターに指定されている数および型と同じ数および型のパラメーターをとるメソッドへのデリゲート。

args

Object[]

指定したメソッドに引数として渡すオブジェクトの配列。 メソッドが引数をとらない場合、このパラメーターは null にすることができます。

戻り値

Object

呼び出されるデリゲートからの戻り値を格納する Object。デリゲートに戻り値がない場合は null。

実装

Invoke(Delegate, Object[])

例

次のコード例は、デリゲートを含むコントロールを示しています。 デリゲートはリスト ボックスに項目を追加するメソッドをカプセル化し、このメソッドは、指定された引数を使用して、フォームの基になるハンドルを所有するスレッドで実行されます。 ユーザーがボタンをクリックすると、 Invoke デリゲートが実行されます。

using namespace System;
using namespace System::Drawing;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;
using namespace System::Threading;
ref class MyFormControl: public Form
{
public:
   delegate void AddListItem( String^ myString );
   AddListItem^ myDelegate;

private:
   Button^ myButton;
   Thread^ myThread;
   ListBox^ myListBox;

public:
   MyFormControl();
   void AddListItemMethod( String^ myString );

private:
   void Button_Click( Object^ sender, EventArgs^ e );
   void ThreadFunction();
};

ref class MyThreadClass
{
private:
   MyFormControl^ myFormControl1;

public:
   MyThreadClass( MyFormControl^ myForm )
   {
      myFormControl1 = myForm;
   }

   String^ myString;
   void Run()
   {
      for ( int i = 1; i <= 5; i++ )
      {
         myString = String::Concat( "Step number ", i, " executed" );
         Thread::Sleep( 400 );
         
         // Execute the specified delegate on the thread that owns
         // 'myFormControl1' control's underlying window handle with
         // the specified list of arguments.
         array<Object^>^myStringArray = {myString};
         myFormControl1->Invoke( myFormControl1->myDelegate, myStringArray );

      }
   }

};

MyFormControl::MyFormControl()
{
   myButton = gcnew Button;
   myListBox = gcnew ListBox;
   myButton->Location = Point(72,160);
   myButton->Size = System::Drawing::Size( 152, 32 );
   myButton->TabIndex = 1;
   myButton->Text = "Add items in list box";
   myButton->Click += gcnew EventHandler( this, &MyFormControl::Button_Click );
   myListBox->Location = Point(48,32);
   myListBox->Name = "myListBox";
   myListBox->Size = System::Drawing::Size( 200, 95 );
   myListBox->TabIndex = 2;
   ClientSize = System::Drawing::Size( 292, 273 );
   array<Control^>^formControls = {myListBox,myButton};
   Controls->AddRange( formControls );
   Text = " 'Control_Invoke' example ";
   myDelegate = gcnew AddListItem( this, &MyFormControl::AddListItemMethod );
}

void MyFormControl::AddListItemMethod( String^ myString )
{
   myListBox->Items->Add( myString );
}

void MyFormControl::Button_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
{
   myThread = gcnew Thread( gcnew ThreadStart( this, &MyFormControl::ThreadFunction ) );
   myThread->Start();
}

void MyFormControl::ThreadFunction()
{
   MyThreadClass^ myThreadClassObject = gcnew MyThreadClass( this );
   myThreadClassObject->Run();
}

int main()
{
   MyFormControl^ myForm = gcnew MyFormControl;
   myForm->ShowDialog();
}

using System;
using System.Drawing;
using System.Windows.Forms;
using System.Threading;

   public class MyFormControl : Form
   {
      public delegate void AddListItem(String myString);
      public AddListItem myDelegate;
      private Button myButton;
      private Thread myThread;
      private ListBox myListBox;
      public MyFormControl()
      {
         myButton = new Button();
         myListBox = new ListBox();
         myButton.Location = new Point(72, 160);
         myButton.Size = new Size(152, 32);
         myButton.TabIndex = 1;
         myButton.Text = "Add items in list box";
         myButton.Click += new EventHandler(Button_Click);
         myListBox.Location = new Point(48, 32);
         myListBox.Name = "myListBox";
         myListBox.Size = new Size(200, 95);
         myListBox.TabIndex = 2;
         ClientSize = new Size(292, 273);
         Controls.AddRange(new Control[] {myListBox,myButton});
         Text = " 'Control_Invoke' example ";
         myDelegate = new AddListItem(AddListItemMethod);
      }
      static void Main()
      {
         MyFormControl myForm = new MyFormControl();
         myForm.ShowDialog();
      }
      public void AddListItemMethod(String myString)
      {
            myListBox.Items.Add(myString);
      }
      private void Button_Click(object sender, EventArgs e)
      {
         myThread = new Thread(new ThreadStart(ThreadFunction));
         myThread.Start();
      }
      private void ThreadFunction()
      {
         MyThreadClass myThreadClassObject  = new MyThreadClass(this);
         myThreadClassObject.Run();
      }
   }
   public class MyThreadClass
   {
      MyFormControl myFormControl1;
      public MyThreadClass(MyFormControl myForm)
      {
         myFormControl1 = myForm;
      }
      String myString;

      public void Run()
      {

         for (int i = 1; i <= 5; i++)
         {
            myString = "Step number " + i.ToString() + " executed";
            Thread.Sleep(400);
            // Execute the specified delegate on the thread that owns
            // 'myFormControl1' control's underlying window handle with
            // the specified list of arguments.
            myFormControl1.Invoke(myFormControl1.myDelegate,
                                   new Object[] {myString});
         }
      }
   }

Imports System.Drawing
Imports System.Windows.Forms
Imports System.Threading

Public Class MyFormControl
   Inherits Form

   Delegate Sub AddListItem(myString As String)
   Public myDelegate As AddListItem
   Private myButton As Button
   Private myThread As Thread
   Private myListBox As ListBox

   Public Sub New()
      myButton = New Button()
      myListBox = New ListBox()
      myButton.Location = New Point(72, 160)
      myButton.Size = New Size(152, 32)
      myButton.TabIndex = 1
      myButton.Text = "Add items in list box"
      AddHandler myButton.Click, AddressOf Button_Click
      myListBox.Location = New Point(48, 32)
      myListBox.Name = "myListBox"
      myListBox.Size = New Size(200, 95)
      myListBox.TabIndex = 2
      ClientSize = New Size(292, 273)
      Controls.AddRange(New Control() {myListBox, myButton})
      Text = " 'Control_Invoke' example "
      myDelegate = New AddListItem(AddressOf AddListItemMethod)
   End Sub

   Shared Sub Main()
      Dim myForm As New MyFormControl()
      myForm.ShowDialog()
   End Sub

   Public Sub AddListItemMethod(myString As String)
      myListBox.Items.Add(myString)
   End Sub

   Private Sub Button_Click(sender As Object, e As EventArgs)
      myThread = New Thread(New ThreadStart(AddressOf ThreadFunction))
      myThread.Start()
   End Sub

   Private Sub ThreadFunction()
      Dim myThreadClassObject As New MyThreadClass(Me)
      myThreadClassObject.Run()
   End Sub
End Class

Public Class MyThreadClass
   Private myFormControl1 As MyFormControl

   Public Sub New(myForm As MyFormControl)
      myFormControl1 = myForm
   End Sub
   Private myString As String

   Public Sub Run()

      Dim i As Integer
      For i = 1 To 5
         myString = "Step number " + i.ToString() + " executed"
         Thread.Sleep(400)
         ' Execute the specified delegate on the thread that owns
         ' 'myFormControl1' control's underlying window handle with
         ' the specified list of arguments.
         myFormControl1.Invoke(myFormControl1.myDelegate, New Object() {myString})
      Next i

   End Sub
End Class

注釈

デリゲートは、C 言語または C++ 言語の関数ポインターに似ています。 デリゲートは、デリゲート オブジェクト内のメソッドへの参照をカプセル化します。 その後、参照先のメソッドを呼び出すコードにデリゲート オブジェクトを渡すことができます。また、呼び出されるメソッドはコンパイル時に不明になる可能性があります。 C または C++ の関数ポインターとは異なり、デリゲートはオブジェクト指向で、型セーフで、より安全です。

コントロールのハンドルがまだ存在しない場合、このメソッドは、ウィンドウ ハンドルを持つコントロールまたはフォームが見つかるまで、コントロールの親チェーンを検索します。 適切なハンドルが見つからない場合、このメソッドは例外をスローします。 呼び出し中に発生する例外は、呼び出し元に反映されます。

注意

プロパティにInvokeRequired加えて、スレッド セーフEndInvokeInvokeBeginInvokeなコントロールには、および CreateGraphics コントロールのハンドルが既に作成されている場合の 4 つのメソッドがあります。 コントロールのハンドルがバックグラウンド スレッドで作成される前に を呼び出 CreateGraphics すと、スレッド間の呼び出しが無効になる可能性があります。 他のすべてのメソッド呼び出しでは、いずれかの呼び出しメソッドを使用して、コントロールのスレッドへの呼び出しをマーシャリングする必要があります。

デリゲートには の EventHandlerインスタンスを指定できます。この場合、sender パラメーターにはこのコントロールが含まれます。イベント パラメーターには が含まれます EventArgs.Empty。 デリゲートには、 の MethodInvokerインスタンス、または void パラメーター リストを受け取るその他のデリゲートを指定することもできます。 または MethodInvoker デリゲートのEventHandler呼び出しは、別の種類のデリゲートの呼び出しよりも高速になります。

注意

メッセージを処理するスレッドがアクティブでなくなった場合は、例外がスローされる可能性があります。

こちらもご覧ください

• MethodInvoker
• InvokeRequired

Invoke<T>(Func<T>)

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。

public:
generic <typename T>
 T Invoke(Func<T> ^ method);

public T Invoke<T> (Func<T> method);

member this.Invoke : Func<'T> -> 'T

Public Function Invoke(Of T) (method As Func(Of T)) As T

型パラメーター

T

の戻り値の method型。

パラメーター

method

Func<T>

コントロールのスレッド コンテキストで呼び出される関数。

戻り値

T

呼び出される関数からの戻り値。