UnderlineAnnotationHandle Class Reference

An underline annotation appears as an underline beneath text in the document. When opened, it shall display a pop-up window containing the text of the associated note. More...

Inheritance diagram for UnderlineAnnotationHandle:

error_type CALLING_CONVENTION	UnderlineAnnotation_Create (UnderlineAnnotationHandle **result)
	Create a new empty underline annotation.
error_type CALLING_CONVENTION	UnderlineAnnotation_CreateFromRect (RectangleHandle *rect, UnderlineAnnotationHandle **result)
	Create a new underline annotation with the specified rectangle.
error_type CALLING_CONVENTION	UnderlineAnnotation_GetQuadPoints (UnderlineAnnotationHandle *handle, ArrayObjectHandle **result)
	Get the quad points array for text markup.
error_type CALLING_CONVENTION	UnderlineAnnotation_SetQuadPoints (UnderlineAnnotationHandle *handle, ArrayObjectHandle *value)
	Set the quad points array for text markup.
error_type CALLING_CONVENTION	UnderlineAnnotation_GetAuthor (UnderlineAnnotationHandle *handle, StringObjectHandle **result)
	Get the annotation author (T entry, markup annotations)
error_type CALLING_CONVENTION	UnderlineAnnotation_SetAuthor (UnderlineAnnotationHandle *handle, StringObjectHandle *value)
	Set the annotation author (T entry, markup annotations)
error_type CALLING_CONVENTION	UnderlineAnnotation_GetModificationDate (UnderlineAnnotationHandle *handle, DateHandle **result)
	Get the annotation modification date (M entry, markup annotations)
error_type CALLING_CONVENTION	UnderlineAnnotation_SetModificationDate (UnderlineAnnotationHandle *handle, DateHandle *value)
	Set the annotation modification date (M entry, markup annotations)
error_type CALLING_CONVENTION	UnderlineAnnotation_GetCreationDate (UnderlineAnnotationHandle *handle, DateHandle **result)
	Get the annotation creation date (CreationDate entry, markup annotations)
error_type CALLING_CONVENTION	UnderlineAnnotation_SetCreationDate (UnderlineAnnotationHandle *handle, DateHandle *value)
	Set the annotation creation date (CreationDate entry, markup annotations)
error_type CALLING_CONVENTION	UnderlineAnnotation_ToBaseAnnotation (UnderlineAnnotationHandle *handle, AnnotationHandle **result)
	Reinterpret current object as AnnotationHandle.
error_type CALLING_CONVENTION	UnderlineAnnotation_FromBaseAnnotation (AnnotationHandle *handle, UnderlineAnnotationHandle **result)
	Convert AnnotationHandle to UnderlineAnnotationHandle.
error_type CALLING_CONVENTION	UnderlineAnnotation_Release (UnderlineAnnotationHandle *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 underline annotation appears as an underline beneath text in the document. When opened, it shall display a pop-up window containing the text of the associated note.

Member Function Documentation

UnderlineAnnotation_Create()

error_type CALLING_CONVENTION UnderlineAnnotation_Create

(

UnderlineAnnotationHandle **

result

)

Create a new empty underline annotation.

Parameters

result

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

Friends And Related Symbol Documentation

UnderlineAnnotation_CreateFromRect()

error_type CALLING_CONVENTION UnderlineAnnotation_CreateFromRect ( RectangleHandle *  rect, UnderlineAnnotationHandle **  result  )

related

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

UnderlineAnnotation_GetQuadPoints()

error_type CALLING_CONVENTION UnderlineAnnotation_GetQuadPoints ( UnderlineAnnotationHandle *  handle, ArrayObjectHandle **  result  )

related

Get the quad points array for text markup.

Parameters

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

UnderlineAnnotation_SetQuadPoints()

error_type CALLING_CONVENTION UnderlineAnnotation_SetQuadPoints ( UnderlineAnnotationHandle *  handle, ArrayObjectHandle *  value  )

related

Set the quad points array for text markup.

Parameters

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

UnderlineAnnotation_Release()

error_type CALLING_CONVENTION UnderlineAnnotation_Release ( UnderlineAnnotationHandle *  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