Interface class to define basic method of annotation. More...
Inherited by Foxit::PDF::Annotations::Annot, Foxit::PDF::Annotations::IMarkup, Foxit::PDF::Annotations::Link, and Foxit::PDF::Annotations::Popup.
Public Member Functions | |
Boolean | IsMarkup () |
Check if current annotation is a markup annotation. More... | |
AnnotType | GetType () |
Get the type of current annotation. More... | |
String^ | GetContents () |
Get the contents data. More... | |
void | SetContents (String^ content) |
Set the contents data. More... | |
DateTime^ | GetModifiedTime () |
Get the last modification time. More... | |
void | SetModifiedTime (DateTime^ modifiedTime) |
Set the last modification time. More... | |
uint32 | GetFlags () |
Get annotation flags. More... | |
void | SetFlags (uint32 flags) |
Set annotation flags. More... | |
String^ | GetName () |
Get annotation name string. More... | |
void | SetName (String^ name) |
Get annotation name string. More... | |
RectF^ | GetRect () |
Get rectangle value. More... | |
Boolean | Move (RectF^ rect) |
Move current annotation to a new position specified by a rectangle. More... | |
BorderInfo^ | GetBorderInfo () |
Get border information. More... | |
void | SetBorderInfo (BorderInfo^ border) |
Set border information. More... | |
Properties | |
int64 | pointer |
Pointer to a handle of PDF annotation object. This pointer is not useful outside this SDK. The application should not access the pointer to the handle of the PDF annotation object directly. | |
Interface class to define basic method of annotation.
BorderInfo ^ Foxit::PDF::Annotations::IAnnot::GetBorderInfo | ( | ) |
Get border information.
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
String ^ Foxit::PDF::Annotations::IAnnot::GetContents | ( | ) |
Get the contents data.
Contents data is the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
uint32 Foxit::PDF::Annotations::IAnnot::GetFlags | ( | ) |
Get annotation flags.
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
DateTime ^ Foxit::PDF::Annotations::IAnnot::GetModifiedTime | ( | ) |
Get the last modification time.
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
String ^ Foxit::PDF::Annotations::IAnnot::GetName | ( | ) |
Get annotation name string.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
RectF ^ Foxit::PDF::Annotations::IAnnot::GetRect | ( | ) |
Get rectangle value.
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
AnnotType Foxit::PDF::Annotations::IAnnot::GetType | ( | ) |
Get the type of current annotation.
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
Boolean Foxit::PDF::Annotations::IAnnot::IsMarkup | ( | ) |
Check if current annotation is a markup annotation.
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
Boolean Foxit::PDF::Annotations::IAnnot::Move | ( | RectF^ | rect | ) |
Move current annotation to a new position specified by a rectangle.
To move an annotation is to reset its rectangle.
[in] | rect | A Foxit::RectF object that specifies the new position. The rect should be "normalized" for PDF page coordination: left is always smaller than right, and bottom is always smaller than top. |
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
void Foxit::PDF::Annotations::IAnnot::SetBorderInfo | ( | BorderInfo^ | border | ) |
Set border information.
[in] | border | An Annotations::BorderInfo object that specifies the new border information to be set. Please refer to comment of Annotations::BorderInfo for more details. |
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
void Foxit::PDF::Annotations::IAnnot::SetContents | ( | String^ | content | ) |
Set the contents data.
Contents data is the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
Please ensure that a free text annotation has already been set the default appearance property for keeping its contents data useful.
[in] | content | A String object that specifies the new contents data to be set. It can be nullptr or empty. |
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
void Foxit::PDF::Annotations::IAnnot::SetFlags | ( | uint32 | flags | ) |
Set annotation flags.
[in] | flags | Value of flags. Please refer to enumeration Annotations::Flags and this can be one or combination of its values. |
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
void Foxit::PDF::Annotations::IAnnot::SetModifiedTime | ( | DateTime^ | modifiedTime | ) |
Set the last modification time.
[in] | modifiedTime | A Foxit::DateTime object that specifies the new last modification time data to be set. It should be valid and should not be nullptr. |
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.
void Foxit::PDF::Annotations::IAnnot::SetName | ( | String^ | name | ) |
Get annotation name string.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
[in] | name | A String object that specifies the new name string. This can be nullptr or empty. |
Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Square, Foxit::PDF::Annotations::Stamp, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::Link, Foxit::PDF::Annotations::Popup, Foxit::PDF::Annotations::Markup, and Foxit::PDF::Annotations::Annot.