InkAnalyzer.Abort, méthode

Article
11/05/2008

Mise à jour : November 2007

Annule l'opération d'analyse en cours.

Espace de noms : Microsoft.Ink
Assembly : Microsoft.Ink.Analysis (dans Microsoft.Ink.Analysis.dll)

Syntaxe

'Déclaration
Public Function Abort As AnalysisRegion
'Utilisation
Dim instance As InkAnalyzer
Dim returnValue As AnalysisRegion

returnValue = instance.Abort()

public AnalysisRegion Abort()

public:
AnalysisRegion^ Abort()

public AnalysisRegion Abort()

public function Abort() : AnalysisRegion

Valeur de retour

Type : Microsoft.Ink.AnalysisRegion
Région modifiée de l'opération d'analyse en cours.

Notes

Après l'appel à cette méthode, le InkAnalyzer cesse de déclencher des événements pour l'opération d'analyse annulée. Si une opération d'analyse d'arrière-plan est annulée, cette méthode s'exécute de manière asynchrone jusqu'à ce que le InkAnalyzer arrête l'opération.

Si aucune opération d'analyse n'est en cours, la méthode Abort retourne une région d'analyse vide.

Si une opération d'analyse est en cours, la méthode Abort annule l'opération.

Si des opérations d'analyse synchrones et asynchrones sont en cours, la méthode Abort annule l'opération synchrone.

Si cette méthode est appelée plusieurs fois pour la même opération d'analyse, le premier appel retourne la région modifiée pour l'opération et les appels suivants retournent une région vide.

Si votre application gère sa propre structure de données, synchronisée avec celle du InkAnalyzer, l'appel à la méthode Abort peut laisser des résultats partiels sur votre document. Pour éviter cela, n'appelez pas la méthode Abort entre le moment où le InkAnalyzer déclenche l'événement InkAnalyzerStateChanging et le moment où le InkAnalyzer déclenche l'événement IntermediateResultsUpdated ou ResultsUpdated.

Pour plus d'informations sur la synchronisation des données d'application avec InkAnalyzer, consultez Data Proxy with Ink Analysis.

Exemples

Cet exemple définit un gestionnaire d'événements pour l'événement InkAnalyzer.Activity. Si l'opération d'analyse doit être annulée, le gestionnaire d'événements appelle la méthode Abort sur le InkAnalyzer qui a généré l'événement et met à jour la propriété DirtyRegion de l'objet InkAnalyzer.

''' <summary>
''' The ink analyzer's Activity event handler.
''' </summary>
''' <param name="sender">The source of the event.</param>
''' <param name="e">The event data.</param>
Sub theInkAnalyzer_Activity(ByVal sender As Object, ByVal e As EventArgs)
    Dim abortAnalysis As Boolean = False

    ' Check if the analysis operation should be canceled.
    ' Abort analysis if the flag to do so is set.
    If abortAnalysis Then
        ' Get the InkAnalyzer that raised the Activity event.
        Dim theInkAnalyzer As Microsoft.Ink.InkAnalyzer = _
            DirectCast(sender, Microsoft.Ink.InkAnalyzer)

        ' Abort the analysis and get the region that was being analyzed.
        Dim theAnalysisRegion As Microsoft.Ink.AnalysisRegion = _
            theInkAnalyzer.Abort()

        ' Add the region that was being analyzed to the analyzer's dirty region.
        theInkAnalyzer.DirtyRegion.Union(theAnalysisRegion)
    End If

End Sub 'theInkAnalyzer_Activity

/// <summary>
/// The ink analyzer's Activity event handler.
/// </summary>
/// <param name="sender">The source of the event.</param>
/// <param name="e">The event data.</param>
void theInkAnalyzer_Activity(object sender, EventArgs e)
{
    bool abortAnalysis = false;

    // Check if the analysis operation should be canceled.

    // Abort analysis if the flag to do so is set.
    if (abortAnalysis)
    {
        // Get the InkAnalyzer that raised the Activity event.
        Microsoft.Ink.InkAnalyzer theInkAnalyzer =
            sender as Microsoft.Ink.InkAnalyzer;

        // Abort the analysis and get the region that was being analyzed.
        Microsoft.Ink.AnalysisRegion theAnalysisRegion = theInkAnalyzer.Abort();

        // Add the region that was being analyzed to the analyzer's dirty region.
        theInkAnalyzer.DirtyRegion.Union(theAnalysisRegion);
    }
}

Plateformes

Windows Vista

Le .NET Framework et le .NET Compact Framework ne prennent pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.