ipdf_annots.h

DisplayAnnots

void DisplayAnnots(IPDF_Page* page, IPDF_DIBitmap* bitmap, IPDF_Matrix* matrix, int showwidget) = 0;

Display all annotations.

參數

• page（in） — The page it belongs to.
• bitmap（in） — The bitmap to draw on.
• matrix（in） — The transformation matrix from user space to device space.
• showwidget（in） — Whether to show widget or not.

SetFixedIconParams

void SetFixedIconParams(int nFixedIconType, float sx, float sy, int nRotate) = 0;

Enable to show icon annotations as fixed size.

參數

• nFixedIconType（in） — Indicates how to display fixed annotations. 0 is to show as normal annotations, and 1 is to show as fixed scaling size, and 2 is to show as fixed device size.
• sx（in） — Fixed size according to the value of <i>nFixedIconType</i> in x axis.
• sy（in） — Fixed size according to the value of <i>nFixedIconType</i> in y axis.
• nRotate（in） — Page rotation, valid values are 0, 1, 2, 3.

GetAnnotMatrix

void GetAnnotMatrix(const IPDF_Annot* annot, const IPDF_Matrix* user2device_matrix, IPDF_Matrix* out_matrix) = 0;

Get annotation matrix from page space to device space.

參數

• annot（in） — The annotation.
• user2device_matrix（in） — Current displaying transformation matrix.
• out_matrix（out） — Annotation matrix to display.

GetAnnot

IPDF_Annot* GetAnnot(int index) = 0;

Get an annotation at specified index.

參數

• index（in） — The zero-based index in the annotation list.

傳回值：An annotation.

GetIndex

int GetIndex(IPDF_Annot* pAnnot) = 0;

Get annotation's index.

參數

• pAnnot（in） — The input annotation.

傳回值：The zero-based index in the annotation list, -1 for not exist.

RemoveAnnot

void RemoveAnnot(IPDF_Annot* pAnnot) = 0;

Remove the specificed annotation.

參數

• pAnnot（in） — The annotation to be removed.

RemoveAnnotByAnnotHandler

void RemoveAnnotByAnnotHandler(ANNNOT_HANDLER hander) = 0;

Remove annotation by the specificed annotation handler.

參數

• hander（in） — The annotation handler.

This method is used to implement Redo/Undo operater of annotation.

GetAnnotAt

IPDF_Annot* GetAnnotAt(const PDSDK_FloatPoint& point) = 0;

Get an annotation by specified position.

參數

• point（in） — The input position in PDF coordinate.

傳回值：An annotation.

GetAnnotByAnnotHandler

IPDF_Annot* GetAnnotByAnnotHandler(ANNNOT_HANDLER hander) = 0;

Get an annotation by specified handler.

參數

• hander（in） — The annotation handler.

傳回值：An annotation.

SetDrawingDPI

void SetDrawingDPI(int x, int y) = 0;

Set the device DPI.

參數

• x（in） — The x-direction DPI.
• y（in） — The y-direction DPI.

AddAnnot

IPDF_Annot* AddAnnot(int annot_type) = 0;

Create an annotation by sepcificed type and append to annotation list.

參數

• annot_type（in） — The input annotation type.

傳回值：An annotation.

AddAnnotByHandler

IPDF_Annot* AddAnnotByHandler(int insert_at, ANNNOT_HANDLER annot_handler) = 0;

Create an annotation by sepcificed hander and insert to annotation list.

參數

• insert_at（in） — The zero-based index to insert at.
• annot_handler（in） — The input annotation handler.

傳回值：An annotation.

AddAnnot

void AddAnnot(IPDF_Annot* pAnnot) = 0;

Add an annotation to annotation list.

參數

• pAnnot（in） — The input annotation.

GetType

int GetType() = 0;

Get annotation type.@see Annotation Types

傳回值：The annotation type.

GetSubType

int GetSubType() = 0;

Get annotation subtype.@see Annotation Subtypes

傳回值：The annotation subtype.

SetSubType

void SetSubType(int sub_type) = 0;

