InkPresenterProtractor InkPresenterProtractor InkPresenterProtractor InkPresenterProtractor Class

Definition

Represents a visual stencil, in the form of a protractor for drawing arcs and curves, displayed as a semi-transparent overlay on an InkCanvas.

The stencil transforms how an ink stroke is rendered:

  • It snaps the ink stroke to the stencil edge if the pen tip is within a distance threshold (gutter).
  • It acts as a mask and prevents the drawing of an ink stroke within the area obscured by the stencil.

The InkPresenterRuler can be manipulated both programmatically and by the user. It also scales and translates with the InkCanvas.

public : sealed class InkPresenterProtractor : IInkPresenterProtractor, IInkPresenterStencilpublic sealed class InkPresenterProtractor : IInkPresenterProtractor, IInkPresenterStencilPublic NotInheritable Class InkPresenterProtractor Implements IInkPresenterProtractor, IInkPresenterStencil// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

The opacity of the stencil is set at 75% when static, and 50% during manipulation.

Constructors

InkPresenterProtractor(InkPresenter) InkPresenterProtractor(InkPresenter) InkPresenterProtractor(InkPresenter) InkPresenterProtractor(InkPresenter)

Initializes a new instance of the InkPresenterProtractor class.

public : InkPresenterProtractor(InkPresenter inkPresenter)public InkPresenterProtractor(InkPresenter inkPresenter)Public Sub New(inkPresenter As InkPresenter)// This API is not available in Javascript.
Parameters
inkPresenter
InkPresenter InkPresenter InkPresenter InkPresenter

The ink presenter associated with the pen input.

Properties

AccentColor AccentColor AccentColor AccentColor

Gets or sets the color of the rays and horizontal marks for the protractor stencil.

Protractor stencil

Rays represent the angle of the drawn arc. They are visible only when ink is snapped to the protractor and the protractor has not been moved.

Horizontal marks represent a horizontal line bisecting the protractor. The default positions are 3 and 9 o’clock, but a rotation transform can be applied to the protractor, which also rotates the marks.

public : Color AccentColor { get; set; }public Color AccentColor { get; set; }Public ReadWrite Property AccentColor As Color// This API is not available in Javascript.
Value
Color Color Color Color

The specified color.

The default is system-defined.

AreRaysVisible AreRaysVisible AreRaysVisible AreRaysVisible

Gets or sets whether the rays are displayed on the protractor stencil.

Protractor stencil

Rays represent the angle of the drawn arc. They are visible only when ink is snapped to the protractor and the protractor has not been moved.

public : PlatForm::Boolean AreRaysVisible { get; set; }public bool AreRaysVisible { get; set; }Public ReadWrite Property AreRaysVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true, if the rays are visible. Otherwise, false.

The default is true.

AreTickMarksVisible AreTickMarksVisible AreTickMarksVisible AreTickMarksVisible

Gets or sets whether the tick marks are displayed on the protractor stencil.

Protractor stencil

Tick marks represent the degree marks on the protractor.

public : PlatForm::Boolean AreTickMarksVisible { get; set; }public bool AreTickMarksVisible { get; set; }Public ReadWrite Property AreTickMarksVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true, if the tick marks are visible. Otherwise, false.

The default is true.

BackgroundColor BackgroundColor BackgroundColor BackgroundColor

Gets or sets the background color of the InkPresenterProtractor.

public : Color BackgroundColor { get; set; }public Color BackgroundColor { get; set; }Public ReadWrite Property BackgroundColor As Color// This API is not available in Javascript.
Value
Color Color Color Color

The background color of the protractor as an ARGB value. The default is (255, 230, 230, 230).

ForegroundColor ForegroundColor ForegroundColor ForegroundColor

Gets or sets the color of the foreground elements on an InkPresenterProtractor.

public : Color ForegroundColor { get; set; }public Color ForegroundColor { get; set; }Public ReadWrite Property ForegroundColor As Color// This API is not available in Javascript.
Value
Color Color Color Color

The foreground color of the protractor as an ARGB value. The default is (255, 0, 0, 0).

IsAngleReadoutVisible IsAngleReadoutVisible IsAngleReadoutVisible IsAngleReadoutVisible

Gets or sets whether the numerical angle is displayed on the protractor stencil.

Protractor stencil

The angle readout represents the numeric value for the angle of the drawn arc.

public : PlatForm::Boolean IsAngleReadoutVisible { get; set; }public bool IsAngleReadoutVisible { get; set; }Public ReadWrite Property IsAngleReadoutVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true, if the angle readout is visible. Otherwise, false.

The default is true.

IsCenterMarkerVisible IsCenterMarkerVisible IsCenterMarkerVisible IsCenterMarkerVisible

Gets or sets whether the center mark is displayed on the protractor stencil.

Protractor stencil

The center mark represents the visual in the center of the protractor.

public : PlatForm::Boolean IsCenterMarkerVisible { get; set; }public bool IsCenterMarkerVisible { get; set; }Public ReadWrite Property IsCenterMarkerVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true, if the center mark is visible. Otherwise, false.

The default is true.

IsResizable IsResizable IsResizable IsResizable

Gets or sets whether the protractor stencil can be resized.

public : PlatForm::Boolean IsResizable { get; set; }public bool IsResizable { get; set; }Public ReadWrite Property IsResizable As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true, if the stencil can be resized. Otherwise, false.

The default is true.

IsVisible IsVisible IsVisible IsVisible

Gets or sets whether the protractor stencil is visible.

public : PlatForm::Boolean IsVisible { get; set; }public bool IsVisible { get; set; }Public ReadWrite Property IsVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true if the ruler is visible. Otherwise, false.

Kind Kind Kind Kind

Gets the type of stencil to display on the InkCanvas.

public : InkPresenterStencilKind Kind { get; }public InkPresenterStencilKind Kind { get; }Public ReadOnly Property Kind As InkPresenterStencilKind// This API is not available in Javascript.

Radius Radius Radius Radius

Gets or sets the radial size of the protractor.

public : double Radius { get; set; }public double Radius { get; set; }Public ReadWrite Property Radius As double// This API is not available in Javascript.
Value
double double double double

The radial size, in Device Independent Pixels (DIPs).

The default is 280 DIPs.

Transform Transform Transform Transform

Gets or sets the position and rotation angle of the protractor stencil within the 2-D coordinate space of the InkCanvas.

Both position and rotation are based on the top left corner of the stencil relative to the origin of the InkCanvas.

public : Matrix3x2 Transform { get; set; }public Matrix3x2 Transform { get; set; }Public ReadWrite Property Transform As Matrix3x2// This API is not available in Javascript.
Value
Matrix3x2 Matrix3x2 Matrix3x2 Matrix3x2

The position and angle of the stencil as a 3*2 floating point matrix.The default position is the origin of the InkCanvas. The default rotation angle is 0 degrees.