#include <PdfAnnotation.h>
Inherits PoDoFo::PdfDictionaryElement.
Inherited by PoDoFo::PdfAnnotationActionBase, PoDoFo::PdfAnnotationCaret, PoDoFo::PdfAnnotationCircle, PoDoFo::PdfAnnotationFileAttachement, PoDoFo::PdfAnnotationFreeText, PoDoFo::PdfAnnotationInk, PoDoFo::PdfAnnotationLine, PoDoFo::PdfAnnotationModel3D, PoDoFo::PdfAnnotationMovie, PoDoFo::PdfAnnotationPolyLine, PoDoFo::PdfAnnotationPolygon, PoDoFo::PdfAnnotationPopup, PoDoFo::PdfAnnotationPrinterMark, PoDoFo::PdfAnnotationProjection, PoDoFo::PdfAnnotationRedact, PoDoFo::PdfAnnotationRichMedia, PoDoFo::PdfAnnotationSound, PoDoFo::PdfAnnotationSquare, PoDoFo::PdfAnnotationStamp, PoDoFo::PdfAnnotationText, PoDoFo::PdfAnnotationTextMarkupBase, PoDoFo::PdfAnnotationTrapNet, PoDoFo::PdfAnnotationWatermark, and PoDoFo::PdfAnnotationWebMedia.
|
void | SetAppearanceStream (const PdfXObjectForm &xobj, PdfAppearanceType appearance=PdfAppearanceType::Normal, const PdfName &state="") |
|
void | SetAppearanceStreamRaw (const PdfXObjectForm &xobj, PdfAppearanceType appearance=PdfAppearanceType::Normal, const PdfName &state="") |
|
PdfObject * | GetAppearanceDictionaryObject () |
|
PdfObject * | GetAppearanceStream (PdfAppearanceType appearance=PdfAppearanceType::Normal, const PdfName &state="") |
|
Rect | GetRect () const |
|
void | SetRect (const Rect &rect) |
|
void | SetFlags (PdfAnnotationFlags flags) |
|
PdfAnnotationFlags | GetFlags () const |
|
void | SetBorderStyle (double hCorner, double vCorner, double width) |
|
void | SetBorderStyle (double hCorner, double vCorner, double width, const PdfArray &strokeStyle) |
|
void | SetTitle (nullable< const PdfString & > title) |
|
nullable< const PdfString & > | GetTitle () const |
|
void | SetContents (nullable< const PdfString & > contents) |
|
nullable< const PdfString & > | GetContents () const |
|
PdfColor | GetColor () const |
|
void | SetColor (nullable< const PdfColor & > color) |
|
PdfAnnotationType | GetType () const |
|
PdfPage * | GetPage () |
|
An annotation to a PdfPage To create an annotation use PdfPage::CreateAnnotation
- See also
- PdfPage::CreateAnnotation
◆ GetAppearanceDictionaryObject()
PdfObject * PdfAnnotation::GetAppearanceDictionaryObject |
( |
| ) |
|
- Returns
- the appearance /AP object for this annotation
◆ GetAppearanceStream()
- Returns
- the appearance stream for this object
- Parameters
-
appearance | an apperance type to get |
state | a child state. Meaning depends on the annotation type |
◆ GetColor()
PdfColor PdfAnnotation::GetColor |
( |
| ) |
const |
Get the color key of the Annotation dictionary which defines the color of the annotation, as per 8.4 of the pdf spec.
◆ GetContents()
Get the text of this annotation
- Returns
- the contents of this annotation
- See also
- SetContents
◆ GetFlags()
Get the flags of this annotation.
- Returns
- the flags which is an unsigned 32bit integer with different PdfAnnotationFlags OR'ed together.
- See also
- SetFlags
◆ GetPage()
PdfPage * PoDoFo::PdfAnnotation::GetPage |
( |
| ) |
|
|
inline |
Get the page of this PdfField
- Returns
- the page of this PdfField
◆ GetRect()
Rect PdfAnnotation::GetRect |
( |
| ) |
const |
Get the rectangle of this annotation.
- Returns
- a rectangle
◆ GetTitle()
Get the title of this annotation
- Returns
- the title of this annotation
- See also
- SetTitle
◆ GetType()
Get the type of this annotation
- Returns
- the annotation type
◆ SetAppearanceStream()
Set an appearance stream for this object to specify its visual appearance
- Parameters
-
xobj | an XObject form |
appearance | an apperance type to set |
state | the state for which set it the obj; states depend on the annotation type |
◆ SetAppearanceStreamRaw()
Set an appearance stream for this object to specify its visual appearance withot handling page rotations
- Parameters
-
xobj | an XObject form |
appearance | an apperance type to set |
state | the state for which set it the obj; states depend on the annotation type |
◆ SetBorderStyle() [1/2]
void PdfAnnotation::SetBorderStyle |
( |
double |
hCorner, |
|
|
double |
vCorner, |
|
|
double |
width |
|
) |
| |
Set the annotations border style.
- Parameters
-
hCorner | horitzontal corner radius |
vCorner | vertical corner radius |
width | width of border |
◆ SetBorderStyle() [2/2]
void PdfAnnotation::SetBorderStyle |
( |
double |
hCorner, |
|
|
double |
vCorner, |
|
|
double |
width, |
|
|
const PdfArray & |
strokeStyle |
|
) |
| |
Set the annotations border style.
- Parameters
-
hCorner | horitzontal corner radius |
dVCorner | vertical corner radius |
width | width of border |
strokeStyle | a custom stroke style pattern |
◆ SetColor()
Set the C key of the Annotation dictionary, which defines the color of the annotation, as per 8.4 of the pdf spec.
◆ SetContents()
Set the text of this annotation.
- Parameters
-
contents | text of the annoation as string in PDF format |
- See also
- GetContents
◆ SetFlags()
Set the flags of this annotation.
- See also
- GetFlags
◆ SetRect()
void PdfAnnotation::SetRect |
( |
const Rect & |
rect | ) |
|
Set the rectangle of this annotation.
- Parameters
-
◆ SetTitle()
Set the title of this annotation.
- Parameters
-
title | title of the annoation as string in PDF format |
- See also
- GetTitle