Set annotation subtype.

參數

• sub_type（in） — The annotaion subtypes.@see Annotation Subtypes

GetFlags

int GetFlags() = 0;

Get annotation flag. @see Annotation Flags

傳回值：The annotation flags.

SetFlags

void SetFlags(int flags) = 0;

Set annotation flags.

參數

• flags（in） — The annotaion flags.@see Annotation Flags

GetAnnotHandler

ANNNOT_HANDLER GetAnnotHandler() = 0;

Get annotation handler.

傳回值：The annotation handler, actually the handler is the dictionary of annotation.

GetRect

PDSDK_FloatRect GetRect() = 0;

Get annotation rectangle.

傳回值：The annotation rectangle.

SetRect

void SetRect(PDSDK_FloatRect* rect) = 0;

Set annotation rectangle.

參數

• rect（in） — The input rectangle.

The method just valiable for pop-up annotation.

Move

void Move(float dx, float dy) = 0;

Move the annotatioin.

參數

• dx（in） — The x-direction delta value.
• dy（in） — The y-direction delta value.

DrawAnnot

void DrawAnnot(IPDF_Page* page, IPDF_DIBitmap* bitmap, IPDF_Matrix* matrix, int nAppearenceMode) = 0;

Draw annotation to a bitmap.

參數

• page（in） — The page whitch the annotation is belong to.
• bitmap（in） — The bitmap to display the annotation.
• matrix（in） — The transform matrix. Normally it is the display matrix for page rendering.
• nAppearenceMode（in） — The appearance mode.@see Annotation Appearance Mode

DrawInContext

int DrawInContext(const IPDF_Page* page, const IPDF_RenderContext* pContext, const IPDF_Matrix* pUser2Device, int mode) = 0;

Draw annotation in a render-context.

參數

• page（in） — The page whitch the annotation is belong to.
• pContext（in） — The rendering context.
• pUser2Device（in） — The transform matrix. Normally it is the display matrix for page rendering.
• mode（in） — The appearance mode.@see Annotation Appearance Mode

傳回值：Non-zero for success, otherwise failure.

DrawAnnot

int DrawAnnot(const IPDF_Page* page, const IPDF_WindowsDevice* pDevice, const IPDF_Matrix* matrix, int nAppearenceMode, const RENDER_OPTION* opts) = 0;

Draw annotation in Windows Device Context.

參數

• page（in） — The page whitch the annotation is belong to.
• pDevice（in） — The Windows DC to display the annotation.
• matrix（in） — The transform matrix. Normally it is the display matrix for page rendering.
• nAppearenceMode（in） — The appearance mode.@see Annotation Appearance Mode
• opts（in） — The rendering options.Can not be NULL.

傳回值：Non-zero for success, otherwise failure.

GetLineStartingStyle

int GetLineStartingStyle() = 0;

Get the line-starting style.

傳回值：The line-starting style.

见 Annotation Line Endding Style

SetLineStartingStyle

void SetLineStartingStyle(int style) = 0;

Set the line-starting style.

參數

• style（in） — The line-starting style.@see Annotation Line Endding Style

GetLineEndingStyle

int GetLineEndingStyle() = 0;

Get the line-endding style.

傳回值：The line-endding style.

见 Annotation Line Endding Style

SetLineEndingStyle

void SetLineEndingStyle(int style) = 0;

Set the line-endding style.

參數

• style（in） — The line-starting style.@see Annotation Line Endding Style

SetPoints

int SetPoints(PDSDK_FloatPoint* points_array[], int point_count, int subType = 0) = 0;

Set the points to annotation.

參數

