Foxit::PDF::Annotations Namespace Reference

Annotations namespace. Provide classes for accessing PDF annotation. More...

Classes

class  Annot
 Class to represent common annotation with basic annotation methods. More...
 
class  AnnotIconProvider
 Class to represent annotation icon provider. More...
 
class  BorderInfo
 Class to represent annotation border information. More...
 
class  Circle
 Class to represent circle annotation. More...
 
class  FileAttachment
 Class to represent file attachment annotation. More...
 
class  FreeText
 Class to represent free text annotation. More...
 
class  Highlight
 Class to represents highlight annotation. More...
 
interface  IAnnot
 Interface class to define basic method of annotation. More...
 
class  IconProviderInfo
 Class to represent identity information of annotation icon provider. More...
 
interface  IMarkup
 Interface class to define basic method of markup annotation. More...
 
class  Ink
 Class to represent ink annotation. More...
 
interface  ITextMarkup
 Interface class to define basic method of text markup annotation. More...
 
class  LeaderLineInfo
 Class to represent leader line information. More...
 
class  Line
 Class to represent line annotation. More...
 
class  Link
 Class to represent link annotation. More...
 
class  Markup
 Class to represent common markup annotation with basic markup annotation methods. More...
 
class  Note
 Class to represent note annotation. More...
 
class  Polygon
 Class to represent polygon annotation. More...
 
class  PolyLine
 Class to represent polyline annotation. More...
 
class  Popup
 Class to represent pop-up annotation. More...
 
class  ShadingColor
 Class to represent shading colors. More...
 
class  Square
 Class to represent square annotation. More...
 
class  Squiggly
 Class to represents squiggly annotation. More...
 
class  Stamp
 Class to represent stamp annotation. More...
 
class  StrikeOut
 Class to represents strikout annotation. More...
 
class  Underline
 Class to represents underline annotation. More...
 

Enumerations

Functions

public delegate Boolean ReleaseDelegate (Object^ clientData)
 A delegate function to release related resources. More...
 
public delegate IconProviderInfoGetIconProviderInfoDelegate (Object^ clientData)
 A delegate function to retrieve identity information of an icon provider. More...
 
public delegate Boolean HasIconDelegate (Object^ clientData, AnnotType annotType, String^ iconName)
 A delegate function to check whether icon provider has a suitable icon. More...
 
public delegate Boolean CanChangeColorDelegate (Object^ clientData, AnnotType annotType, String^ iconName)
 A delegate function to determine whether supports to change icon color. More...
 
public delegate Foxit::PDF::PageGetIconDelegate (Object^ clientData, AnnotType annotType, String^ iconName, uint32 color)
 A delegate function to retrieved the icon. More...
 
public delegate ShadingColorSetShadingColorDelegate (Object^ clientData, AnnotType annotType, String^ iconName, uint32 refColor, int32 shadingIndex)
 A delegate function to set the shading colors if the icon supports shading. More...
 
public delegate Size GetDisplaySizeDelegate (Object^ clientData, AnnotType annotType, String^ iconName)
 A delegate function to retrieve the icon size for disply, in device size (pixel normarlly). More...
 

Detailed Description

Annotations namespace. Provide classes for accessing PDF annotation.

Enumeration Type Documentation

Enumeration for annotation action triggers.

This enumeration is used for functions Link::CountActions, Link::GetAction, Link::SetAction, Link::InsertActoin, Link::RemoveAction, and Link::RemoveAllActions. Values of this enumeration should be used alone.

Enumerator
CursorEnter 

brief An action to be performed when the cursor enters the annotation's active area.

CursorExist 

brief An action to be performed when the cursor exits the annotation's active area.

MouseButonDown 

brief An action to be performed when the mouse button is pressed inside the annotation's active area.

MouseButtonUp 

brief An action to be performed when the mouse button is released inside the annotation's active area.

GetFocus 

brief An action to be performed when the annotation receives the input focus.

LoseFocus 

brief An action to be performed when the annotation loses the input focus.

PageOpen 

brief An action to be performed when the page containing the annotation is opened.

PageClose 

brief An action to be performed when the page containing the annotation is closed.

PageVisible 

brief An action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

PageInvisible 

brief An action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.

Enumeration for annotation types.

This enumeration is used for functions IAnnot::GetType, Page::CountAnnots, Page::GetAnnot, Page::GetAnnotAtPos, and Page::AddAnnot. Values of this enumeration should be used alone.

Enumerator
Unknown 

