home | download | documentation | examples | sourceforge | forums

## Annotation

### HPDF_LinkAnnot_SetHighlightMode

#include "apdf.h"
HPDF_STATUS
HPDF_LinkAnnot_SetHighlightMode (HPDF_Annotation annot,
HPDF_AnnotHighlightMode mode);

#### Description

HPDF_LinkAnnot_SetHighlightMode() defined the appearance of when a mouse clicked on a link annotation. (see example program of link annotation)

#### Parameter

annot
The handle of an annotation object.
mode
The following valued are available.

| VALUE | DESCRIPTION
1 | HPDF_ANNOT_NO_HIGHTLIGHT | No highlighting.
2 | HPDF_ANNOT_INVERT_BOX | Invert the contents of the area of annotation.
3 | HPDF_ANNOT_INVERT_BORDER | Invert the annotation’s border.
4 | HPDF_ANNOT_DOWN_APPEARANCE | Dent the annotation.

#### Returns

When HPDF_LinkAnnot_SetHighlightMode() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

#### Error

HPDF_INVALID_ANNOTATION
An invalid annotation handle was set.
HPDF_INVALID_PARAMETER
An invalid value was set at either left, top or zoom parameter.
HPDF_FAILD_TO_ALLOC_MEM
Memory Allocation Failed.

### HPDF_LinkAnnot_SetBorderStyle

#include "apdf.h"
HPDF_STATUS
HPDF_LinkAnnot_SetBorderStyle (HPDF_Annotation annot,
HPDF_REAL width,
HPDF_UINT16 dash_on,
HPDF_UINT16 dash_off);

#### Description

HPDF_LinkAnnot_SetBorderStyle() defines the style of the annotation's border.

#### Parameter

annot
The handle of an annotation object.
width
The width of an annotation's border.
dash_on, dash_off
The dash style.

#### Returns

When HPDF_LinkAnnot_SetBorderStyle() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

#### Error

HPDF_INVALID_ANNOTATION
An invalid annotation handle was set.
HPDF_INVALID_PARAMETER
An invalid width value was set.
HPDF_FAILD_TO_ALLOC_MEM
Memory Allocation Failed.

### HPDF_TextAnnot_SetIcon

#include "apdf.h"
HPDF_STATUS
HPDF_TextAnnot_SetIcon (HPDF_Annotation annot,
HPDF_AnnotIcon icon);

#### Description

HPDF_TextAnnot_SetIcon() defines the style of the annotation's icon. (see example program of text annotation)

#### Parameter

annot
The handle of an annotation object.
icon
The style of icon. The following values are available.

- HPDF_ANNOT_ICON_COMMENT
- HPDF_ANNOT_ICON_KEY
- HPDF_ANNOT_ICON_NOTE
- HPDF_ANNOT_ICON_HELP
- HPDF_ANNOT_ICON_NEW_PARAGRAPH
- HPDF_ANNOT_ICON_PARAGRAPH
- HPDF_ANNOT_ICON_INSERT

#### Returns

When HPDF_TextAnnot_SetIcon() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

#### Error

HPDF_INVALID_ANNOTATION
An invalid annotation handle was set.
HPDF_ANNOT_INVALID_ICON
An invalid icon-style was specified.
HPDF_FAILD_TO_ALLOC_MEM
Memory Allocation Failed.

### HPDF_TextAnnot_SetOpened

#include "apdf.h"
HPDF_STATUS
HPDF_TextAnnot_SetOpened (HPDF_Annotation annot,
HPDF_BOOL opened);

#### Description

HPDF_TextAnnot_SetOpened() defines whether the text-annotation is initially displayed open.

#### Parameter

annot
The handle of an annotation object.
opened
HPDF_TRUE means that the annotation initially displayed open.

#### Returns

When HPDF_TextAnnot_SetOpened() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

#### Error

HPDF_INVALID_ANNOTATION
An invalid annotation handle was set.
HPDF_FAILD_TO_ALLOC_MEM
Memory Allocation Failed.