Control.Invoke メソッド

定義

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、デリゲートを実行します。Executes a delegate on the thread that owns the control's underlying window handle.

オーバーロード

Invoke(Delegate)

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。Executes the specified delegate on the thread that owns the control's underlying window handle.

Invoke(Delegate, Object[])

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定した引数リストを使用して、指定したデリゲートを実行します。Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.

Invoke(Delegate)

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定したデリゲートを実行します。Executes the specified delegate on the thread that owns the control's underlying window handle.

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

コントロールのスレッド コンテキストで呼び出されるメソッドを格納しているデリゲート。A delegate that contains a method to be called in the control's thread context.

戻り値

呼び出されるデリゲートからの戻り値。デリゲートに戻り値がない場合は nullThe return value from the delegate being invoked, or null if the delegate has no return value.

次のコード例は、デリゲートを含むコントロールを示しています。The following code example shows controls that contain a delegate. デリゲートは、リストボックスに項目を追加するメソッドをカプセル化します。このメソッドは、フォームの基になるハンドルを所有するスレッド上で実行されます。The delegate encapsulates a method that adds items to the list box, and this method is executed on the thread that owns the underlying handle of the form. ユーザーがボタンをクリックすると、Invoke はデリゲートを実行します。When the user clicks on the button, Invoke runs the delegate.