Annotation type: unknown.

Note 

Annotation type: note annotation, which is just "Text" annotation defined in PDF reference 1.7.

FreeText 

Annotation type: free text annotation.

Line 

Annotation type: line annotation.

Square 

Annotation type: square annotation.

Circle 

Annotation type: circle annotation.

Highlight 

Annotation type: hightlihgt annotation.

Underline 

Annotation type: underline annotation.

StrikeOut 

Annotation type: strikeout annotation.

Stamp 

Annotation type: stamp annotation.

Ink 

Annotation type: ink annotation.

Popup 

Annotation type: poo-up annotation.

Link 

Annotation type: link annotation.

Polygon 

Annotation type: polygon annotation.

PolyLine 

Annotation type: polyline annotation.

Squiggly 

Annotation type: squiggly annotation.

Caret 

Annotation type: caret annotation.

FileAttachment 

Annotation type: file attachment annotation.

Widget 

Annotation type: widget annotation.

Watermark 

Annotation type: watermark annotation.

PSInk 

Annotation type: pressure sensitive ink annotation.

Sound 

Annotation type: sound annotation.

Movie 

Annotation type: movie annotation.

Screen 

Annotation type: screen annotation.

PrinterMark 

Annotation type: printer's mark annotation.

TrapNet 

Annotation type: trap network annotation.

ThreeDimensional 

Annotation type: 3D annotation.

Enumeration for border styles.

This enumeration is used for property BorderInfo::Style. Values of this enumeration should be used alone.

Enumerator
Solid 

Border style: Solid.

Dashed 

Border style: Dashed.

UnderLine 

Border style: Underline.

Beveled 

Border style: Beveled.

Inset 

Border style: Inset.

Cloudy 

Border style: Cloudy.

Enumeration for annotation flags.

This enumeration is used for functions IAnnot::GetFlags, IAnnot::SetFlags, Signature::GetAnnotFlags and Signature::SetAnnotFlags. Values of this enumeration can be used alone or in combination.

Enumerator
Invisible 

Annotation flag: invisible.

Hidden 

Annotation flag: hidden.

Print 

Annotation flag: print.

NoZoom 

Annotation flag: no zoom.

NoRotate 

Annotation flag: no rotate.

NoView 

Annotation flag: no view.

ReadOnly 

Annotation flag: read only.

Locked 

Annotation flag: locked.

ToggleNoView 

Annotation flag: toggle no view.

LockedContents 

Annotation flag: locked contents.

Enumeration for highlighting modes.

This enumeration is used for functions Link::GetHighlightingMode, and Link::SetHighlightingMode. Values of this enumeration should be used alone.

Enumerator
None 

Highlighting mode: None.

Invert 

Highlighting mode: Invert.

Outline 

Highlighting mode: Outline.

Push 

Highlighting mode: Push.

Toggle 

Highlighting mode: Toggle.

Enumeration for annotation states.

This enumeration is used for functions IMarkup::AddState, Note::GetState, and Note::SetState. Values of this enumeration should be used alone.

Enumerator
Marked 

Annotation state: marked, belonging to marked model.

Unmarked 

Annotation state: unmarked, belonging to marked model.

Accepted 

Annotation state: accepted, belonging to review model.

Rejected 

Annotation state: rejected, belonging to review model.

Cancelled 

Annotation state: canceled, belonging to review model.

Completed 

Annotation state: completed, belonging to review model.

None 

Annotation state: none, belonging to review model.

Function Documentation

public delegate Boolean Foxit::PDF::Annotations::CanChangeColorDelegate ( Object^  clientData,
AnnotType  annotType,
String^  iconName 
)

A delegate function to determine whether supports to change icon color.

This is used for class Annotations::AnnotIconProvider.

Parameters
[in]clientDataAn object which stores user-defined data.
[in]annotTypeAnnotation type. Support types:
[in]iconNameA String object which specifies the identity of icon.
  • For AnnotType::Note, it should be one of followings: "Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow"
  • For AnnotType::FileAttachment, it should be one of followings: "Graph", "Paperclip", "PushPin", "Tag",
  • For AnnotType::Stamp, it should be one of followings: "Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret"
Returns
A boolean value: true means icon provider can change the color, while false means icon provider cannot change color.
public delegate Size Foxit::PDF::Annotations::GetDisplaySizeDelegate ( Object^  clientData,
AnnotType  annotType,
String^  iconName 
)

A delegate function to retrieve the icon size for disply, in device size (pixel normarlly).

