CPDFAnnotation Class

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.PDF includes a wide variety of standard annotation types. Class Annot is the base class for all kinds of PDF annotations.It offers the base functions to get/set annotation's common properties, to move an annotation or reset appearance stream of an annotation. For concrete annotation types, please refer to derived classes. To get the count of annotations or get/add/remove an annotation, please refer to class CPDFPage. This class object can also be used to construct objects of other classes in order to do some more operation in annotation or access specified information of annotation.

Inheritance Hierarchy

SystemObject
ComPDFKit.PDFAnnotationCPDFAnnotation
More...

Namespace: ComPDFKit.PDFAnnotation
Assembly: ComPDFKit.NET (in ComPDFKit.NET.dll) Version: 2.0.0.0

Syntax

Copy

public class CPDFAnnotation

The CPDFAnnotation type exposes the following members.

Properties

	Name	Description
	Page	Returns the page that the annotation is associated with.
	Rect	Gets the rectangle of the annotation on the page.
	Type	Gets annotation type.

Top

Methods

	Name	Description
	GetAuthor	Gets the author of annotation.
	GetBorderWidth	Gets border width of the annotation.
	GetContent	Gets annotation content.
	GetCreationDate	Gets the creation date of annotation.
	GetFlags	Returns the flag of the annotation.
	GetIsHidden	This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
	GetIsLocked	This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
	GetIsReadOnly	This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
	GetModifyDate	Gets the modification date of annotation.
	GetRect	Gets rectangle on the page.
	GetRotation	Gets rotation angle of annotaton appearance.
	GetTextAttribute	Gets annotation text attribute, more:CTextAttribute
	GetTransparency	Gets annotation opacity.
	IsMersured
	IsValid	Whether the object is valid.
	ReleaseAnnot	Releases resources of the object.
	RemoveAnnot	Removes annotation.
	RenderAnnot(Int32, Int32, Byte, CPDFAppearanceType)	Renders contents of the annotation to image.
	RenderAnnot(Int32, Int32, IntPtr, CPDFAppearanceType)	Renders contents of the annotation to image.
	SetAuthor	Sets the author of annotation.
	SetBorderWidth	Sets border width of the annotation.
	SetContent	Sets annotation content.
	SetCreationDate	Sets the creation date of annotation.
	SetFlags	Sets the flag of the annotation.
	SetIsHidden	This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
	SetIsLocked	This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
	SetIsReadOnly	This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
	SetModifyDate	Sets the modification date of annotation.
	SetRect	Sets rectangle on the page.
	SetTextAttribute	Sets text attribute of annotation, more:CTextAttribute
	SetTransparency
	UpdateAp	Updates annotation appearance.
	UpdateApWithBitmap	Upadates annotation appearance by Bitmap.
	UpdateApWithImage

Top

Reference

ComPDFKit.PDFAnnotation Namespace

Inheritance Hierarchy