InkAnnotationHandle Class Reference

An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths. When opened, it shall display a pop-up window containing the text of the associated note. More...

Inheritance diagram for InkAnnotationHandle:

error_type CALLING_CONVENTION	InkAnnotation_Create (InkAnnotationHandle **result)
	Create a new empty ink annotation.
error_type CALLING_CONVENTION	InkAnnotation_CreateFromRect (RectangleHandle *rect, InkAnnotationHandle **result)
	Create a new ink annotation with the specified rectangle.
error_type CALLING_CONVENTION	InkAnnotation_GetInkList (InkAnnotationHandle *handle, ArrayObjectHandle **result)
	Get the ink list (array of stroked paths)
error_type CALLING_CONVENTION	InkAnnotation_SetInkList (InkAnnotationHandle *handle, ArrayObjectHandle *value)
	Set the ink list (array of stroked paths)
error_type CALLING_CONVENTION	InkAnnotation_GetAuthor (InkAnnotationHandle *handle, StringObjectHandle **result)
	Get the annotation author (T entry, markup annotations)
error_type CALLING_CONVENTION	InkAnnotation_SetAuthor (InkAnnotationHandle *handle, StringObjectHandle *value)
	Set the annotation author (T entry, markup annotations)
error_type CALLING_CONVENTION	InkAnnotation_GetModificationDate (InkAnnotationHandle *handle, DateHandle **result)
	Get the annotation modification date (M entry, markup annotations)
error_type CALLING_CONVENTION	InkAnnotation_SetModificationDate (InkAnnotationHandle *handle, DateHandle *value)
	Set the annotation modification date (M entry, markup annotations)
error_type CALLING_CONVENTION	InkAnnotation_GetCreationDate (InkAnnotationHandle *handle, DateHandle **result)
	Get the annotation creation date (CreationDate entry, markup annotations)
error_type CALLING_CONVENTION	InkAnnotation_SetCreationDate (InkAnnotationHandle *handle, DateHandle *value)
	Set the annotation creation date (CreationDate entry, markup annotations)
error_type CALLING_CONVENTION	InkAnnotation_ToBaseAnnotation (InkAnnotationHandle *handle, AnnotationHandle **result)
	Reinterpret current object as AnnotationHandle.
error_type CALLING_CONVENTION	InkAnnotation_FromBaseAnnotation (AnnotationHandle *handle, InkAnnotationHandle **result)
	Convert AnnotationHandle to InkAnnotationHandle.
error_type CALLING_CONVENTION	InkAnnotation_Release (InkAnnotationHandle *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

An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths. When opened, it shall display a pop-up window containing the text of the associated note.

Member Function Documentation

InkAnnotation_Create()

error_type CALLING_CONVENTION InkAnnotation_Create

(

InkAnnotationHandle **

result

)

Create a new empty ink annotation.

Parameters

result

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

Friends And Related Symbol Documentation

InkAnnotation_CreateFromRect()

error_type CALLING_CONVENTION InkAnnotation_CreateFromRect ( RectangleHandle *  rect, InkAnnotationHandle **  result  )

related

Create a new ink 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

InkAnnotation_GetInkList()

error_type CALLING_CONVENTION InkAnnotation_GetInkList ( InkAnnotationHandle *  handle, ArrayObjectHandle **  result  )

related

Get the ink list (array of stroked paths)

Parameters

handle	a handle to the ink annotation
result	a pointer to variable that will contain the ink list array upon success

InkAnnotation_SetInkList()

error_type CALLING_CONVENTION InkAnnotation_SetInkList ( InkAnnotationHandle *  handle, ArrayObjectHandle *  value  )

related

Set the ink list (array of stroked paths)

Parameters

handle	a handle to the ink annotation
value	the ink list array to set

InkAnnotation_Release()

error_type CALLING_CONVENTION InkAnnotation_Release ( InkAnnotationHandle *  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