Control.Invoke Control.Invoke Control.Invoke Control.Invoke Method

Определение

Выполняет делегат в том потоке, которому принадлежит базовый дескриптор окна элемента управления.Executes a delegate on the thread that owns the control's underlying window handle.

Перегрузки

Invoke(Delegate) Invoke(Delegate) Invoke(Delegate) Invoke(Delegate)

Выполняет указанный делегат в том потоке, которому принадлежит базовый дескриптор окна элемента управления.Executes the specified delegate on the thread that owns the control's underlying window handle.

Invoke(Delegate, Object[]) Invoke(Delegate, Object[]) Invoke(Delegate, Object[]) 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) Invoke(Delegate) Invoke(Delegate) 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 Delegate Delegate Delegate

Делегат, содержащий метод, который требуется вызывать в контексте потока элемента управления.A delegate that contains a method to be called in the control's thread context.

Возвраты

Значение, возвращаемое вызываемым делегатом, или значение null, если делегат не возвращает никакого значения.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. Когда пользователь нажимает кнопку, 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 свойства, существует четыре метода элемента управления, которые являются потокобезопасными: Invoke, BeginInvoke EndInvoke, и CreateGraphics , если уже был создан обработчик для элемента управления.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.EmptyThe 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[]) Invoke(Delegate, Object[]) Invoke(Delegate, Object[]) 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 Delegate Delegate 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, содержащий возвращаемое значение от вызываемого делегата, или значение null, если делегат не имеет возвращаемого значения.An 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 свойства, существует четыре метода элемента управления, которые являются потокобезопасными: Invoke, BeginInvoke EndInvoke, и CreateGraphics , если уже был создан обработчик для элемента управления.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.EmptyThe 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.

Дополнительно

Применяется к