• points_array（in） — The input points. Line annotation: points_array has only two points, specificate the moveto point and lineto piont, if arrow annot, subType is 1.\n Square annotation: points_array has only two points specificate (left, bottom) and (right, top).\n Circle annotation: points_array has only two points specificate (left, bottom) and (right, top), means specificate the BBox of Cricle.\n Polygon annotation: points_array and point_count spcificate the points use to make a polygon.\n Polyline annotation: points_array and point_count spcificate the points use to make a polyline.\n Ink annotation:(x1, y1, x2, y2, ..., xn, yn), point_count = n / 2;\n Markup annotation(Highlight, Underline, Strikeout, Squiggly): points_array has n * 4 points specificate the boxies, the points order of a box is (left, top)(right, top)(left,bottom)(right bottom).\n Caret annotation: points_array has only two points specificate (left, bottom) and (right, top).\n StickNote annotation: points_array has two points as the bounding-box:(left, bottom, right, top).\n
• point_count（in） — The point count of points_array.
• subType（in） — The subtype of annotation.Just used for Arrow annotation.

傳回值：Zero for failure, Non-zero for success.

GetPointsCount

int GetPointsCount() = 0;

Get the points count.

傳回值：The number of points.

for StickNote, return two:(left, bottom), (right, top).

GetPoints

int GetPoints(PDSDK_FloatPoint* points_array[], int array_length) = 0;

Get the points of annotation.

參數

• points_array（in/out） — The points array. It should be filled by PDSDK_FloatPoint object.
• array_length（in） — The length of points_array.

傳回值：The actual readed number of points..

GenerateAppearance

void GenerateAppearance() = 0;

Generate the appearance stream of annotation.

When use @see SetPoints() to change the annotation appearance, we need generate the appearance stream before PDF documet saving.

GetAnnotName

const char* GetAnnotName() = 0;

Get the anntation name.

傳回值：The annotation name, a text string uniquely identifying it among all the annotations on its page.

SetAnnotName

void SetAnnotName(const char* name) = 0;

Set the anntation name.

參數

• name（in） — The input name.

GetDate

const char* GetDate(int creat_or_modify) = 0;

Get the creation date or modified date of annotation.

參數

• creat_or_modify（in） — Zero for creation date, 1 for modified date.

傳回值：The date string. The format of date string is (D:YYYYMMDDHHmmSSOHH'mm').

SetDate

void SetDate(const char* date, int creat_or_modify) = 0;

Set the creation date or modified date of annotation.

參數

• date（in） — The date string(YYYYMMDDHHmmSSOHH'mm').
• creat_or_modify（in） — Zero for creation date, 1 for modified date.

GetAuthor

const wchar_t* GetAuthor() = 0;

Get the author of annotation.

傳回值：The author(unicode).

SetAuthor

void SetAuthor(const wchar_t* author) = 0;

Set the author of annotation.

參數

• author（in） — The input author(unicode).

SetAuthor

void SetAuthor(const char* author_utf8) = 0;

Set the author of annotation, utf8 version.

參數

• author（in） — The input author(utf8).

GetSubject

const wchar_t* GetSubject() = 0;

Get the subject of annotation.

傳回值：The subject(unicode).

SetSubject

void SetSubject(const wchar_t* subject) = 0;

Set the subject of annotation.

參數

• subject（in） — The input subject(unicode).

SetSubject

void SetSubject(const char* subject_utf8) = 0;

Set the subject of annotation, utf8 version.

參數

• subject（in） — The input subject(utf8).

DoEraser

int DoEraser(const PDSDK_FloatRect& rect) = 0;

Eraser the ink annotation.

參數

• rect（in） — Spcificate the rectangle area to be eraser.

IsInkPointsInRect

int IsInkPointsInRect(const PDSDK_FloatRect& rect) = 0;

Test whether the ink annotation is in a rectangle.

參數

• rect（in） — The input rectangle.

ScaleToRect

void ScaleToRect(const PDSDK_FloatRect& dest_rect) = 0;

Scale annotation to fit a rectangle.

參數

• dest_rect（in） — The input destination rectangle.

AppendInkPoints

void AppendInkPoints(PDSDK_FloatPoint* points_array[], int point_count) = 0;

Append points to ink annotation.

參數

• points_array（in） — The points array. It should be filled by PDSDK_FloatPoint object.
• point_count（in） — The length of points_array.

CountInkPointsSegment

int CountInkPointsSegment() = 0;

Count the number of segments of ink annotation.

