IInkPresenterStencil IInkPresenterStencil IInkPresenterStencil IInkPresenterStencil Interface

Definition

Represents a visual stencil, displayed as an 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 stencil can be manipulated both programmatically and by the user. It also scales and translates with the InkCanvas.

public : interface IInkPresenterStencilpublic interface IInkPresenterStencilPublic Interface IInkPresenterStencil// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Properties

BackgroundColor BackgroundColor BackgroundColor BackgroundColor

Gets or sets the background color of the IInkPresenterStencil object.

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 stencil as an ARGB value. The default is (255, 230, 230, 230).

See Also

ForegroundColor ForegroundColor ForegroundColor ForegroundColor

Gets or sets the color of the foreground elements on an IInkPresenterStencil object.

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 stencil as an ARGB value. The default is (255, 0, 0, 0).

See Also

IsVisible IsVisible IsVisible IsVisible

Gets or sets whether the IInkPresenterStencil object 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 stencil is visible. Otherwise, false.

Kind Kind Kind Kind

Gets the type of IInkPresenterStencil object 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.

Transform Transform Transform Transform

Gets or sets the position and rotation angle of the IInkPresenterStencil object 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 45 degrees.