Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

StylusPointDescription Class

Specifies the properties that are in a StylusPoint.

System.Object
  System.Windows.Input.StylusPointDescription

Namespace:  System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
public class StylusPointDescription
<StylusPointDescription .../>

The StylusPointDescription type exposes the following members.

  NameDescription
Public methodStylusPointDescription()Initializes a new instance of the StylusPointDescription class.
Public methodStylusPointDescription(IEnumerable<StylusPointPropertyInfo>)Initializes a new instance of the StylusPointDescription class with the specified StylusPointPropertyInfo objects.
Top
  NameDescription
Public propertyPropertyCountGets the number of properties in the StylusPointDescription.
Top
  NameDescription
Public methodStatic memberAreCompatibleReturns a value that indicates whether the specified StylusPointDescription objects are identical.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodStatic memberGetCommonDescriptionReturns the intersection of the specified StylusPointDescription objects.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetPropertyInfoGets the StylusPointPropertyInfo for the specified property.
Public methodGetStylusPointPropertiesGets all the properties of the StylusPointDescription.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHasPropertyReturns a value that indicates whether the current StylusPointDescription has the specified property.
Public methodIsSubsetOfReturns a value that indicates whether the current StylusPointDescription is a subset of the specified StylusPointDescription.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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


...


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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft. All rights reserved.