Assembly : System (dans system.dll)
SyntaxePublic ReadOnly Property Cancelled As Boolean
Dim instance As AsyncCompletedEventArgs Dim value As Boolean value = instance.Cancelled
public bool Cancelled { get; }
public: property bool Cancelled { bool get (); }
/** @property */
public boolean get_Cancelled ()
public function get Cancelled () : boolean
Valeur de la propriété
true si l'opération d'arrière-plan a été annulée ; sinon, false. La valeur par défaut est false.
NotesLorsque la propriété Cancelled a la valeur true, l'opération asynchrone a été interrompue.
Le délégué de gestionnaire d'événements de l'application cliente doit vérifier la propriété Cancelled avant d'accéder à toute propriété d'une classe dérivée de AsyncCompletedEventArgs ; sinon, la propriété lève une exception InvalidOperationException en cas d'interruption de l'opération asynchrone.
Remarques à l'attention des héritiers Si vous fournissez des propriétés en lecture seule dans une classe dérivée, veillez à appeler la méthode RaiseExceptionIfNecessary. Cette opération empêche des clients d'accéder aux propriétés qui risquent de n'être pas valides en raison d'une défaillance dans l'opération asynchrone.
ExempleL'exemple de code suivant montre comment utiliser AsyncOperation pour suivre la durée de vie des opérations asynchrones. Cet exemple de code fait partie d'un exemple plus développé fourni pour la classe System.ComponentModel.AsyncOperationManager.
Imports System Imports System.Collections Imports System.Collections.Specialized Imports System.ComponentModel Imports System.Drawing Imports System.Globalization Imports System.Threading Imports System.Windows.Forms ... ' This event handler updates the ListView control when the ' PrimeNumberCalculator raises the CalculatePrimeCompleted ' event. The ListView item is updated with the appropriate ' outcome of the calculation: Canceled, Error, or result. Private Sub primeNumberCalculator1_CalculatePrimeCompleted( _ ByVal sender As Object, _ ByVal e As CalculatePrimeCompletedEventArgs) _ Handles primeNumberCalculator1.CalculatePrimeCompleted Dim taskId As Guid = CType(e.UserState, Guid) If e.Cancelled Then Dim result As String = "Canceled" Dim lvi As ListViewItem = UpdateListViewItem( _ taskId, _ result) If Not (lvi Is Nothing) Then lvi.BackColor = Color.Pink lvi.Tag = Nothing End If ElseIf e.Error IsNot Nothing Then Dim result As String = "Error" Dim lvi As ListViewItem = UpdateListViewItem( _ taskId, result) If Not (lvi Is Nothing) Then lvi.BackColor = Color.Red lvi.ForeColor = Color.White lvi.Tag = Nothing End If Else Dim result As Boolean = e.IsPrime Dim lvi As ListViewItem = UpdateListViewItem( _ taskId, _ result, _ e.FirstDivisor) If Not (lvi Is Nothing) Then lvi.BackColor = Color.LightGray lvi.Tag = Nothing End If End If End Sub
using System; using System.Collections; using System.Collections.Specialized; using System.ComponentModel; using System.Data; using System.Drawing; using System.Globalization; using System.Threading; using System.Windows.Forms; ... // This event handler updates the ListView control when the // PrimeNumberCalculator raises the CalculatePrimeCompleted // event. The ListView item is updated with the appropriate // outcome of the calculation: Canceled, Error, or result. private void primeNumberCalculator1_CalculatePrimeCompleted( object sender, CalculatePrimeCompletedEventArgs e) { Guid taskId = (Guid)e.UserState; if (e.Cancelled) { string result = "Canceled"; ListViewItem lvi = UpdateListViewItem(taskId, result); if (lvi != null) { lvi.BackColor = Color.Pink; lvi.Tag = null; } } else if (e.Error != null) { string result = "Error"; ListViewItem lvi = UpdateListViewItem(taskId, result); if (lvi != null) { lvi.BackColor = Color.Red; lvi.ForeColor = Color.White; lvi.Tag = null; } } else { bool result = e.IsPrime; ListViewItem lvi = UpdateListViewItem( taskId, result, e.FirstDivisor); if (lvi != null) { lvi.BackColor = Color.LightGray; lvi.Tag = null; } } }
import System.*; import System.Collections.*; import System.Collections.Specialized.*; import System.ComponentModel.*; import System.Data.*; import System.Drawing.*; import System.Threading.*; import System.Windows.Forms.*; ... private void primeNumberCalculator1_CalculatePrimeCompleted(Object sender, CalculatePrimeCompletedEventArgs e) { Guid guid = (Guid)e.get_UserState(); if (e.get_Cancelled()) { String result = "Cancelled"; ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(), result); if (lvi != null) { lvi.set_BackColor(Color.get_Pink()); lvi.set_Tag(null); } } else { if (e.get_Error() != null) { String result = "Error"; ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(), result); if (lvi != null) { lvi.set_BackColor(Color.get_Red()); lvi.set_ForeColor(Color.get_White()); lvi.set_Tag(null); } } else { boolean result = e.get_IsPrime(); ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(), result, e.get_FirstDivisor()); if (lvi != null) { lvi.set_BackColor(Color.get_LightGray()); lvi.set_Tag(null); } } } } //primeNumberCalculator1_CalculatePrimeCompleted
Plates-formesWindows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition
Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.
Voir aussiRéférence
AsyncCompletedEventArgs, classeMembres AsyncCompletedEventArgs
System.ComponentModel, espace de noms
System.ComponentModel.AsyncCompletedEventHandler
System.ComponentModel.AsyncOperationManager
System.ComponentModel.AsyncOperation
Outils (masquer)
S'enregistrer
Liste des Membres
Qui est en ligne?
FAQ