File Content Extraction 25.3
Viewing SDK Programming Guide

# Annotate

Adds and deletes annotations, and determines whether annotations exist. Use this method with the OPENMode property set to `5` (indexing enabled).

## Syntax

    bRet = KeyView.Annotate(action, position, type, bitmapFile, cbText, colorref, cursorFile)

## Parameters

Parameter | Type | Description
--- | --- | ---
`action` | Integer | `0` – delete annotation. `1` – add annotation. `2` – query annotation.
`position` | Long | Logical address to apply the annotation.
`type` | Integer | `0` – use a bitmap for the annotation. `1` – use an underline as the annotation. `2` – use a dotted underline as the annotation. Currently not implemented. `3` – use a strikethrough as the annotation. Currently not implemented.
`bitmapFile` | String | If the annotation type is bitmap, this is the bitmap file name (`*.bmp`).
`cbText` | Integer | If the annotation type is underline, this is the length of the underlined text.
`colorref` | Long | If the annotation type is underline, this is the color of the underlined text.
`cursorFile` | String | The cursor file (`*.cur`) to use when mouse hovers over the annotation.

## Returns

Type | Description
--- | ---
Boolean | `TRUE` if the method succeeds. `FALSE` if the method fails.

Copyright 2016-2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: File Content Extraction 25.3

Topic Title: Annotate