InkToolbarPenButton InkToolbarPenButton InkToolbarPenButton InkToolbarPenButton Class

Definition

Provides a base class for all built-in and custom pen buttons on an InkToolbar.

public : class InkToolbarPenButton : InkToolbarToolButton, IInkToolbarPenButtonpublic class InkToolbarPenButton : InkToolbarToolButton, IInkToolbarPenButtonPublic Class InkToolbarPenButton Inherits InkToolbarToolButton Implements IInkToolbarPenButton// 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 InkToolbarPenButton class cannot be instantiated directly. Use the various built-in and custom InkToolbar pen buttons instead.

You must create an InkDrawingAttributes object based on the current stroke Size and Brush.

The size of the pen stroke is obtained from the InkDrawingAttributes setting for Size. By default, the stroke height and width are set to Width.

By default, the InkToolbar contains the following built-in pen buttons:

Radio group toggle buttons

InkToolbarPenButton derived classes

InkToolbarPenButton is the base class for:

Pen buttons

Custom pen buttons

Radio group toggle buttons (built-in)

Properties

MaxStrokeWidth MaxStrokeWidth MaxStrokeWidth MaxStrokeWidth

Gets or sets the maximum possible Size of an ink stroke.

For ballpoint pen and pencil strokes, MaxStrokeWidth specifies both the maximum Height and Width of a Rectangle pen tip.

For highlighter strokes, MaxStrokeWidth specifies the maximum height of a Rectangle pen tip, while MaxStrokeWidth /3 specifies the maximum width.

Custom pen stroke dimensions can be set as required.

public : double MaxStrokeWidth { get; set; }public double MaxStrokeWidth { get; set; }Public ReadWrite Property MaxStrokeWidth As double// This API is not available in Javascript.
Value
double double double double

The maximum possible width of the ink stroke. The default is 0.

See Also

MaxStrokeWidthProperty MaxStrokeWidthProperty MaxStrokeWidthProperty MaxStrokeWidthProperty

Identifies the MaxStrokeWidth dependency property.

public : static DependencyProperty MaxStrokeWidthProperty { get; }public static DependencyProperty MaxStrokeWidthProperty { get; }Public Static ReadOnly Property MaxStrokeWidthProperty As DependencyProperty// This API is not available in Javascript.
See Also

MinStrokeWidth MinStrokeWidth MinStrokeWidth MinStrokeWidth

Gets or sets the minimum possible Size of an ink stroke.

For ballpoint pen and pencil strokes, MinStrokeWidth specifies both the minimum Height and Width of a Rectangle pen tip.

For highlighter strokes, MinStrokeWidth specifies the minimum height of a Rectangle pen tip, while MinStrokeWidth /3 specifies the minimum width.

Custom pen stroke dimensions can be set as required.

public : double MinStrokeWidth { get; set; }public double MinStrokeWidth { get; set; }Public ReadWrite Property MinStrokeWidth As double// This API is not available in Javascript.
Value
double double double double

The maximum possible width of the ink stroke. The default is 0.

See Also

MinStrokeWidthProperty MinStrokeWidthProperty MinStrokeWidthProperty MinStrokeWidthProperty

Identifies the MinStrokeWidth dependency property.

public : static DependencyProperty MinStrokeWidthProperty { get; }public static DependencyProperty MinStrokeWidthProperty { get; }Public Static ReadOnly Property MinStrokeWidthProperty As DependencyProperty// This API is not available in Javascript.
See Also

Palette Palette Palette Palette

Gets or sets the collection of brushes available on the ink stroke configuration flyout associated with the InkToolbarPenButton. An "extension glyph" is displayed on the button to indicate the existence of the flyout.

public : IVector<Brush> Palette { get; set; }public IList<Brush> Palette { get; set; }Public ReadWrite Property Palette As IList<Brush>// This API is not available in Javascript.
Value
IVector<Brush> IList<Brush> IList<Brush> IList<Brush>

A collection of Brush objects that describe various properties of the ink stroke. The default is 0 (empty).

See Also

PaletteProperty PaletteProperty PaletteProperty PaletteProperty

Identifies the Palette dependency property.

public : static DependencyProperty PaletteProperty { get; }public static DependencyProperty PaletteProperty { get; }Public Static ReadOnly Property PaletteProperty As DependencyProperty// This API is not available in Javascript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Palette dependency property.

See Also

SelectedBrush SelectedBrush SelectedBrush SelectedBrush

Gets the brush used to draw the ink stroke.

public : Brush SelectedBrush { get; }public Brush SelectedBrush { get; }Public ReadOnly Property SelectedBrush As Brush// This API is not available in Javascript.
Value
Brush Brush Brush Brush

The brush used to draw the ink stroke. The default value is 0 (Black ).

See Also

SelectedBrushIndex SelectedBrushIndex SelectedBrushIndex SelectedBrushIndex

Gets or sets the selected brush in the Palette.

public : int SelectedBrushIndex { get; set; }public int SelectedBrushIndex { get; set; }Public ReadWrite Property SelectedBrushIndex As int// This API is not available in Javascript.
Value
int int int int

The index of the brush in the Palette. The default is 0.

See Also

SelectedBrushIndexProperty SelectedBrushIndexProperty SelectedBrushIndexProperty SelectedBrushIndexProperty

Identifies the SelectedBrushIndex dependency property.

public : static DependencyProperty SelectedBrushIndexProperty { get; }public static DependencyProperty SelectedBrushIndexProperty { get; }Public Static ReadOnly Property SelectedBrushIndexProperty As DependencyProperty// This API is not available in Javascript.
See Also

SelectedBrushProperty SelectedBrushProperty SelectedBrushProperty SelectedBrushProperty

Identifies the SelectedBrush dependency property.

public : static DependencyProperty SelectedBrushProperty { get; }public static DependencyProperty SelectedBrushProperty { get; }Public Static ReadOnly Property SelectedBrushProperty As DependencyProperty// This API is not available in Javascript.
See Also

SelectedStrokeWidth SelectedStrokeWidth SelectedStrokeWidth SelectedStrokeWidth

Gets or sets the value that specifies the Size of the pen tip used to draw the ink stroke.

For ballpoint pen and pencil strokes, the stroke width specifies both the Height and Width of a Rectangle pen tip.

For highlighter strokes, stroke width specifies the height of a Rectangle pen tip, while width/3 specifies the width.

Custom pen stroke dimensions can be set as required.

public : double SelectedStrokeWidth { get; set; }public double SelectedStrokeWidth { get; set; }Public ReadWrite Property SelectedStrokeWidth As double// This API is not available in Javascript.
Value
double double double double

The width used to specify the Size of the pen tip. The default is 0.

See Also

SelectedStrokeWidthProperty SelectedStrokeWidthProperty SelectedStrokeWidthProperty SelectedStrokeWidthProperty

Identifies the SelectedStrokeWidth dependency property.

public : static DependencyProperty SelectedStrokeWidthProperty { get; }public static DependencyProperty SelectedStrokeWidthProperty { get; }Public Static ReadOnly Property SelectedStrokeWidthProperty As DependencyProperty// This API is not available in Javascript.
See Also

See Also