InkToolbarToggle Enum

Reference

Definition

Namespace:: Windows.UI.Xaml.Controls

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Defines constants that specify the button types exposed in the toggle button group of an InkToolbar.

public enum class InkToolbarToggle

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
enum class InkToolbarToggle

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
public enum InkToolbarToggle

Public Enum InkToolbarToggle

Inheritance: Enum
InkToolbarToggle

Attributes: ContractVersionAttribute

Windows requirements

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

Fields

Custom	1	A toggle button for a custom tool.
Ruler	0	A toggle button for a stencil tool.

Remarks

The InkToolbar consists of two distinct groups of button types:

A RadioButton group containing the built-in drawing (InkToolbarBallpointPenButton, InkToolbarPencilButton), erasing (InkToolbarEraserButton), and highlighting (InkToolbarHighlighterButton) buttons. This group is where InkToolbarCustomPenButton and InkToolbarCustomToolButton objects are added.

Feature selection is mutually exclusive.
A second group of "toggle" buttons containing the built-in stencil (InkToolbarStencilButton) button (or the InkToolbarRulerButton button). Custom toggles (InkToolbarCustomToggleButton) are added here.

Features are not mutually exclusive and can be used concurrently with other active tools.

Applies to