InkToolbar.ActiveTool Property
Definition
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.
Gets or sets the currently selected feature in the "tools" group of the InkToolbar (see remarks). This property provides access to the following objects:
- InkToolbarBallpointPenButton
- InkToolbarPencilButton
- InkToolbarEraserButton
- InkToolbarHighlighterButton
- InkToolbarCustomPenButton
- InkToolbarCustomToolButton
Features in this group are mutually exclusive: selecting a feature deselects the currently active feature.
Note
InkToolbarRulerButton and InkToolbarCustomToggleButton objects work in conjunction with the active feature and are not exposed to the ActiveTool property.
public:
property InkToolbarToolButton ^ ActiveTool { InkToolbarToolButton ^ get(); void set(InkToolbarToolButton ^ value); };
InkToolbarToolButton ActiveTool();
void ActiveTool(InkToolbarToolButton value);
public InkToolbarToolButton ActiveTool { get; set; }
var inkToolbarToolButton = inkToolbar.activeTool;
inkToolbar.activeTool = inkToolbarToolButton;
Public Property ActiveTool As InkToolbarToolButton
Property Value
The currently selected feature. By default, this is the first button on the InkToolbar.
Remarks
The InkToolbar consists of two distinct groups of button types:
- One group of "tool" buttons containing the built-in drawing (InkToolbarBallpointPenButton, InkToolbarPencilButton), erasing (InkToolbarEraserButton), and highlighting (InkToolbarHighlighterButton) buttons. Custom tools (InkToolbarCustomPenButton and InkToolbarCustomToolButton) are added here.
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.