Class
AnnotatorSettings

Class representing all the annotator settings.

Definition

Namespace:ArtOfTest.WebAii.Win32

Assembly:ArtOfTest.WebAii.dll

Syntax:

cs-api-definition
public class AnnotatorSettings

Inheritance: objectAnnotatorSettings

Constructors

AnnotatorSettings()

Create a new Annotator settings object. Use default settings.

Declaration

cs-api-definition
public AnnotatorSettings()

AnnotatorSettings(Color, float)

Create a new Annotator settings object.

Declaration

cs-api-definition
public AnnotatorSettings(Color color, float borderWidth)

Parameters

color

Color

The color to use.

borderWidth

float

The border width to use.

AnnotatorSettings(Color, float, string, float, FontStyle, bool, Color, int, int, OffsetReference)

Create a new Annotator settings object.

Declaration

cs-api-definition
public AnnotatorSettings(Color color, float borderWidth, string fontFamilyName, float fontemSize, FontStyle fontStyle, bool ShowAnnotationMessage, Color backgroundColor, int backgroundAlpha, int borderPadding, OffsetReference infoLocation)

Parameters

color

Color

The color to use.

borderWidth

float

The border width to use.

fontFamilyName

string

The font to use to draw messages.

fontemSize

float

The font size to use.

fontStyle

FontStyle

The font style to use.

ShowAnnotationMessage

bool

Whether to show annotation messages or not.

backgroundColor

Color

The background color of text annotations.

backgroundAlpha

int

The background alpha blending 0-255.

borderPadding

int

The padding between the highlight border and the element.

infoLocation

OffsetReference

The location where to place text annotations.

Properties

BackColor

Gets/Sets the background color for message annotations. Default Yellow.

Declaration

cs-api-definition
public Color BackColor { get; set; }

Property Value

Color

BackColorAlpha

Gets/Sets the background color alpha blending. Default 240.

Declaration

cs-api-definition
public int BackColorAlpha { get; set; }

Property Value

int

BorderPadding

Gets/Sets the border padding between the border and highlighted element. Default 4.

Declaration

cs-api-definition
public int BorderPadding { get; set; }

Property Value

int

BorderWidth

Gets/Sets the border width that highlights the element. Default 2.

Declaration

cs-api-definition
public float BorderWidth { get; set; }

Property Value

float

Color

Gets/Sets the color to use to draw the annotations. Default Red.

Declaration

cs-api-definition
public Color Color { get; set; }

Property Value

Color

CustomDisplayTime

Gets or sets the hang time for custom annotations.

Declaration

cs-api-definition
public int CustomDisplayTime { get; set; }

Property Value

int

FontFamilyName

The font family name to use to draw the annotation messages. Default Tahoma.

Declaration

cs-api-definition
public string FontFamilyName { get; set; }

Property Value

string

FontStyle

Gets/Sets the font style to use to draw the messages. Default Bold.

Declaration

cs-api-definition
public FontStyle FontStyle { get; set; }

Property Value

FontStyle

FontemSize

Gets/Sets the font size to use to draw the messages. Default 10.

Declaration

cs-api-definition
public float FontemSize { get; set; }

Property Value

float

InfoMessageLocation

Gets/Sets the info message location in reference to the window. Default TopCenter.

Declaration

cs-api-definition
public OffsetReference InfoMessageLocation { get; set; }

Property Value

OffsetReference

ShowAnnotationMessage

Gets/Sets whether to show message annotation in addition to highlighting the target elements.

Declaration

cs-api-definition
public bool ShowAnnotationMessage { get; set; }

Property Value

bool