StylusPointCollection.Reformat(StylusPointDescription) Method

Definition

Namespace:

System.Windows.Input

Assembly:

PresentationCore.dll

Finds the intersection of the specified StylusPointDescription and the Description property.

public:
 System::Windows::Input::StylusPointCollection ^ Reformat(System::Windows::Input::StylusPointDescription ^ subsetToReformatTo);

public System.Windows.Input.StylusPointCollection Reformat (System.Windows.Input.StylusPointDescription subsetToReformatTo);

member this.Reformat : System.Windows.Input.StylusPointDescription -> System.Windows.Input.StylusPointCollection

Public Function Reformat (subsetToReformatTo As StylusPointDescription) As StylusPointCollection

Parameters

subsetToReformatTo

StylusPointDescription

A StylusPointDescription to intersect with the StylusPointDescription of the current StylusPointCollection.

Returns

StylusPointCollection

A StylusPointCollection that has a StylusPointDescription that is a subset of the specified StylusPointDescription and the StylusPointDescription that the current StylusPointCollection uses.

Exceptions

ArgumentException

subsetToReformatTo is not a subset of the Description property.

Examples

The following example demonstrates how to create a new StylusPointCollection that uses a different StylusPointDescription.

StylusPointDescription description1 =
      new StylusPointDescription(new StylusPointPropertyInfo[]
                    {
                        new StylusPointPropertyInfo(StylusPointProperties.X),
                        new StylusPointPropertyInfo(StylusPointProperties.Y),
                        new StylusPointPropertyInfo(StylusPointProperties.NormalPressure),
                        new StylusPointPropertyInfo(StylusPointProperties.XTiltOrientation),
                        new StylusPointPropertyInfo(StylusPointProperties.YTiltOrientation),
                        new StylusPointPropertyInfo(StylusPointProperties.BarrelButton)
                    });

// Create a StylusPointCollection that uses description1 as its
// StylusPointDescription.
StylusPointCollection points = new StylusPointCollection(description1);

StylusPointDescription description2 =   
      new StylusPointDescription(new StylusPointPropertyInfo[]
                    {
                        new StylusPointPropertyInfo(StylusPointProperties.X),
                        new StylusPointPropertyInfo(StylusPointProperties.Y),
                        new StylusPointPropertyInfo(StylusPointProperties.NormalPressure),
                        new StylusPointPropertyInfo(StylusPointProperties.ButtonPressure),
                        new StylusPointPropertyInfo(StylusPointProperties.BarrelButton)
                    });

// Find the common StylusPointDescription between description1
// and description2.  Get a StylusPointCollection that uses the
// common StylusPointDescription.
StylusPointDescription common =
    StylusPointDescription.GetCommonDescription(description1, description2);

StylusPointCollection points2 = points.Reformat(common);

Dim description1 As New StylusPointDescription( _
    New StylusPointPropertyInfo() {New StylusPointPropertyInfo(StylusPointProperties.X), _
                                   New StylusPointPropertyInfo(StylusPointProperties.Y), _
                                   New StylusPointPropertyInfo(StylusPointProperties.NormalPressure), _
                                   New StylusPointPropertyInfo(StylusPointProperties.XTiltOrientation), _
                                   New StylusPointPropertyInfo(StylusPointProperties.YTiltOrientation), _
                                   New StylusPointPropertyInfo(StylusPointProperties.BarrelButton)})

' Create a StylusPointCollection that uses description1 as its
' StylusPointDescription.
Dim points As New StylusPointCollection(description1)

Dim description2 As New StylusPointDescription( _
    New StylusPointPropertyInfo() {New StylusPointPropertyInfo(StylusPointProperties.X), _
                                   New StylusPointPropertyInfo(StylusPointProperties.Y), _
                                   New StylusPointPropertyInfo(StylusPointProperties.NormalPressure), _
                                   New StylusPointPropertyInfo(StylusPointProperties.ButtonPressure), _
                                   New StylusPointPropertyInfo(StylusPointProperties.BarrelButton)})

' Find the common StylusPointDescription between description1
' and description2.  Get a StylusPointCollection that uses the
' common StylusPointDescription.
Dim common As StylusPointDescription = _
        StylusPointDescription.GetCommonDescription(description1, description2)

Dim points2 As StylusPointCollection = points.Reformat(common)

Remarks

subsetToReformatTo is a StylusPointDescription which describes a subset of values belonging to the Description property. Use the GetCommonDescription method to get a StylusPointDescription that intersects the Description of the current StylusPointCollection.

The Reformat method returns a StylusPointCollection that contains the same StylusPoint objects as those belonging to the current StylusPointCollection. The StylusPoint objects in the new StylusPointCollection uses subsetToReformatTo as the StylusPointDescription.

Note

Reformat uses the constraints from the StylusPointPropertyInfo of the Description property, even if the constraints in subsetToReformatTo are different. For example, if subsetToReformatTo uses the values 0 and 1023 for NormalPressure whereas Description uses the values 0 and 255. Reformat returns a StylusPointDescription using the values, 0 and 255.