Class
Annotator

Provides annotation support for a browser.

Definition

Namespace:ArtOfTest.WebAii.Win32

Assembly:ArtOfTest.WebAii.dll

Syntax:

cs-api-definition
public class Annotator

Inheritance: objectAnnotator

Constructors

Annotator(Desktop)

Create a new annotator with default settings.

Declaration

cs-api-definition
public Annotator(Desktop desktop)

Parameters

desktop

Desktop

The related desktop.

Annotator(IAnnotationHost)

Create a new annotator with default settings.

Declaration

cs-api-definition
public Annotator(IAnnotationHost host)

Parameters

host

IAnnotationHost

The target host to annotate.

Annotator(IAnnotationHost, AnnotatorSettings)

Create a new annotator object.

Declaration

cs-api-definition
public Annotator(IAnnotationHost host, AnnotatorSettings annotationSettings)

Parameters

host

IAnnotationHost

The target host to annotate.

annotationSettings

AnnotatorSettings

The annotation settings.

Properties

Settings

Gets/Sets the annotation settings to use. You can use these settings at any point in execution to change how annotation is done.

Declaration

cs-api-definition
public AnnotatorSettings Settings { get; set; }

Property Value

AnnotatorSettings

Methods

Annotate(Point, string)

Annotate a single point.

Declaration

cs-api-definition
public void Annotate(Point point, string message)

Parameters

point

Point

The point.

message

string

The message

Annotate(Rectangle, string)

Annotate and highlight a specific target rectangle on the browser surface with a message to display underneath.

Declaration

cs-api-definition
public void Annotate(Rectangle targetArea, string message)

Parameters

targetArea

Rectangle

The target area to highlight.

message

string

The message.

Annotate(string)

Annotate a message to the browser. Will use the AnnotateSettings.InfoMessageLocation to place this message on the browser surface.

Declaration

cs-api-definition
public void Annotate(string message)

Parameters

message

string

The message.

Annotate(string, int, OffsetReference)

Annotate a message to the browser

Declaration

cs-api-definition
public void Annotate(string message, int displayTime, OffsetReference location)

Parameters

message

string

The message.

displayTime

int

The display time (msec).

location

OffsetReference

The display location

Clear()

Clear all annotations

Declaration

cs-api-definition
public void Clear()

Close()

Close the annotator.

Declaration

cs-api-definition
public void Close()