HighlightAnnotationHandle Class Reference

A highlight annotation appears as a highlight over a region of text in the document. When opened, it shall display a pop-up window containing the text of the associated note. More...

Inheritance diagram for HighlightAnnotationHandle:

error_type CALLING_CONVENTION	HighlightAnnotation_Create (HighlightAnnotationHandle **result)
	Create a new empty highlight annotation.
error_type CALLING_CONVENTION	HighlightAnnotation_CreateFromRect (RectangleHandle *rect, HighlightAnnotationHandle **result)
	Create a new highlight annotation with the specified rectangle.
error_type CALLING_CONVENTION	HighlightAnnotation_GetQuadPoints (HighlightAnnotationHandle *handle, ArrayObjectHandle **result)
	Get the quad points array for text markup.
error_type CALLING_CONVENTION	HighlightAnnotation_SetQuadPoints (HighlightAnnotationHandle *handle, ArrayObjectHandle *value)
	Set the quad points array for text markup.
error_type CALLING_CONVENTION	HighlightAnnotation_GetAuthor (HighlightAnnotationHandle *handle, StringObjectHandle **result)
	Get the annotation author (T entry, markup annotations)
error_type CALLING_CONVENTION	HighlightAnnotation_SetAuthor (HighlightAnnotationHandle *handle, StringObjectHandle *value)
	Set the annotation author (T entry, markup annotations)
error_type CALLING_CONVENTION	HighlightAnnotation_GetModificationDate (HighlightAnnotationHandle *handle, DateHandle **result)
	Get the annotation modification date (M entry, markup annotations)
error_type CALLING_CONVENTION	HighlightAnnotation_SetModificationDate (HighlightAnnotationHandle *handle, DateHandle *value)
	Set the annotation modification date (M entry, markup annotations)
error_type CALLING_CONVENTION	HighlightAnnotation_GetCreationDate (HighlightAnnotationHandle *handle, DateHandle **result)
	Get the annotation creation date (CreationDate entry, markup annotations)
error_type CALLING_CONVENTION	HighlightAnnotation_SetCreationDate (HighlightAnnotationHandle *handle, DateHandle *value)
	Set the annotation creation date (CreationDate entry, markup annotations)
error_type CALLING_CONVENTION	HighlightAnnotation_ToBaseAnnotation (HighlightAnnotationHandle *handle, AnnotationHandle **result)
	Reinterpret current object as AnnotationHandle.
error_type CALLING_CONVENTION	HighlightAnnotation_FromBaseAnnotation (AnnotationHandle *handle, HighlightAnnotationHandle **result)
	Convert AnnotationHandle to HighlightAnnotationHandle.
error_type CALLING_CONVENTION	HighlightAnnotation_Release (HighlightAnnotationHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from AnnotationHandle
error_type CALLING_CONVENTION	Annotation_GetAnnotationType (AnnotationHandle *handle, AnnotationType *result)
	Get annotation type of object handle.
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from AnnotationHandle
error_type CALLING_CONVENTION	Annotation_ToUnknown (AnnotationHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	Annotation_FromUnknown (IUnknownHandle *handle, AnnotationHandle **result)
	Convert IUnknownHandle to PageAnnotationsHandle.
error_type CALLING_CONVENTION	Annotation_GetRect (AnnotationHandle *handle, RectangleHandle **result)
	Get the annotation rectangle.
error_type CALLING_CONVENTION	Annotation_SetRect (AnnotationHandle *handle, RectangleHandle *value)
	Set the annotation rectangle.
error_type CALLING_CONVENTION	Annotation_GetContents (AnnotationHandle *handle, LiteralStringObjectHandle **result)
	Get the annotation contents (text)
error_type CALLING_CONVENTION	Annotation_SetContents (AnnotationHandle *handle, LiteralStringObjectHandle *value)
	Set the annotation contents (text)
error_type CALLING_CONVENTION	Annotation_GetColor (AnnotationHandle *handle, ColorHandle **result)
	Get the annotation color.
error_type CALLING_CONVENTION	Annotation_SetColor (AnnotationHandle *handle, ColorHandle *value)
	Set the annotation color.
error_type CALLING_CONVENTION	Annotation_GetFlags (AnnotationHandle *handle, AnnotationFlags *result)
	Get the annotation flags (F entry)
error_type CALLING_CONVENTION	Annotation_SetFlags (AnnotationHandle *handle, AnnotationFlags value)
	Set the annotation flags (F entry)
error_type CALLING_CONVENTION	Annotation_Release (AnnotationHandle *handle)
	Decrement the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

A highlight annotation appears as a highlight over a region of text in the document. When opened, it shall display a pop-up window containing the text of the associated note.

Member Function Documentation

HighlightAnnotation_Create()

error_type CALLING_CONVENTION HighlightAnnotation_Create

(

HighlightAnnotationHandle **

result

)

Create a new empty highlight annotation.

Parameters

result

a pointer to variable that will contain the new annotation upon success

Friends And Related Symbol Documentation

HighlightAnnotation_CreateFromRect()

error_type CALLING_CONVENTION HighlightAnnotation_CreateFromRect ( RectangleHandle *  rect, HighlightAnnotationHandle **  result  )

related

Create a new highlight annotation with the specified rectangle.

Parameters

rect	the bounding rectangle for the annotation
result	a pointer to variable that will contain the new annotation upon success

HighlightAnnotation_GetQuadPoints()

error_type CALLING_CONVENTION HighlightAnnotation_GetQuadPoints ( HighlightAnnotationHandle *  handle, ArrayObjectHandle **  result  )

related

Get the quad points array for text markup.

Parameters

handle	a handle to the highlight annotation
result	a pointer to variable that will contain the quad points array upon success

HighlightAnnotation_SetQuadPoints()

error_type CALLING_CONVENTION HighlightAnnotation_SetQuadPoints ( HighlightAnnotationHandle *  handle, ArrayObjectHandle *  value  )

related

Set the quad points array for text markup.

Parameters

handle	a handle to the highlight annotation
value	the quad points array to set

HighlightAnnotation_Release()

error_type CALLING_CONVENTION HighlightAnnotation_Release ( HighlightAnnotationHandle *  handle )

related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

IUnknown_Release

---

The documentation for this class was generated from the following file:

• c_annotations.h