StylusEventArgs.GetStylusPoints Method

Definition

Returns a StylusPointCollection that contains StylusPoint objects collected in the event.

Overloads

GetStylusPoints(IInputElement)

Returns a StylusPointCollection that contains StylusPoint objects relative to the specified input element.

GetStylusPoints(IInputElement, StylusPointDescription)

Returns a StylusPointCollection that uses the specified StylusPointDescription and contains StylusPoint objects relating to the specified input element.

GetStylusPoints(IInputElement)

Returns a StylusPointCollection that contains StylusPoint objects relative to the specified input element.

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

A StylusPointCollection that contains StylusPoint objects collected in the event.

Exceptions

GetStylusPoints(IInputElement, StylusPointDescription)

Returns a StylusPointCollection that uses the specified StylusPointDescription and contains StylusPoint objects relating to the specified input element.

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

A StylusPointCollection that contains StylusPoint objects collected during an event.

Exceptions

Remarks

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

Note

GetStylusPoints uses constraints from the StylusPointCollection in StylusEventArgs, even if the constraints in subsetToReformatTo are different. For example, if subsetToReformatTo uses NormalPressure values of 0 and 1023 but StylusEventArgs uses values of 0 and 255, GetStylusPoints returns a StylusPointDescription containing the values 0 and 255.

Applies to