RealTimeStylus.SetDesiredPacketDescription (Método)

Artículo
10/28/2008

Actualización: noviembre 2007

Establece el interés del objeto RealTimeStylus en aspectos del paquete recopilado en un contexto de Tablet PC.

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

Sintaxis

'Declaración
Public Sub SetDesiredPacketDescription ( _
    value As Guid() _
)
'Uso
Dim instance As RealTimeStylus
Dim value As Guid()

instance.SetDesiredPacketDescription(value)

public void SetDesiredPacketDescription(
    Guid[] value
)

public:
void SetDesiredPacketDescription(
    array<Guid>^ value
)

public void SetDesiredPacketDescription(
    Guid[] value
)

public function SetDesiredPacketDescription(
    value : Guid[]
)

Parámetros

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

Comentarios

Use este método para establecer el interés del objeto RealTimeStylus en un conjunto de propiedades de paquete. 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 objeto Tablet, 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 recopilar entrada manuscrita mediante el objeto RealTimeStylus, vea Accessing and Manipulating Stylus Input.

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

Este método inicia una excepción en las condiciones siguientes.

El objeto RealTimeStylus se desecha.
El objeto RealTimeStylus se creó con el constructor RealTimeStylus().
El objeto RealTimeStylus está habilitado.
El parámetro value es nullreferencia null (Nothing en Visual Basic) (Nothing en Visual Basic .NET) o contiene una matriz vacía.

Ejemplos

Este ejemplo de Microsoft Visual C# .NET es un fragmento de código del controlador de eventos Click de un elemento de menú. El menú forma parte de un formulario en el que se define un objeto TextBox, theTextBox. Si el objeto RealTimeStylus está habilitado o si no se activa ninguno de los GUID de propiedad de paquete en el formulario, se produce la salida del controlador de eventos. De lo contrario, el controlador de eventos llama al método SetDesiredPacketDescription 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 SetDesiredPacketDescription menu item's Click event handler
private void theMenuItemSetDesiredPacketDescription_Click(object sender,
    System.EventArgs e)
{
    // Can not call this method while the RealTimeStylus is enabled.
    if (this.thePrimaryRealTimeStylus.Enabled)
    {
        MessageBox.Show("The SetDesiredPacketDescription method of the RealTimeStylus can only be called while the RealTimeStylus is disabled.");
        return;
    }

    // Create an array of GUIDs from the checked packet properties.
    ArrayList result = new ArrayList();

    // ...

    // Can not pass an empty array to the SetDesiredPacketDescription method.
    if (0 == result.Count)
    {
        this.theTextBox.Text = "No PacketProperty GUID's checked. The desired packet property's of the RealTimeStylus have not been changed.";
        return;
    }

    // Set the desired packet properties.
    Guid[] theGuids = (Guid[])result.ToArray(typeof(Guid));
    this.thePrimaryRealTimeStylus.SetDesiredPacketDescription(theGuids);
    this.theTextBox.Text = "The desired packet property's of the RealTimeStylus have been changed.";
}

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.