Interface class to define basic method of markup annotation. More...
Inherits Foxit::PDF::Annotations::IAnnot.
Inherited by Foxit::PDF::Annotations::Circle, Foxit::PDF::Annotations::FileAttachment, Foxit::PDF::Annotations::FreeText, Foxit::PDF::Annotations::Ink, Foxit::PDF::Annotations::ITextMarkup, Foxit::PDF::Annotations::Line, Foxit::PDF::Annotations::Markup, Foxit::PDF::Annotations::Note, Foxit::PDF::Annotations::Polygon, Foxit::PDF::Annotations::PolyLine, Foxit::PDF::Annotations::Square, and Foxit::PDF::Annotations::Stamp.
Public Member Functions | |
String^ | GetTitle () |
Get title string. More... | |
void | SetTitle (String^ title) |
Set title string. More... | |
String^ | GetSubject () |
Get subject string. More... | |
void | SetSubject (String^ subject) |
Set subject string. More... | |
float | GetOpacity () |
Get opacity value. More... | |
void | SetOpacity (float opacity) |
Set opacity value. More... | |
String^ | GetIntent () |
Get intent name. More... | |
void | SetIntent (String^ intent) |
Set intent name. More... | |
DateTime^ | GetCreationTime () |
Get creation time. More... | |
void | SetCreationTime (DateTime^ creationTime) |
Set the creation time. More... | |
Popup^ | GetPopup () |
Get related pop-up annotation. More... | |
Int32 | CountStates (Int32 stateModel) |
Count state annotations with specific state model, related to current markup annotation. More... | |
Note^ | GetState (Int32 stateModel, Int32 index) |
Get a state annoation with specific state model, related to current markup annotation. More... | |
Note^ | AddState (State state) |
Add a new state annotation. More... | |
Boolean | RemoveAllStates () |
Remove all the state annotations. More... | |
Int32 | CountReplies () |
Count reply annotations. More... | |
Note^ | GetReply (Int32 index) |
Get a reply annotation by index. More... | |
Note^ | AddReply () |
Add a reply annotation to the end of reply annotation list. More... | |
Boolean | RemoveReply (Int32 index) |
Remove a reply annotation by index. More... | |
Boolean | RemoveAllReplies () |
Remove all the reply annotations. More... | |
Boolean | IsGrouped () |
Check whether current markup annotation is in a group or not. More... | |
IMarkup^ | GetGroupHeader () |
Get the header annotation (as primary annotation) of the group which current markup annotation belongs to. More... | |
List< IMarkup^ >^ | GetGroupElements () |
Get all the markup annotations (including current one) in the group which current markup annotation belongs to. More... | |
Boolean | Ungroup () |
Ungroup current markup annotation from the group it belongs to. More... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
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 markup annotation.
Note ^ Foxit::PDF::Annotations::IMarkup::AddReply | ( | ) |
Add a reply annotation to the end of reply annotation list.
Markup annotations may have several reply annotations which are represented by note annotations. Usually, viewer applications should not display reply annotations individually but together in the form of threaded comments.
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, and Foxit::PDF::Annotations::Markup.
Add a new state annotation.
Markup annotations may have an author-specific state associated with them. The state is not specified in the annotation itself but in a separate note annotation that refers to the original annotation. When a note annotation represents a state annotation, this note annotation will not be displayed individually.
[in] | state | State value of the new state annotation. Please refer to enumeration Annotations::State and this should be one 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, and Foxit::PDF::Annotations::Markup.
Int32 Foxit::PDF::Annotations::IMarkup::CountReplies | ( | ) |
Count reply annotations.
Markup annotations may have several reply annotations which are represented by note annotations. Usually, viewer applications should not display reply annotations individually but together in the form of threaded comments.
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, and Foxit::PDF::Annotations::Markup.
Int32 Foxit::PDF::Annotations::IMarkup::CountStates | ( | Int32 | stateModel | ) |
Count state annotations with specific state model, related to current markup annotation.
Markup annotations may have an author-specific state associated with them. The state is not specified in the annotation itself but in a separate text annotation that refers to the original annotation. When a note annotation represents a state annotation, this note annotation will not be displayed individually.
[in] | stateModel | The state model. It should be one of following 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, and Foxit::PDF::Annotations::Markup.
DateTime ^ Foxit::PDF::Annotations::IMarkup::GetCreationTime | ( | ) |
Get creation 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, and Foxit::PDF::Annotations::Markup.
List<IMarkup^> ^ Foxit::PDF::Annotations::IMarkup::GetGroupElements | ( | ) |
Get all the markup annotations (including current one) in the group which current markup annotation belongs to.
Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.
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, and Foxit::PDF::Annotations::Markup.
IMarkup ^ Foxit::PDF::Annotations::IMarkup::GetGroupHeader | ( | ) |
Get the header annotation (as primary annotation) of the group which current markup annotation belongs to.
Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.
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, and Foxit::PDF::Annotations::Markup.
String ^ Foxit::PDF::Annotations::IMarkup::GetIntent | ( | ) |
Get intent name.
Intent name is a name describing the intent of the markup annotation. Intents allow viewer applications to distinguish between different uses and behaviors of a single markup annotation type. If this property string is not present or its value is the same as the annotation type, the annotation has no explicit intent and should behave in a generic manner in a viewer application.
Free text, line, polygon and polyline annotations have predefined intent names. Please refer to comment of following functions 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, and Foxit::PDF::Annotations::Markup.
float Foxit::PDF::Annotations::IMarkup::GetOpacity | ( | ) |
Get opacity 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, and Foxit::PDF::Annotations::Markup.
Popup ^ Foxit::PDF::Annotations::IMarkup::GetPopup | ( | ) |
Get related pop-up annotation.
All the markup annotations can have a pop-up annotation. But for free text and sound annotations, they do not need a pop-up 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, and Foxit::PDF::Annotations::Markup.
Note ^ Foxit::PDF::Annotations::IMarkup::GetReply | ( | Int32 | index | ) |
Get a reply annotation by index.
Markup annotations may have several reply annotations which are represented by note annotations. Usually, viewer applications should not display reply annotations individually but together in the form of threaded comments.
[in] | index | Index of the replay annotation to be got. Range: 0 to (replyCount-1). replyCount is returned by function IMarkup::CountReplies. |
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, and Foxit::PDF::Annotations::Markup.
Note ^ Foxit::PDF::Annotations::IMarkup::GetState | ( | Int32 | stateModel, |
Int32 | index | ||
) |
Get a state annoation with specific state model, related to current markup annotation.
Markup annotations may have an author-specific state associated with them. The state is not specified in the annotation itself but in a separate text annotation that refers to the original annotation. When a note annotation represents a state annotation, this note annotation will not be displayed individually.
[in] | stateModel | The state model. It should be one of following values:
|
[in] | index | The index of a state annotation to be got. Range: 0 to (stateCount-1). stateCount is returned by function IMarkup::CountStates. |
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, and Foxit::PDF::Annotations::Markup.
String ^ Foxit::PDF::Annotations::IMarkup::GetSubject | ( | ) |
Get subject string.
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, and Foxit::PDF::Annotations::Markup.
String ^ Foxit::PDF::Annotations::IMarkup::GetTitle | ( | ) |
Get title string.
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, and Foxit::PDF::Annotations::Markup.
Boolean Foxit::PDF::Annotations::IMarkup::IsGrouped | ( | ) |
Check whether current markup annotation is in a group or not.
Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.
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, and Foxit::PDF::Annotations::Markup.
Boolean Foxit::PDF::Annotations::IMarkup::RemoveAllReplies | ( | ) |
Remove all the reply annotations.
Markup annotations may have several reply annotations which are represented by note annotations. Usually, viewer applications should not display reply annotations individually but together in the form of threaded comments.
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, and Foxit::PDF::Annotations::Markup.
Boolean Foxit::PDF::Annotations::IMarkup::RemoveAllStates | ( | ) |
Remove all the state annotations.
Markup annotations may have an author-specific state associated with them. The state is not specified in the annotation itself but in a separate text annotation that refers to the original annotation. When a note annotation represents a state annotation, this note annotation will not be displayed individually.
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, and Foxit::PDF::Annotations::Markup.
Boolean Foxit::PDF::Annotations::IMarkup::RemoveReply | ( | Int32 | index | ) |
Remove a reply annotation by index.
Markup annotations may have several reply annotations which are represented by note annotations. Usually, viewer applications should not display reply annotations individually but together in the form of threaded comments.
[in] | index | Index of the replay annotation to be got. Range: 0 to (replyCount-1). replyCount is returned by function IMarkup::CountReplies. |
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, and Foxit::PDF::Annotations::Markup.
void Foxit::PDF::Annotations::IMarkup::SetCreationTime | ( | DateTime^ | creationTime | ) |
Set the creation time.
[in] | creationTime | A Foxit::DateTime object that specifies the new creation 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, and Foxit::PDF::Annotations::Markup.
void Foxit::PDF::Annotations::IMarkup::SetIntent | ( | String^ | intent | ) |
Set intent name.
Intent name is a name describing the intent of the markup annotation. Intents allow viewer applications to distinguish between different uses and behaviors of a single markup annotation type. If this property string is not present or its value is the same as the annotation type, the annotation has no explicit intent and should behave in a generic manner in a viewer application.
[in] | intent | A String object that specifies the new intent name to be set. It should not be either nullptr or empty. Free text, line, polygon and polyline annotations have predefined intent names. Please refer to comment of following functions 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, and Foxit::PDF::Annotations::Markup.
void Foxit::PDF::Annotations::IMarkup::SetOpacity | ( | float | opacity | ) |
Set opacity value.
[in] | opacity | New opacity value to be set. Valid range is from 0.0 to 1.0. |
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, and Foxit::PDF::Annotations::Markup.
void Foxit::PDF::Annotations::IMarkup::SetSubject | ( | String^ | subject | ) |
Set subject string.
[in] | subject | A String object that specifies the new title string 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, and Foxit::PDF::Annotations::Markup.
void Foxit::PDF::Annotations::IMarkup::SetTitle | ( | String^ | title | ) |
Set title string.
[in] | title | A String object that specifies the new title string 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, and Foxit::PDF::Annotations::Markup.
Boolean Foxit::PDF::Annotations::IMarkup::Ungroup | ( | ) |
Ungroup current markup annotation from the group it belongs to.
Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.
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, and Foxit::PDF::Annotations::Markup.