傳回值：The number of segments.

CountInkSegPoints

int CountInkSegPoints(int iSeg) = 0;

Count the number of points for sepcificate segment.

參數

• iSeg（in） — The segment index.

傳回值：The number of the segment specificated by iSeg.

GetInkPointsSegmnet

int GetInkPointsSegmnet(int iSeg, PDSDK_FloatPoint* points_array[], int array_length) = 0;

Get the points of sepcificated segment.

參數

• iSeg（in） — The segment index.
• points_array（in/out） — The array to receiv the points.
• array_length（in） — The length of array points_array.

傳回值：The number of the segment specificated by iSeg.

GetInkSegPathData

int GetInkSegPathData(int iSeg, IPDF_PathData* path_data) = 0;

Get the path data sepcificated segment.

參數

• iSeg（in） — The segment index.
• path_data（in） — The path data with iSeg.

傳回值：The number of the segment specificated by iSeg.

GetColor

int GetColor(unsigned int& rgb) = 0;

Get the border color.

參數

• rgb（in/out） — The border color.

傳回值：0 means no color.

SetColor

void SetColor(unsigned int rgb) = 0;

Set the border color.

參數

• rgb（in） — The border color.

GetFillColor

int GetFillColor(unsigned int& rgb) = 0;

Get the fill color.

參數

• rgb（in/out） — The fill color.

傳回值：0 means no color.

SetFillColor

void SetFillColor(unsigned int rgb) = 0;

Set the fill color.

參數

• rgb（in） — The fill color.

GetOpacity

float GetOpacity() = 0;

Get the opacity.

傳回值：The opacity from 0.0 to 1.0.

SetOpacity

void SetOpacity(float op) = 0;

Set the opacity.

參數

• op（in） — The opacity(0.0-1.0).

GetBorderWidth

int GetBorderWidth() = 0;

Get border width.

傳回值：The border width.

SetBorderWidth

void SetBorderWidth(int width) = 0;

Set border width.

參數

• width（in） — The border width.

GetBorderStyle

int GetBorderStyle() = 0;

Get border style.

傳回值：The border style.

见 Annotation Border Styles

SetBorderStyle

void SetBorderStyle(int style) = 0;

Set border style.

參數

• width（in） — The border style.@see Annotation Border Styles

GetParent

IPDF_Annot* GetParent() = 0;

Get parent annotation.

傳回值：The parent annotation.

SetParent

void SetParent(IPDF_Annot* pParent) = 0;

Set parent annotation.

參數

• pParent（in） — The parent annotation.

GetPopup

IPDF_Annot* GetPopup() = 0;

Get popup annotation.

傳回值：The popup annotation.

SetPopup

void SetPopup(IPDF_Annot* pPopup) = 0;

Set popup annotation.

參數

• pPopup（in） — The popup annotation.

SetPopupRect

void SetPopupRect(const PDSDK_FloatRect& rect) = 0;

Set the positon to show popup annotation.

參數

• rect（in） — A rectangle to specified the showing area of popup annotation.

GetPopupRect

void GetPopupRect(PDSDK_FloatRect& rect) = 0;

Get the showing rectangel of popup annotation.

參數

• rect（out） — The rectangle of popup annotation.

SetPopupOpen

void SetPopupOpen(int bOpen) = 0;

Set the open flag of popup annotation.

參數

• bOpen（in） — The popup open flag. 1 for open when display, 0 for closed.

ContentIsRichText

int ContentIsRichText() = 0;

Test whether the content of annotation is rich text.

傳回值：1 for rich text, otherwise not.

GetContents

const wchar_t* GetContents() = 0;

Get annotation content.

傳回值：The unicode content.

GetContents_UTF8

const char* GetContents_UTF8() = 0;

Get annotation content.

傳回值：The UTF-8 content.

SetContents

void SetContents(const wchar_t* contents, int bRichText) = 0;

Set annotaion content.

參數

• contents（in） — The unicode encodding content of annotation.
• bRichText（in） — The rich text flag,1 for rich text, otherwise not.

