RealTimeStylus.GetDesiredPacketDescription (Método)

Artículo
11/26/2008

Actualización: noviembre 2007

Devuelve una matriz de valores que indican el paquete recopilado en un contexto de Tablet PC en el que tiene interés el objeto RealTimeStylus.

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

Sintaxis

'Declaración
Public Function GetDesiredPacketDescription As Guid()
'Uso
Dim instance As RealTimeStylus
Dim returnValue As Guid()

returnValue = instance.GetDesiredPacketDescription()

public Guid[] GetDesiredPacketDescription()

public:
array<Guid>^ GetDesiredPacketDescription()

public Guid[] GetDesiredPacketDescription()

public function GetDesiredPacketDescription() : Guid[]

Valor devuelto

Tipo: array<System.Guid[]
Devuelve los identificadores únicos globales (GUID) para las propiedades de paquete en las que el objeto RealTimeStylus tiene interés.

Comentarios

Utilice este método para obtener la matriz de propiedades de paquete en las que el objeto RealTimeStylus tiene interés. Las propiedades de paquete se representan mediante una matriz de GUID. El objeto PacketProperty define los GUID de las propiedades de paquete estándar, pero también se pueden utilizar otros GUID.

Cuando el objeto RealTimeStylus recopila la entrada manuscrita de un Tablet PC, el objeto RealTimeStylus sólo devuelve los datos de paquete que corresponden a las propiedades de paquete en las que esté interesado (según representa el valor devuelto del método GetDesiredPacketDescription) y que se admitan en el Tablet PC en el que se recopila la entrada manuscrita. Para obtener más información sobre cómo el objeto RealTimeStylus administra los datos de entrada manuscrita, vea Ink-Collection Plug-ins.

Sólo se puede llamar al método SetDesiredPacketDescription mientras el objeto RealTimeStylus está deshabilitado. Sin embargo, las llamadas al método SetDesiredPacketDescription se reflejan inmediatamente en el valor devuelto del método GetDesiredPacketDescription.

La lista siguiente describe cómo el objeto RealTimeStylus ordena los GUID de las propiedades de paquete.

El método GetDesiredPacketDescription siempre devuelve los GUID PacketProperty.X y PacketProperty.Y en las dos primeras posiciones de la matriz, se hayan especificado o no en una llamada anterior al método SetDesiredPacketDescription.
Si el GUID PacketProperty.PacketStatus se especifica en la llamada al método SetDesiredPacketDescription, el método GetDesiredPacketDescription siempre devuelve el GUID PacketProperty.PacketStatus en la última posición de la matriz.
Si un GUID se especifica varias veces en la llamada al método SetDesiredPacketDescription, cada GUID aparece una sola vez en la matriz devuelta por el método GetDesiredPacketDescription.
De forma predeterminada, el método GetDesiredPacketDescription devuelve los GUID PacketProperty.X, PacketProperty.Y y PacketProperty.NormalPressure.

Por ejemplo, si llama al método SetDesiredPacketDescription con (a, b, a, PacketStatus, b, c, d), una llamada al método GetDesiredPacketDescription devuelve (X, Y, a, b, c, d, PacketStatus).

Ejemplos

Este ejemplo de C# es un fragmento de código del controlador de evento Click de un elemento de menú. El menú forma parte de un formulario en el que se define un objeto TextBox, theTextBox. El controlador de eventos llama al método GetDesiredPacketDescription del objeto RealTimeStylus.

using Microsoft.Ink;
using Microsoft.StylusInput;
using Microsoft.StylusInput.PluginData;

// ...

// Declare the RealTimeStylus objects, the GestureRecognizer plugin,
// and the DynamicRenderer plug-in.
private Microsoft.StylusInput.RealTimeStylus thePrimaryRealTimeStylus = null;
private Microsoft.StylusInput.RealTimeStylus theSecondaryRealTimeStylus = null;
private Microsoft.StylusInput.GestureRecognizer theGestureRecognizer = null;
private Microsoft.StylusInput.DynamicRenderer theDynamicRenderer = null;

// ...

// The GetDesiredPacketDescription menu item's ClickEventHandler
private void theMenuItemGetDesiredPacketDescription_Click(object sender,
    System.EventArgs e)
{
    this.theTextBox.Text = "DesiredPacketDescription = " + Environment.NewLine;
    foreach (Guid theGuid in this.thePrimaryRealTimeStylus.GetDesiredPacketDescription())
    {
        this.theTextBox.Text += string.Format("  {0}" + Environment.NewLine,
            this.GetPacketPropertyNameFromGuid(theGuid));
    }
}

Plataformas

Windows Vista, Windows XP SP2, Windows Server 2003

.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.