This is used for class Annotations::AnnotIconProvider. Please ensure to return a valid Size object when this function succeeds.

Parameters
[in]clientDataAn object which stores user-defined data.
[in]annotTypeAnnotation type. Support types:
[in]iconNameA String object which specifies the identity of icon.
  • For AnnotType::Note, it should be one of followings: "Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow"
  • For AnnotType::FileAttachment, it should be one of followings: "Graph", "Paperclip", "PushPin", "Tag",
  • For AnnotType::Stamp, it should be one of followings: "Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret"
Returns
Size of icon for display. Both width and height would not be 0 when this function succeeds, otherwise it means this function fails.
public delegate Foxit::PDF::Page ^ Foxit::PDF::Annotations::GetIconDelegate ( Object^  clientData,
AnnotType  annotType,
String^  iconName,
uint32  color 
)

A delegate function to retrieved the icon.

This is used for class Annotations::AnnotIconProvider. Contents of a PDF page can be used as an icon. Please ensure to return a valid page object when this function succeeds.

Parameters
[in]clientDataAn object which stores user-defined data.
[in]annotTypeAnnotation type. Support types:
[in]iconNameA String object which specifies the identity of icon.
  • For AnnotType::Note, it should be one of followings: "Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow"
  • For AnnotType::FileAttachment, it should be one of followings: "Graph", "Paperclip", "PushPin", "Tag",
  • For AnnotType::Stamp, it should be one of followings: "Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret"
[in]colorColor for the icon if icon needs. Format: 0xAARRGGBB and alpha value is ignored.
Returns
A PDF::Page object that receives a PDF page object as the icon. If there is any error, this function will return nullptr.
public delegate IconProviderInfo ^ Foxit::PDF::Annotations::GetIconProviderInfoDelegate ( Object^  clientData)

A delegate function to retrieve identity information of an icon provider.

This is used for class Annotations::AnnotIconProvider. Please ensure to return a valid Annotations::IconProviderInfo object when this function succeeds.

Parameters
[in]clientDataAn object which stores user-defined data.
Returns
A Annotations::AnnotIconProviderInfo object that receives the identity information of the icon provider which is being used. If there is any error, this function will return nullptr.
public delegate Boolean Foxit::PDF::Annotations::HasIconDelegate ( Object^  clientData,
AnnotType  annotType,
String^  iconName 
)

A delegate function to check whether icon provider has a suitable icon.

This is used for class Annotations::AnnotIconProvider.

Parameters
[in]clientDataAn object which stores user-defined data.
[in]annotTypeAnnotation type. Support types:
[in]iconNameA String object which specifies the identity of icon.
  • For AnnotType::Note, it should be one of followings: "Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow"
  • For AnnotType::FileAttachment, it should be one of followings: "Graph", "Paperclip", "PushPin", "Tag",
  • For AnnotType::Stamp, it should be one of followings: "Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret"
Returns
A boolean value: true means icon provider has suitable icon, while false means icon provider does not have suitable icon.
public delegate Boolean Foxit::PDF::Annotations::ReleaseDelegate ( Object^  clientData)

A delegate function to release related resources.

Currently, this is only used for class Annotations::AnnotIconProvider.

Parameters
[in]clientDataAn object which stores user-defined data.
Returns
A boolean value: true means success, while false means error.
public delegate ShadingColor ^ Foxit::PDF::Annotations::SetShadingColorDelegate ( Object^  clientData,
AnnotType  annotType,
String^  iconName,
uint32  refColor,
int32  shadingIndex 
)

A delegate function to set the shading colors if the icon supports shading.

This is used for class Annotations::AnnotIconProvider. Please ensure to return a valid Annotations::ShadingColor object when this function succeeds.

Parameters
[in]clientDataAn object which stores user-defined data.
[in]annotTypeAnnotation type. Support types:
[in]iconNameA String object which specifies the identity of icon.
  • For AnnotType::Note, it should be one of followings: "Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow"
  • For AnnotType::FileAttachment, it should be one of followings: "Graph", "Paperclip", "PushPin", "Tag",
  • For AnnotType::Stamp, it should be one of followings: "Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret"
[in]refColorReferenced color to set. Format: 0xAARRGGBB and alpha value is ignored.
[in]shadingIndexIndex color of shading. If shading colors are more than one set, this function will be called multiple times.
Returns
A Annotations::ShadingColor object that receives the shading color. If there is any error, this function will return nullptr.

Foxit Corporation