/*
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++言語の関数ポインターに似ています。Delegates are similar to function pointers in C or C++ languages. デリゲートは、デリゲートオブジェクト内のメソッドへの参照をカプセル化します。Delegates encapsulate a reference to a method inside a delegate object. デリゲートオブジェクトは、参照されたメソッドを呼び出すコードに渡すことができます。また、呼び出すメソッドはコンパイル時に不明な場合があります。The delegate object can then be passed to code that calls the referenced method, and the method to be invoked can be unknown at compile time. C またはC++の関数ポインターとは異なり、デリゲートはオブジェクト指向でタイプセーフであり、セキュリティが強化されています。Unlike function pointers in C or C++, delegates are object-oriented, type-safe, and more secure.

Invoke メソッドは、現在のコントロールの基になるウィンドウハンドルがまだ存在しない場合にウィンドウハンドルを持つコントロールまたはフォームが見つかるまで、コントロールの親チェインを検索します。The Invoke method searches up the control's parent chain until it finds a control or form that has a window handle if the current control's underlying window handle does not exist yet. 適切なハンドルが見つからない場合は、Invoke メソッドによって例外がスローされます。If no appropriate handle can be found, the Invoke method will throw an exception. 呼び出し中に発生した例外は、呼び出し元に反映されます。Exceptions that are raised during the call will be propagated back to the caller.

注意

InvokeRequired プロパティに加えて、スレッドセーフであるコントロールには、InvokeBeginInvokeEndInvoke、および CreateGraphics コントロールのハンドルが既に作成されている場合の4つのメソッドがあります。In addition to the InvokeRequired property, there are four methods on a control that are thread safe: Invoke, BeginInvoke, EndInvoke, and CreateGraphics if the handle for the control has already been created. バックグラウンドスレッドでコントロールのハンドルが作成される前に CreateGraphics を呼び出すと、無効なクロススレッド呼び出しが発生する可能性があります。Calling CreateGraphics before the control's handle has been created on a background thread can cause illegal cross thread calls. その他のすべてのメソッド呼び出しでは、いずれかの invoke メソッドを使用して、コントロールのスレッドへの呼び出しをマーシャリングする必要があります。For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread.

デリゲートは EventHandler のインスタンスにすることができます。この場合、sender パラメーターにこのコントロールが含まれ、イベントパラメーターには EventArgs.Empty が含まれます。The delegate can be an instance of EventHandler, in which case the sender parameter will contain this control, and the event parameter will contain EventArgs.Empty. デリゲートは、MethodInvokerのインスタンス、または void パラメーターリストを受け取るその他のデリゲートにすることもできます。The delegate can also be an instance of MethodInvoker, or any other delegate that takes a void parameter list. EventHandler または MethodInvoker デリゲートの呼び出しは、別の種類のデリゲートの呼び出しよりも高速になります。A call to an EventHandler or MethodInvoker delegate will be faster than a call to another type of delegate.

注意

メッセージを処理する必要があるスレッドがアクティブでなくなった場合は、例外がスローされる可能性があります。An exception might be thrown if the thread that should process the message is no longer active.

こちらもご覧ください

Invoke(Delegate, Object[])

コントロールの基になるウィンドウ ハンドルを所有するスレッド上で、指定した引数リストを使用して、指定したデリゲートを実行します。Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.

public:
 virtual System::Object ^ Invoke(Delegate ^ method, cli::array <System::Object ^> ^ args);
public object Invoke (Delegate method, object[] args);
abstract member Invoke : Delegate * obj[] -> obj
override this.Invoke : Delegate * obj[] -> obj
Public Function Invoke (method As Delegate, args As Object()) As Object

パラメーター

method
Delegate

args パラメーターに指定されている数および型と同じ数および型のパラメーターをとるメソッドへのデリゲート。A delegate to a method that takes parameters of the same number and type that are contained in the args parameter.

args
Object[]

指定したメソッドに引数として渡すオブジェクトの配列。An array of objects to pass as arguments to the specified method. メソッドが引数をとらない場合、このパラメーターは null にすることができます。This parameter can be null if the method takes no arguments.

戻り値

呼び出されるデリゲートからの戻り値を格納する Object。デリゲートに戻り値がない場合は nullAn Object that contains the return value from the delegate being invoked, or null if the delegate has no return value.

実装

次のコード例は、デリゲートを含むコントロールを示しています。The following code example shows controls that contain a delegate. デリゲートは、リストボックスに項目を追加するメソッドをカプセル化します。このメソッドは、指定された引数を使用して、フォームの基になるハンドルを所有するスレッド上で実行されます。The delegate encapsulates a method that adds items to the list box, and this method is executed on the thread that owns the underlying handle of the form, using the specified arguments. ユーザーがボタンをクリックすると、Invoke はデリゲートを実行します。When the user clicks on the button, Invoke runs the delegate.

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++言語の関数ポインターに似ています。Delegates are similar to function pointers in C or C++ languages. デリゲートは、デリゲートオブジェクト内のメソッドへの参照をカプセル化します。Delegates encapsulate a reference to a method inside a delegate object. デリゲートオブジェクトは、参照されたメソッドを呼び出すコードに渡すことができます。また、呼び出すメソッドはコンパイル時に不明な場合があります。The delegate object can then be passed to code that calls the referenced method, and the method to be invoked can be unknown at compile time. C またはC++の関数ポインターとは異なり、デリゲートはオブジェクト指向でタイプセーフであり、セキュリティが強化されています。Unlike function pointers in C or C++, delegates are object-oriented, type-safe, and more secure.

コントロールのハンドルがまだ存在しない場合、このメソッドは、ウィンドウハンドルを持つコントロールまたはフォームが見つかるまで、コントロールの親チェインを検索します。If the control's handle does not exist yet, this method searches up the control's parent chain until it finds a control or form that does have a window handle. 適切なハンドルが見つからない場合、このメソッドは例外をスローします。If no appropriate handle can be found, this method throws an exception. 呼び出し中に発生した例外は、呼び出し元に反映されます。Exceptions that are raised during the call will be propagated back to the caller.

注意

InvokeRequired プロパティに加えて、スレッドセーフであるコントロールには、InvokeBeginInvokeEndInvoke、および CreateGraphics コントロールのハンドルが既に作成されている場合の4つのメソッドがあります。In addition to the InvokeRequired property, there are four methods on a control that are thread safe: Invoke, BeginInvoke, EndInvoke, and CreateGraphics if the handle for the control has already been created. バックグラウンドスレッドでコントロールのハンドルが作成される前に CreateGraphics を呼び出すと、無効なクロススレッド呼び出しが発生する可能性があります。Calling CreateGraphics before the control's handle has been created on a background thread can cause illegal cross thread calls. その他のすべてのメソッド呼び出しでは、いずれかの invoke メソッドを使用して、コントロールのスレッドへの呼び出しをマーシャリングする必要があります。For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread.

デリゲートは EventHandler のインスタンスにすることができます。この場合、sender パラメーターにこのコントロールが含まれ、イベントパラメーターには EventArgs.Empty が含まれます。The delegate can be an instance of EventHandler, in which case the sender parameter will contain this control, and the event parameter will contain EventArgs.Empty. デリゲートは、MethodInvokerのインスタンス、または void パラメーターリストを受け取るその他のデリゲートにすることもできます。The delegate can also be an instance of MethodInvoker, or any other delegate that takes a void parameter list. EventHandler または MethodInvoker デリゲートの呼び出しは、別の種類のデリゲートの呼び出しよりも高速になります。A call to an EventHandler or MethodInvoker delegate will be faster than a call to another type of delegate.

注意

メッセージを処理する必要があるスレッドがアクティブでなくなった場合は、例外がスローされる可能性があります。An exception might be thrown if the thread that should process the message is no longer active.

こちらもご覧ください

適用対象