A text annotation represents a "sticky note" attached to a point in the PDF document. When closed, the annotation shall appear as an icon; when open, it shall display a pop-up window containing the text of the note in a font and size chosen by the conforming reader. More...

Inheritance diagram for TextAnnotationHandle:

error_type CALLING_CONVENTION	TextAnnotation_Create (RectangleHandle rect, TextAnnotationHandle *result)
	Create a new text annotation with the specified rectangle.

error_type CALLING_CONVENTION	TextAnnotation_CreateWithContents (RectangleHandle rect, LiteralStringObjectHandle contents, TextAnnotationHandle **result)
	Create a new text annotation with the specified rectangle and contents.

error_type CALLING_CONVENTION	TextAnnotation_GetAuthor (TextAnnotationHandle handle, StringObjectHandle *result)
	Get the annotation author (T entry, markup annotations)

error_type CALLING_CONVENTION	TextAnnotation_SetAuthor (TextAnnotationHandle handle, StringObjectHandle value)
	Set the annotation author (T entry, markup annotations)

error_type CALLING_CONVENTION	TextAnnotation_GetModificationDate (TextAnnotationHandle handle, DateHandle *result)
	Get the annotation modification date (M entry, markup annotations)

error_type CALLING_CONVENTION	TextAnnotation_SetModificationDate (TextAnnotationHandle handle, DateHandle value)
	Set the annotation modification date (M entry, markup annotations)

error_type CALLING_CONVENTION	TextAnnotation_GetCreationDate (TextAnnotationHandle handle, DateHandle *result)
	Get the annotation creation date (CreationDate entry, markup annotations)

error_type CALLING_CONVENTION	TextAnnotation_SetCreationDate (TextAnnotationHandle handle, DateHandle value)
	Set the annotation creation date (CreationDate entry, markup annotations)

error_type CALLING_CONVENTION	TextAnnotation_ToBaseAnnotation (TextAnnotationHandle handle, AnnotationHandle *result)
	Reinterpret current object as AnnotationHandle.

error_type CALLING_CONVENTION	TextAnnotation_FromBaseAnnotation (AnnotationHandle handle, TextAnnotationHandle *result)
	Convert AnnotationHandle to TextAnnotationHandle.

error_type CALLING_CONVENTION	TextAnnotation_Release (TextAnnotationHandle *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 text annotation represents a "sticky note" attached to a point in the PDF document. When closed, the annotation shall appear as an icon; when open, it shall display a pop-up window containing the text of the note in a font and size chosen by the conforming reader.

Member Function Documentation

◆ TextAnnotation_Create()

error_type CALLING_CONVENTION TextAnnotation_Create	(	RectangleHandle *	rect,
		TextAnnotationHandle **	result
	)

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

Friends And Related Symbol Documentation

◆ TextAnnotation_CreateWithContents()

error_type CALLING_CONVENTION TextAnnotation_CreateWithContents	(	RectangleHandle *	rect,
		LiteralStringObjectHandle *	contents,
		TextAnnotationHandle **	result
	)

Parameters

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

◆ TextAnnotation_Release()

error_type CALLING_CONVENTION TextAnnotation_Release ( TextAnnotationHandle * handle )

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: