Control.Invoke Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Spustí delegáta ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku.
Přetížení
Invoke(Action) |
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku. |
Invoke(Delegate) |
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku. |
Invoke(Delegate, Object[]) |
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku, se zadaným seznamem argumentů. |
Invoke<T>(Func<T>) |
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku. |
Invoke(Action)
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku.
public:
void Invoke(Action ^ method);
public void Invoke (Action method);
member this.Invoke : Action -> unit
Public Sub Invoke (method As Action)
Parametry
- method
- Action
Delegát, který obsahuje metodu, která se má volat v kontextu vlákna ovládacího prvku.
Platí pro
Invoke(Delegate)
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku.
public:
System::Object ^ Invoke(Delegate ^ method);
public object Invoke (Delegate method);
member this.Invoke : Delegate -> obj
Public Function Invoke (method As Delegate) As Object
Parametry
- method
- Delegate
Delegát, který obsahuje metodu, která se má volat v kontextu vlákna ovládacího prvku.
Návraty
Vrácená hodnota z vyvolané delegáta nebo null
, pokud delegát nemá žádnou vrácenou hodnotu.
Příklady
Následující příklad kódu ukazuje ovládací prvky, které obsahují delegáta. Delegát zapouzdřuje metodu, která přidává položky do seznamu, a tato metoda se provádí ve vlákně, které vlastní podkladový popisovač formuláře. Když uživatel klikne na tlačítko, Invoke
spustí delegáta.
/*
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
Poznámky
Delegáti se podobají ukazatelům funkcí v jazycích C nebo C++. Delegáti zapouzdřují odkaz na metodu uvnitř objektu delegáta. Delegovaný objekt lze pak předat kódu, který volá odkazovanou metodu, a metoda, která se má vyvolat, může být v době kompilace neznámá. Na rozdíl od ukazatelů funkcí v jazyce C nebo C++ jsou delegáti objektově orientované, typově bezpečné a bezpečnější.
Metoda Invoke hledá nadřazený řetězec ovládacího prvku, dokud nenajde ovládací prvek nebo formulář, který má popisovač okna, pokud podkladový popisovač okna aktuálního ovládacího prvku ještě neexistuje. Pokud nenajdete žádný vhodný popisovač, metoda Invoke vyvolá výjimku. Výjimky, které jsou vyvolány během volání, se rozšíří zpět do volajícího.
Poznámka
Kromě vlastnosti InvokeRequired existují čtyři metody ovládacího prvku, který je bezpečný pro vlákno: Invoke, BeginInvoke, EndInvokea CreateGraphics, pokud je popisovač pro ovládací prvek již vytvořen. Volání CreateGraphics před vytvořením popisovače ovládacího prvku ve vlákně na pozadí může způsobit nelegální volání mezi vlákny. Pro všechna ostatní volání metod byste měli použít jednu z metod vyvolání zařazování volání do vlákna ovládacího prvku.
Delegát může být instancí EventHandler, v takovém případě bude parametr odesílatele obsahovat tento ovládací prvek a parametr události bude obsahovat EventArgs.Empty. Delegátem může být také instance MethodInvokernebo jakýkoli jiný delegát, který přebírá seznam parametrů void. Volání delegáta EventHandler nebo MethodInvoker bude rychlejší než volání jiného typu delegáta.
Poznámka
Pokud vlákno, které by mělo zprávu zpracovat, již není aktivní, může být vyvolán výjimka.
Viz také
Platí pro
Invoke(Delegate, Object[])
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku, se zadaným seznamem argumentů.
public:
virtual System::Object ^ Invoke(Delegate ^ method, cli::array <System::Object ^> ^ args);
public:
virtual System::Object ^ Invoke(Delegate ^ method, ... cli::array <System::Object ^> ^ args);
public object Invoke (Delegate method, object[] args);
public object Invoke (Delegate method, params 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, args As Object()) As Object
Public Function Invoke (method As Delegate, ParamArray args As Object()) As Object
Parametry
- method
- Delegate
Delegát metody, která přebírá parametry stejného čísla a typu, které jsou obsaženy v parametru args
.
- args
- Object[]
Pole objektů, které se mají předat jako argumenty zadané metodě. Tento parametr může být null
, pokud metoda nepřijímá žádné argumenty.
Návraty
Object, která obsahuje návratovou hodnotu z vyvolané delegáta, nebo null
, pokud delegát nemá žádnou návratovou hodnotu.
Implementuje
Příklady
Následující příklad kódu ukazuje ovládací prvky, které obsahují delegáta. Delegát zapouzdřuje metodu, která přidává položky do seznamu, a tato metoda se provádí ve vlákně, které vlastní podkladový popisovač formuláře pomocí zadaných argumentů. Když uživatel klikne na tlačítko, Invoke
spustí delegáta.
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
Poznámky
Delegáti se podobají ukazatelům funkcí v jazycích C nebo C++. Delegáti zapouzdřují odkaz na metodu uvnitř objektu delegáta. Delegovaný objekt lze pak předat kódu, který volá odkazovanou metodu, a metoda, která se má vyvolat, může být v době kompilace neznámá. Na rozdíl od ukazatelů funkcí v jazyce C nebo C++ jsou delegáti objektově orientované, typově bezpečné a bezpečnější.
Pokud popisovač ovládacího prvku ještě neexistuje, tato metoda vyhledá nadřazený řetězec ovládacího prvku, dokud nenajde ovládací prvek nebo formulář, který má popisovač okna. Pokud nelze najít žádný vhodný popisovač, tato metoda vyvolá výjimku. Výjimky, které jsou vyvolány během volání, se rozšíří zpět do volajícího.
Poznámka
Kromě vlastnosti InvokeRequired existují čtyři metody ovládacího prvku, který je bezpečný pro vlákno: Invoke, BeginInvoke, EndInvokea CreateGraphics, pokud je popisovač pro ovládací prvek již vytvořen. Volání CreateGraphics před vytvořením popisovače ovládacího prvku ve vlákně na pozadí může způsobit nelegální volání mezi vlákny. Pro všechna ostatní volání metod byste měli použít jednu z metod vyvolání zařazování volání do vlákna ovládacího prvku.
Delegát může být instancí EventHandler, v takovém případě budou parametry záviset na args
hodnotě:
- Pokud nejsou předány žádné parametry, parametr odesílatele bude obsahovat tento ovládací prvek a parametr události bude obsahovat EventArgs.Empty.
- Při předání jednoho parametru bude parametr sender obsahovat první prvek args a parametr události bude obsahovat EventArgs.Empty.
- Pokud je předán více než jeden parametr, bude parametr sender obsahovat první prvek z
args
a EventArgs parametr bude obsahovat druhý prvek.
Volání delegáta EventHandler nebo MethodInvoker bude rychlejší než volání jiného typu delegáta.
Poznámka
Pokud vlákno, které by mělo zprávu zpracovat, již není aktivní, může být vyvolán výjimka.
Viz také
Platí pro
Invoke<T>(Func<T>)
Spustí zadaný delegát ve vlákně, které vlastní podkladový popisovač okna ovládacího prvku.
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
Parametry typu
- T
Návratový typ method
.
Parametry
- method
- Func<T>
Funkce, která se má volat v kontextu vlákna ovládacího prvku.
Návraty
Vrácená hodnota z funkce, která se vyvolá.