StylusPointDescription Class

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the properties that are in a StylusPoint.

public ref class StylusPointDescription

public class StylusPointDescription

type StylusPointDescription = class

Public Class StylusPointDescription

Inheritance: Object
StylusPointDescription

Examples

The following example gets the StylusPointDescription for a StylusPointCollection and gets the information for each StylusPointPropertyInfo in the StylusPointDescription.

private void WriteDescriptionInfo(StylusPointCollection points)
{
    StylusPointDescription pointsDescription = points.Description;
    ReadOnlyCollection<StylusPointPropertyInfo> properties = 
        pointsDescription.GetStylusPointProperties();

    StringWriter descriptionStringWriter = new StringWriter();
    descriptionStringWriter.Write("Property Count:{0}", pointsDescription.PropertyCount.ToString());
    
    foreach (StylusPointPropertyInfo property in properties)
    {
        // GetStylusPointPropertyName is defined below and returns the
        // name of the property.
        descriptionStringWriter.Write("name = {0}", GetStylusPointPropertyName(property).ToString());
        descriptionStringWriter.WriteLine("  Guid = {0}", property.Id.ToString());
        descriptionStringWriter.Write("  IsButton = {0}", property.IsButton.ToString());
        descriptionStringWriter.Write("  Min = {0}", property.Minimum.ToString());
        descriptionStringWriter.Write("  Max = {0}", property.Maximum.ToString());
        descriptionStringWriter.Write("  Unit = {0}", property.Unit.ToString());
        descriptionStringWriter.WriteLine("  Res {0}", property.Resolution.ToString());
    }

    descriptionOutput.Text = descriptionStringWriter.ToString();
}

Private Sub WriteDescriptionInfo(ByVal points As StylusPointCollection) 

    Dim pointsDescription As StylusPointDescription = points.Description

    Dim properties As ReadOnlyCollection(Of StylusPointPropertyInfo) = _
        pointsDescription.GetStylusPointProperties()

    Dim descriptionStringWriter As New StringWriter
    descriptionStringWriter.Write("Property Count:{0}", pointsDescription.PropertyCount.ToString())
    
    Dim pointProperty As StylusPointPropertyInfo
    For Each pointProperty In properties

        ' GetStylusPointPropertyName is defined below and returns the
        ' name of the property.
        descriptionStringWriter.Write("name = {0}", GetStylusPointPropertyName(pointProperty).ToString())
        descriptionStringWriter.WriteLine("  Guid = {0}", pointProperty.Id.ToString())
        descriptionStringWriter.Write("  IsButton = {0}", pointProperty.IsButton.ToString())
        descriptionStringWriter.Write("  Min = {0}", pointProperty.Minimum.ToString())
        descriptionStringWriter.Write("  Max = {0}", pointProperty.Maximum.ToString())
        descriptionStringWriter.Write("  Unit = {0}", pointProperty.Unit.ToString())
        descriptionStringWriter.WriteLine("  Res {0}", pointProperty.Resolution.ToString())

    Next pointProperty

    descriptionOutput.Text = descriptionStringWriter.ToString()

End Sub

// Use reflection to get the name of currentProperty.
private string GetStylusPointPropertyName(StylusPointProperty currentProperty)
{
    Guid guid = currentProperty.Id;

    // Iterate through the StylusPointProperties to find the StylusPointProperty
    // that matches currentProperty, then return the name.
    foreach (FieldInfo theFieldInfo
        in typeof(StylusPointProperties).GetFields())
    {
        StylusPointProperty property = (StylusPointProperty) theFieldInfo.GetValue(currentProperty);
        if (property.Id == guid)
        {
            return theFieldInfo.Name;
        }
    }
    return "Not found";
}

' Use reflection to get the name of currentProperty.
Private Function GetStylusPointPropertyName(ByVal currentProperty As StylusPointProperty) As String 
    Dim guid As Guid = currentProperty.Id
    
    ' Iterate through the StylusPointProperties to find the StylusPointProperty
    ' that matches currentProperty, then return the name.
    Dim theFieldInfo As FieldInfo

    For Each theFieldInfo In GetType(StylusPointProperties).GetFields()

        Dim pointProperty As StylusPointProperty = _
            CType(theFieldInfo.GetValue(currentProperty), StylusPointProperty)

        If pointProperty.Id = guid Then
            Return theFieldInfo.Name
        End If

    Next theFieldInfo

    Return "Not found"

End Function 'GetStylusPointPropertyName

Remarks

A StylusPointDescription specifies which properties are associated with a StylusPoint. For each property in a StylusPoint, the StylusPointDescription contains a StylusPointPropertyInfo object which specifies constraints such as the minimum and maximum values of the property. Use the HasProperty and GetPropertyInfo methods to check for these properties in the StylusPointDescription.

All StylusPoint objects in a StylusPointCollection must share the same StylusPointDescription. If you try to add a StylusPoint to a StylusPointCollection that has a different StylusPointDescription, an exception will be thrown.

Constructors

StylusPointDescription()	Initializes a new instance of the StylusPointDescription class.
StylusPointDescription(IEnumerable<StylusPointPropertyInfo>)	Initializes a new instance of the StylusPointDescription class with the specified StylusPointPropertyInfo objects.

Properties

PropertyCount

Gets the number of properties in the StylusPointDescription.

Methods

AreCompatible(StylusPointDescription, StylusPointDescription)	Returns a value that indicates whether the specified StylusPointDescription objects are identical.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetCommonDescription(StylusPointDescription, StylusPointDescription)	Returns the intersection of the specified StylusPointDescription objects.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPropertyInfo(StylusPointProperty)	Gets the StylusPointPropertyInfo for the specified property.
GetStylusPointProperties()	Gets all the properties of the StylusPointDescription.
GetType()	Gets the Type of the current instance. (Inherited from Object)
HasProperty(StylusPointProperty)	Returns a value that indicates whether the current StylusPointDescription has the specified property.
IsSubsetOf(StylusPointDescription)	Returns a value that indicates whether the current StylusPointDescription is a subset of the specified StylusPointDescription.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via