ShowAnnotationToolPalette Method

Shows the Annotation Tool Palette, which enables end users to add and edit annotations on the displayed image.

Available With

Ö	Imaging for Windows Professional Edition V1.0, V1.1, and V2.0
Ö	Imaging for Windows 95 and 98
Ö	Imaging for Windows NT 4.0

Applies To

Image Edit control

Syntax

object.ShowAnnotationToolPalette [ShowAttributesDialog,Left,Top,ToolTipText]

Arguments

Parameter

Data Type

Setting

ShowAttributesDialog	Boolean	Whether the Annotation Attributes dialog box is invoked: True (default) When the end user clicks on a tool palette button using the right mouse button and selects properties from a pop-up menu, the Annotation Attributes dialog box appears (sample). When the end user clicks on the Rubber Stamp tool button, a pop-up menu appears that contains a list of previously defined stamps. False The Annotation Attributes dialog box cannot be invoked.
Left	Long	The horizontal position of the Annotation Tool Palette in pixels, relative to the upper-left corner of the screen.
Top	Long	The vertical position of the Annotation Tool Palette in pixels, relative to the upper-left corner of the screen.
ToolTipText	String	Contains the tool tip text used for each Annotation Tool Palette button. Any number of strings may be entered; use the vertical bar (\|) character to separate each string. If not specified, default strings are provided.

Return Value

None

Remarks

The ShowAnnotationToolPalette method can be invoked only once per control.

If the ShowAttributesDialog parameter is not entered, it is set to True by default.

If the Left and Top parameters are not entered, the Annotation Tool Palette is displayed at Position 10,10 relative to the Image Edit control.

ToolTip strings are displayed by default only as long as the tool palette control has focus. It is the responsibility of the calling application to insure that the control gets focus in the appropriate situations, either through explicit or implicit means.

To draw annotations using the Annotation Tool Palette, an annotation tool must be selected. This can be accomplished by the end user clicking on a button on the tool palette, or by invoking the SelectTool method. The annotation mark can then be drawn manually by the end user, or programatically by calling the Draw method. Changing the AnnotationType property with the Annotation Tool Palette displayed will not achieve the desired results.

Invoking the ShowAnnotationToolPalette method sets the ImageModified property to True.

Tab Characters

The Image Edit control does not support the use of Tab characters in any of the text-related annotation tools.