A free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead, the text shall always be visible. More...

Inheritance diagram for FreeTextAnnotationHandle:

error_type CALLING_CONVENTION	FreeTextAnnotation_Create (RectangleHandle rect, LiteralStringObjectHandle contents, LiteralStringObjectHandle defaultAppearance, FreeTextAnnotationHandle *result)
	Create a new free text annotation.

error_type CALLING_CONVENTION	FreeTextAnnotation_GetDefaultAppearance (FreeTextAnnotationHandle handle, LiteralStringObjectHandle *result)
	Get the default appearance string.

error_type CALLING_CONVENTION	FreeTextAnnotation_SetDefaultAppearance (FreeTextAnnotationHandle handle, LiteralStringObjectHandle value)
	Set the default appearance string.

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

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

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

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

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

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

error_type CALLING_CONVENTION	FreeTextAnnotation_ToBaseAnnotation (FreeTextAnnotationHandle handle, AnnotationHandle *result)
	Reinterpret current object as AnnotationHandle.

error_type CALLING_CONVENTION	FreeTextAnnotation_FromBaseAnnotation (AnnotationHandle handle, FreeTextAnnotationHandle *result)
	Convert AnnotationHandle to FreeTextAnnotationHandle.

error_type CALLING_CONVENTION	FreeTextAnnotation_Release (FreeTextAnnotationHandle *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 free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead, the text shall always be visible.

Member Function Documentation

◆ FreeTextAnnotation_Create()

error_type CALLING_CONVENTION FreeTextAnnotation_Create	(	RectangleHandle *	rect,
		LiteralStringObjectHandle *	contents,
		LiteralStringObjectHandle *	defaultAppearance,
		FreeTextAnnotationHandle **	result
	)

Create a new free text annotation.

Parameters

rect	the bounding rectangle for the annotation
contents	the text contents of the annotation
defaultAppearance	the default appearance string (font and size)
result	a pointer to variable that will contain the new annotation upon success

Friends And Related Symbol Documentation

◆ FreeTextAnnotation_GetDefaultAppearance()

error_type CALLING_CONVENTION FreeTextAnnotation_GetDefaultAppearance	(	FreeTextAnnotationHandle *	handle,
		LiteralStringObjectHandle **	result
	)

Parameters

handle	a handle to the free text annotation
result	a pointer to variable that will contain the default appearance string upon success

◆ FreeTextAnnotation_SetDefaultAppearance()

error_type CALLING_CONVENTION FreeTextAnnotation_SetDefaultAppearance	(	FreeTextAnnotationHandle *	handle,
		LiteralStringObjectHandle *	value
	)

Parameters

handle	a handle to the free text annotation
value	the default appearance string to set

◆ FreeTextAnnotation_Release()

error_type CALLING_CONVENTION FreeTextAnnotation_Release ( FreeTextAnnotationHandle * 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:

c_annotations.h

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ FreeTextAnnotation_Create()

Friends And Related Symbol Documentation

◆ FreeTextAnnotation_GetDefaultAppearance()

◆ FreeTextAnnotation_SetDefaultAppearance()

◆ FreeTextAnnotation_Release()