SetContents

void SetContents(const char* contents_utf8, int bRichText) = 0;

Set annotaion content.

參數

• contents（in） — The UTF-8 encodding content of annotation.
• bRichText（in） — The rich text flag,1 for rich text, otherwise not.

GetIRT

ANNNOT_HANDLER GetIRT() = 0;

Get IRT annotation.

傳回值：The IRT annotation.

SetIRT

void SetIRT(IPDF_Annot* pIRTAnnot) = 0;

Set IRT annotation.

參數

• pIRTAnnot（in） — The IRT annotation.

GroupWith

void GroupWith(IPDF_Annot* pAnnot) = 0;

Set annotation to group with annother.

參數

• pAnnot（in） — The annotation to be grouped with.

GetDestination

int GetDestination(PDSDK_Dest& dest) = 0;

Get the destination of link annotion.

參數

• dest（out） — The desitination.@see PDF destination structure

SetDestination

void SetDestination(const PDSDK_Dest& dest) = 0;

Set the destination to link annotion.

參數

• dest（in） — The desitination.@see PDF destination structure

SetDestination

int SetDestination(const wchar_t* dest_name) = 0;

Set named destination to link annotion.

參數

• dest_name（in） — The named desitination.

GetURI

const char* GetURI() = 0;

Get the URI of link annotion.

傳回值：The URI string.

SetURI

void SetURI(const char* uri) = 0;

Set the URI of link annotion.

參數

• uri（in） — The URI string.

GetFilePath

const wchar_t* GetFilePath() = 0;

Get the file path link annotion.

傳回值：The file path encodding by unicode .

SetFilePath

void SetFilePath(const wchar_t* path) = 0;

Set file path of link annotion.

參數

• path（in） — The unicode encodding file path.

SetFilePath

void SetFilePath(const char* path_utf8) = 0;

Set file path of link annotion.

參數

• path（in） — The utf8 encodding file path.

SetHighlightStyle

void SetHighlightStyle(int nStyle) = 0;

Set annotation highlight style.

參數

• nStyle（in） — The highlight style. @see Annotation Highlighting mode

IsPointInAnnot

int IsPointInAnnot(float x, float y) = 0;

Test whether a point is in a annotation rectangle.

參數

• x（in） — The x component of point.
• y（in） — The y component of point.

傳回值：1 for in annotation rectangle, 0 for not in .

StartEditText

IPDF_Paragraph* StartEditText() = 0;

Enter the edit mode to start edit the annotation text. Used for Type write annotion, Text Box annoation, Call Out annotation

參數

• nStyle（in） — The highlight style. @see Annotation Highlighting mode

傳回值：The editable paragraph interface.

IsPointInEditArea

int IsPointInEditArea(float x, float y) = 0;

Test whether a point is in the editable area of annotation.

參數

• x（in） — The x component of point.
• y（in） — The y component of point.

傳回值：1 for in editable area, 0 for not in .

SetPrivateData

void SetPrivateData(const char* key, const char* value) = 0;

Set the key-value formatted private data to annotation.

參數

• key（in） — The key of private data.
• value（in） — The value of private data.

傳回值：1 for in editable area, 0 for not in .

IsKeyExist

int IsKeyExist(const char* key) = 0;

Test whether a key is exist in annotaion dictionay or the private data mapped by a key is exist.

參數

• key（in） — The key to test.

傳回值：1 for exist, 0 for not exist .

GetPrivateData

const char* GetPrivateData(const char* key) = 0;

Get the key-value formatted private data of annotation.

參數

• key（in） — The key of private data.

傳回值：The value of private data .

SetAnnotID

void SetAnnotID(const char* id) = 0;

Set the unique ID to annotation.

參數

• id（in） — The unique ID.

傳回值：The value of private data .

GetAnnotID

const char* GetAnnotID() = 0;

Get the unique ID of annotation.

傳回值：The unique ID of annotation.

ToXML

iAmd_XmlElement* ToXML() = 0;

Serial annotaiton to XML.

傳回值：A XML element.