InkToolbarEraserButton InkToolbarEraserButton InkToolbarEraserButton InkToolbarEraserButton Class

Definition

Represents an InkToolbar button that activates the built-in eraser tool.

public : class InkToolbarEraserButton : InkToolbarToolButton, IInkToolbarEraserButton, IInkToolbarEraserButton2public class InkToolbarEraserButton : InkToolbarToolButton, IInkToolbarEraserButton, IInkToolbarEraserButton2Public Class InkToolbarEraserButton Inherits InkToolbarToolButton Implements IInkToolbarEraserButton, IInkToolbarEraserButton2// This API is not available in Javascript.
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Inherited Members

Inherited properties

Inherited events

Inherited methods

Remarks

The InkToolbar consists of two distinct groups of button types:

The eraser stroke has a default size of 2x2 pixels.

An ink stroke touched by the eraser stroke is deleted in its entirety, not just the portion under the erase stroke.

Custom drying and the InkToolbar

By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the InkCanvas layer (above the application content and replacing the wet ink). The ink platform enables you to override this behavior and completely customize the inking experience by custom drying the ink input.

If your app overrides the default ink rendering behavior of the InkPresenter with a custom drying implementation, the rendered ink strokes are no longer available to the InkToolbar and the built-in erase commands of the InkToolbar do not work as expected. To provide erase functionality, you must handle all pointer events, perform hit-testing on each stroke, and override the built-in "Erase all ink" command.

For more info on custom drying, see Pen interactions and Windows Ink in UWP apps.

Constructors

InkToolbarEraserButton() InkToolbarEraserButton() InkToolbarEraserButton() InkToolbarEraserButton()

Properties

IsClearAllVisible IsClearAllVisible IsClearAllVisible IsClearAllVisible

Gets or sets whether the "Erase all ink" button is visible.

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

true if visible. Otherwise, false.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)
See Also

IsClearAllVisibleProperty IsClearAllVisibleProperty IsClearAllVisibleProperty IsClearAllVisibleProperty

Identifies the IsClearAllVisible dependency property.

public : static DependencyProperty IsClearAllVisibleProperty { get; }public static DependencyProperty IsClearAllVisibleProperty { get; }Public Static ReadOnly Property IsClearAllVisibleProperty As DependencyProperty// This API is not available in Javascript.
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)
See Also

See Also