StylusPointDescription Class

Definition

Namespace:

System.Windows.Input

Assembly:

PresentationCore.dll

Specifies the properties that are in a StylusPoint.

C#

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.

C#

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();
}

C#

// 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";
}

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.
GetCommonDescription(StylusPointDescription, StylusPointDescription)	Returns the intersection of the specified StylusPointDescription objects.
GetPropertyInfo(StylusPointProperty)	Gets the StylusPointPropertyInfo for the specified property.
GetStylusPointProperties()	Gets all the properties of the StylusPointDescription.
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.

Applies to