KeyView 24.1

# TPVAPIAnnotation

This structure defines the parameters used by the VAPIM_ANNOTATE message.

## Syntax

    #include <kvvapi.h>
    typedef struct tag_TPVAPIAnnotation
    {
        long                    position;
        ENVAPIAnnotationType    type;
        HBITMAP                 hBitmap;
        Int                     cbText;
        COLORREF                color;
        HCURSOR                 hCursor;
    }
    TPVAPIAnnotation;

## Members

Member | Description
--- | ---
`position` | A long integer. The position where the annotation applies. This is required.
`type` | The annotation type as defined in `ENVAPIAnnotationType` in `kvvapi.h`. This is required. The following options are available: `kvBitMap` – use a bitmap for the annotation. `kvUnderline` – use an underline for the annotation. `kvDottedUnderline` – use a dotted underline for the annotation. Currently not implemented. `kvStrikeout` – use strikethrough as the annotation. Currently not implemented.
`hBitmap` | If the annotation type is bitmap, this is the handle of the bitmap.
`cbText` | If the annotation type is underline, this is the length of the underlined text.
`color` | If the annotation type is underlined, this is the `COLORREF` value of the underlined text.
`hCursor` | The handle of the cursor when the mouse hovers over the annotation.

Copyright 2016-2023 Open Text
Version 24.1 | Last updated December 2023

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: IDOL KeyView 24.1

Topic Title: TPVAPIAnnotation