LAnnAutomation::SetTool

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetTool(uTool=ANNTOOL_SELECT)

L_UINT uTool;

/* constant that specifies the selected tool */

Specifies the default tool, which is maintained by the Automation object.

Parameter

Description

uTool

The constant that specifies the selected tool. Possible values are:

 

Value

Meaning

 

ANNTOOL_SELECT

[0] Selection pointer

 

ANNTOOL_LINE

[1] Line

 

ANNTOOL_RECT

[2] Rectangle

 

ANNTOOL_ELLIPSE

[3] Ellipse

 

ANNTOOL_POLYLINE

[4] Polyline

 

ANNTOOL_POLYGON

[5] Polygon

 

ANNTOOL_POINTER

[6] Pointer

 

ANNTOOL_FREEHAND

[7] Freehand line

 

ANNTOOL_HILITE

[8] Highlight

 

ANNTOOL_REDACT

[9] Redaction

 

ANNTOOL_TEXT

[10] Text

 

ANNTOOL_NOTE

[11] Note

 

ANNTOOL_STAMP

[12] Stamp

 

ANNTOOL_BUTTON

[13] Button

 

ANNTOOL_HOTSPOT

[14] Hot spot

 

ANNTOOL_AUDIO

[15] Audio clip

 

ANNTOOL_RULER

[16] Ruler clip

 

ANNTOOL_CROSSPRODUCT

[17] Cross product

 

ANNTOOL_POINT

[18] Point

 

ANNTOOL_PROTRACTOR

[19] Protractor

 

ANNTOOL_VIDEO

[20] Video

 

ANNTOOL_PUSHPIN

[21] Pushpin

 

ANNTOOL_FREEHANDHOTSPOT

[22] Freehand Hot Spot

 

ANNTOOL_CURVE

[23] Curve Tool

 

ANNTOOL_CURVECLOSED

[24] Closed Curve Tool

 

ANNTOOL_ENCRYPT

[25] Encrypt Tool

 

ANNTOOL_TEXTPOINTER

[26] Text Pointer Tool

 

ANNTOOL_POLYRULER

[27] Polyruler Tool

 

ANNTOOL_RTF

[28] Rich Text Tool

 

ANNTOOL_STAMP_FIRST

[29] First Stamp /* define that marks the first rubber stamp */

 

ANNTOOL_STAMP_APPROVED

[29] Approved Stamp

 

ANNTOOL_STAMP_ASSIGNED

[30] Assigned Stamp

 

ANNTOOL_STAMP_CHECKED

[31] Checked Stamp

 

ANNTOOL_STAMP_CLATPRV

[32] Client Attorney Privilege

 

ANNTOOL_STAMP_COPY

[33] Copy Stamp

 

ANNTOOL_STAMP_DRAFT

[34] Draft Stamp

 

ANNTOOL_STAMP_EXTENDED

[35] Extended Stamp

 

ANNTOOL_STAMP_FAX

[36] Fax Stamp

 

ANNTOOL_STAMP_FAXED

[37] Faxed Stamp

 

ANNTOOL_STAMP_IMPORTANT

[38] Important Stamp

 

ANNTOOL_STAMP_INVOICE

[39] Invoice Stamp

 

ANNTOOL_STAMP_NOTICE

[40] Notice Stamp

 

ANNTOOL_STAMP_OFFICIAL

[41] Official Stamp

 

ANNTOOL_STAMP_ONFILE

[42] On File Stamp

 

ANNTOOL_STAMP_PAID

[43] Paid Stamp

 

ANNTOOL_STAMP_PASSED

[44] Passed Stamp

 

ANNTOOL_STAMP_PENDING

[45] Pending Stamp

 

ANNTOOL_STAMP_PROCESSED

[46] Processed Stamp

 

ANNTOOL_STAMP_RECEIVED

[47] Received Stamp

 

ANNTOOL_STAMP_REJECTED

[48] Rejected Stamp

 

ANNTOOL_STAMP_RELEASE

[49] Release Stamp

 

ANNTOOL_STAMP_SENT

[50] Sent Stamp

 

ANNTOOL_STAMP_SHIPPED

[51] Shipped Stamp

 

ANNTOOL_STAMP_TOPSECRET

[52] Top Secret Stamp

 

ANNTOOL_STAMP_URGENT

[53] Urgent Stamp

 

ANNTOOL_STAMP_VOID

[54] Void Stamp

 

ANNTOOL_STAMP_LAST

[55] /* define that marks the last rubber stamp */

 

ANNTOOL_LAST

[56]

 

ANNTOOL_USER

[0x0100] First user defined tool // first user defined tool

 

ANNTOOL_USERLAST

[0x0200] Last allowed user defined tools// last allowed user tools

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LAnnAutomation::GetAutoContainer, LAnnAutomation::GetTool, LAnnotation::GetUserMode, Class Members

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Key Annotation Features

 

Calibrating Annotation Ruler Objects

Example

For an example, refer to LAnnAutomation::SetAutoContainer.