AnnotationHandle Class Reference

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard. More...

Inheritance diagram for AnnotationHandle:

error_type CALLING_CONVENTION	Annotation_GetAnnotationType (AnnotationHandle *handle, AnnotationType *result)
	Get annotation type of object handle.
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.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

Member Function Documentation

Annotation_GetAnnotationType()

error_type CALLING_CONVENTION Annotation_GetAnnotationType	(	AnnotationHandle *	handle,
		AnnotationType *	result
	)

Get annotation type of object handle.

Parameters

handle	a handle to the annotation class
result	a pointer to variable will be filled with annotation type upon success, unchanged on failure

Friends And Related Symbol Documentation

Annotation_GetRect()

error_type CALLING_CONVENTION Annotation_GetRect ( AnnotationHandle *  handle, RectangleHandle **  result  )

related

Get the annotation rectangle.

Parameters

handle	a handle to the annotation class
result	a pointer to variable that will contain the rectangle upon success

Annotation_SetRect()

error_type CALLING_CONVENTION Annotation_SetRect ( AnnotationHandle *  handle, RectangleHandle *  value  )

related

Set the annotation rectangle.

Parameters

handle	a handle to the annotation class
value	the rectangle to set

Annotation_GetContents()

error_type CALLING_CONVENTION Annotation_GetContents ( AnnotationHandle *  handle, LiteralStringObjectHandle **  result  )

related

Get the annotation contents (text)

Parameters

handle	a handle to the annotation class
result	a pointer to variable that will contain the contents string upon success

Annotation_SetContents()

error_type CALLING_CONVENTION Annotation_SetContents ( AnnotationHandle *  handle, LiteralStringObjectHandle *  value  )

related

Set the annotation contents (text)

Parameters

handle	a handle to the annotation class
value	the contents string to set

Annotation_GetColor()

error_type CALLING_CONVENTION Annotation_GetColor ( AnnotationHandle *  handle, ColorHandle **  result  )

related

Get the annotation color.

Parameters

handle	a handle to the annotation class
result	a pointer to variable that will contain the color upon success

Annotation_SetColor()

error_type CALLING_CONVENTION Annotation_SetColor ( AnnotationHandle *  handle, ColorHandle *  value  )

related

Set the annotation color.

Parameters

handle	a handle to the annotation class
value	the color to set

Annotation_GetFlags()

error_type CALLING_CONVENTION Annotation_GetFlags ( AnnotationHandle *  handle, AnnotationFlags *  result  )

related

Get the annotation flags (F entry)

Parameters

handle	a handle to the annotation class
result	a pointer to variable that will contain the flags upon success

Annotation_SetFlags()

error_type CALLING_CONVENTION Annotation_SetFlags ( AnnotationHandle *  handle, AnnotationFlags  value  )

related

Set the annotation flags (F entry)

Parameters

handle	a handle to the annotation class
value	the flags to set (can be combined with bitwise OR)

Annotation_Release()

error_type CALLING_CONVENTION Annotation_Release ( AnnotationHandle *  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