Edit

StylusDevice.GetStylusPoints Method

  • Reference

Definition

Namespace:
System.Windows.Input
Assembly:
PresentationCore.dll

Returns a StylusPointCollection that contains StylusPoint objects collected from the stylus.

Overloads

GetStylusPoints(IInputElement)

Returns a StylusPointCollection that contains StylusPoint objects collected from the stylus.
GetStylusPoints(IInputElement, StylusPointDescription)

Returns a StylusPointCollection that contains StylusPoint objects collected from the stylus. Uses the specified StylusPointDescription.

GetStylusPoints(IInputElement)

Returns a StylusPointCollection that contains StylusPoint objects collected from the stylus.

public:
 System::Windows::Input::StylusPointCollection ^ GetStylusPoints(System::Windows::IInputElement ^ relativeTo);
public System.Windows.Input.StylusPointCollection GetStylusPoints (System.Windows.IInputElement relativeTo);
member this.GetStylusPoints : System.Windows.IInputElement -> System.Windows.Input.StylusPointCollection
Public Function GetStylusPoints (relativeTo As IInputElement) As StylusPointCollection

Parameters

relativeTo
IInputElement

The IInputElement to which the (x,y) coordinates in the StylusPointCollection are mapped.

Returns

StylusPointCollection

A StylusPointCollection that contains StylusPoint objects that the stylus collected.

Exceptions

InvalidOperationException

relativeTo is neither UIElement or FrameworkContentElement.

Examples

The following example demonstrates how to get the StylusPointCollection from the StylusDevice.

StylusPointCollection myStylusPoints =
            myStylusDevice.GetStylusPoints(myStylusDevice.Target);
textbox1.AppendText("Got " + myStylusPoints.Count.ToString() + " packets\n");

Dim myStylusPoints As StylusPointCollection = _
    myStylusDevice.GetStylusPoints(myStylusDevice.Target)
textbox1.AppendText("Got " + myStylusPoints.Count.ToString() + " packets" + vbCrLf)

Applies to

GetStylusPoints(IInputElement, StylusPointDescription)

Returns a StylusPointCollection that contains StylusPoint objects collected from the stylus. Uses the specified StylusPointDescription.

public:
 System::Windows::Input::StylusPointCollection ^ GetStylusPoints(System::Windows::IInputElement ^ relativeTo, System::Windows::Input::StylusPointDescription ^ subsetToReformatTo);
public System.Windows.Input.StylusPointCollection GetStylusPoints (System.Windows.IInputElement relativeTo, System.Windows.Input.StylusPointDescription subsetToReformatTo);
member this.GetStylusPoints : System.Windows.IInputElement * System.Windows.Input.StylusPointDescription -> System.Windows.Input.StylusPointCollection
Public Function GetStylusPoints (relativeTo As IInputElement, subsetToReformatTo As StylusPointDescription) As StylusPointCollection

Parameters

relativeTo
IInputElement

The IInputElement to which the (x y) coordinates in the StylusPointCollection are mapped.

subsetToReformatTo
StylusPointDescription

The StylusPointDescription to be used by the StylusPointCollection.

Returns

StylusPointCollection

A StylusPointCollection that contains StylusPoint objects collected from the stylus.

Exceptions

InvalidOperationException

relativeTo is neither UIElement or FrameworkContentElement.

Examples

The following example demonstrates how to get StylusPoint objects from the current StylusDevice.

StylusDevice currentStylus = Stylus.CurrentStylusDevice;
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)
                    });

StylusPointDescription description2 = currentStylus.GetStylusPoints(inkCanvas1).Description;

StylusPointDescription description3 = 
    StylusPointDescription.GetCommonDescription(description1, description2);

StylusPointCollection points = currentStylus.GetStylusPoints(inkCanvas1, description3);

Dim currentStylus As StylusDevice = Stylus.CurrentStylusDevice

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

Dim description2 As StylusPointDescription = currentStylus.GetStylusPoints(inkCanvas1).Description

Dim description3 As StylusPointDescription = _
                        StylusPointDescription.GetCommonDescription(description1, description2)

Dim points As StylusPointCollection = currentStylus.GetStylusPoints(inkCanvas1, description3)

Remarks

subsetToReformatTo must be compatible with the Description property of the StylusPointCollection used by the GetStylusPoints(IInputElement) method. Use the GetCommonDescription method to get a StylusPointDescription before calling the GetStylusPoints(IInputElement, StylusPointDescription) method.

Applies to