InkAnalyzer.Abort (Método)

Artículo
10/28/2008

Actualización: noviembre 2007

Cancela la operación de análisis actual.

Espacio de nombres: Microsoft.Ink
Ensamblado: Microsoft.Ink.Analysis (en Microsoft.Ink.Analysis.dll)

Sintaxis

'Declaración
Public Function Abort As AnalysisRegion
'Uso
Dim instance As InkAnalyzer
Dim returnValue As AnalysisRegion

returnValue = instance.Abort()

public AnalysisRegion Abort()

public:
AnalysisRegion^ Abort()

public AnalysisRegion Abort()

public function Abort() : AnalysisRegion

Valor devuelto

Tipo: Microsoft.Ink.AnalysisRegion
La región modificada de la operación de análisis actual.

Comentarios

Una vez llamado este método, el objeto InkAnalyzer deja de provocar eventos para la operación de análisis cancelada. Si se cancela una operación de análisis en segundo plano, este método se ejecuta de forma asincrónica hasta que InkAnalyzer detenga la operación.

Si no hay ninguna operación de análisis en curso, el método Abort devuelve una región de análisis vacía.

Si hay una operación de análisis en curso, el método Abort cancela la operación.

Si hay operaciones de análisis sincrónicas y asincrónicas en curso, el método Abort cancela la operación síncrona.

Si se llama a este método más de una vez para la misma operación de análisis, la primera llamada devuelve la región modificada de la operación y las llamadas subsiguientes devuelven una región vacía.

Si la aplicación mantiene su propia estructura de datos que se sincroniza con la del objeto InkAnalyzer, si se llama al método Abort el documento puede obtener resultados parciales. Para evitar esto, no llame al método Abort entre el momento en el que el objeto InkAnalyzer provoca el evento InkAnalyzerStateChanging y el momento en el que el objeto InkAnalyzer provoca el evento ResultsUpdated o IntermediateResultsUpdated.

Para obtener más información sobre la sincronización de los datos de la aplicación con el objeto InkAnalyzer, vea Data Proxy with Ink Analysis.

Ejemplos

En este ejemplo se define un controlador del evento InkAnalyzer.Activity. Si se debe cancelar la operación de análisis, el controlador de eventos llama al método Abort en el objeto InkAnalyzer que generó el evento y actualiza la propiedad DirtyRegion del objeto 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);
    }
}

Plataformas

Windows Vista

.NET Framework y .NET Compact Framework no admiten todas las versiones de cada plataforma. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.