Share via

IInkPresenterStencil Interface

  • Reference

Definition

Namespace:
Windows.UI.Input.Inking
Edit

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 class IInkPresenterStencil
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.Guid(819015021, 15878, 19714, 177, 22, 39, 127, 181, 216, 173, 220)]
struct IInkPresenterStencil
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.Guid(819015021, 15878, 19714, 177, 22, 39, 127, 181, 216, 173, 220)]
public interface IInkPresenterStencil
Public Interface IInkPresenterStencil
Derived
Attributes
ContractVersionAttribute GuidAttribute

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Properties

BackgroundColor

Gets or sets the background color of the IInkPresenterStencil object.
ForegroundColor

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

Gets or sets whether the IInkPresenterStencil object is visible.
Kind

Gets the type of IInkPresenterStencil object to display on the InkCanvas.
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.

Applies to

See also