Class InkBrush

Represents the brush settings for an ink annotation. Maps to InkML <brushProperty> elements within an <ink> document.

Inheritance
object
InkBrush
Inherited Members
Namespace: DRIT.Presentation.Drawing
Assembly: DRIT.Presentation.dll
Syntax
public class InkBrush

Constructors

InkBrush()

Initializes a new brush with default values (black, 2.5pt).

Declaration
public InkBrush()

Properties

Color

Gets or sets the brush color. Maps to the InkML brushProperty with name="color".

Declaration
public DrawingColor Color { get; set; }
Property Value
Type Description
DrawingColor

EffectName

Gets or sets the ink effect name. Maps to the InkML brushProperty with name="inkEffects". When null, no effect is applied.

Declaration
public string EffectName { get; set; }
Property Value
Type Description
string

HighlightColor

Gets or sets the optional highlight color. Maps to the InkML brushProperty with name="highlightColor". When null, no highlight color is set.

Declaration
public DrawingColor HighlightColor { get; set; }
Property Value
Type Description
DrawingColor

Opacity

Gets or sets the optional opacity (0.0–1.0). Maps to the InkML brushProperty with name="opacity". When null, full opacity is assumed.

Declaration
public double? Opacity { get; set; }
Property Value
Type Description
double?

Size

Gets or sets the brush size in points. Maps to the InkML brushProperty with name="width".

Declaration
public double Size { get; set; }
Property Value
Type Description
double

Methods

ColorToHex()

Returns the color as a hex string suitable for InkML brushProperty value attributes.

Declaration
public string ColorToHex()
Returns
Type Description
string

HighlightColorToHex()

Returns the highlight color as a hex string, or null when no highlight color is set.

Declaration
public string HighlightColorToHex()
Returns
Type Description
string

OpacityToInkML()

Returns the opacity formatted for InkML, or null.

Declaration
public string OpacityToInkML()
Returns
Type Description
string

SizeToInkML()

Returns the size formatted for InkML.

Declaration
public string SizeToInkML()
Returns
Type Description
string