Class to represents strikout annotation. More...
Inherits Foxit::PDF::Annotations::ITextMarkup.
Public Member Functions | |
virtual Boolean | IsMarkup () |
Check if current annotation is a markup annotation. More... | |
virtual AnnotType | GetType () |
Get the type of current annotation. More... | |
virtual String^ | GetContents () |
Get the contents data. More... | |
virtual void | SetContents (String^ content) |
Set the contents data. More... | |
virtual DateTime^ | GetModifiedTime () |
Get the last modification time. More... | |
virtual void | SetModifiedTime (DateTime^ modifiedTime) |
Set the last modification time. More... | |
virtual UInt32 | GetFlags () |
Get annotation flags. More... | |
virtual void | SetFlags (UInt32 flags) |
Set annotation flags. More... | |
virtual String^ | GetName () |
Get annotation name string. More... | |
virtual void | SetName (String^ name) |
Get annotation name string. More... | |
virtual RectF^ | GetRect () |
Get rectangle value. More... | |
virtual Boolean | Move (RectF^ rect) |
Move current annotation to a new position specified by a rectangle. More... | |
virtual BorderInfo^ | GetBorderInfo () |
Get border information. More... | |
virtual void | SetBorderInfo (BorderInfo^ border) |
Set border information. More... | |
virtual String^ | GetTitle () |
Get title string. More... | |
virtual void | SetTitle (String^ title) |
Set title string. More... | |
virtual String^ | GetSubject () |
Get subject string. More... | |
virtual void | SetSubject (String^ subject) |
Set subject string. More... | |
virtual float | GetOpacity () |
Get opacity value. More... | |
virtual void | SetOpacity (float opacity) |
Set opacity value. More... | |
virtual String^ | GetIntent () |
Get intent name. More... | |
virtual void | SetIntent (String^ intent) |
Set intent name. More... | |
virtual DateTime^ | GetCreationTime () |
Get creation time. More... | |
virtual void | SetCreationTime (DateTime^ creationTime) |
Set the creation time. More... | |
virtual Popup^ | GetPopup () |
Get related pop-up annotation. More... | |
virtual Int32 | CountStates (Int32 stateModel) |
Count state annotations with specific state model, related to current markup annotation. More... | |
virtual Note^ | GetState (Int32 stateModel, Int32 index) |
Get a state annoation with specific state model, related to current markup annotation. More... | |
virtual Note^ | AddState (State state) |
Add a new state annotation. More... | |
virtual Boolean | RemoveAllStates () |
Remove all the state annotations. More... | |
virtual Int32 | CountReplies () |
Count reply annotations. More... | |
virtual Note^ | GetReply (Int32 index) |
Get a reply annotation by index. More... | |
virtual Note^ | AddReply () |
Add a reply annotation to the end of reply annotation list. More... | |
virtual Boolean | RemoveReply (Int32 index) |
Remove a reply annotation by index. More... | |
virtual Boolean | RemoveAllReplies () |
Remove all the reply annotations. More... | |
virtual Boolean | IsGrouped () |
Check whether current markup annotation is in a group or not. More... | |
virtual IMarkup^ | GetGroupHeader () |
Get the header annotation (as primary annotation) of the group which current markup annotation belongs to. More... | |
virtual List< IMarkup^ >^ | GetGroupElements () |
Get all the markup annotations (including current one) in the group which current markup annotation belongs to. More... | |
virtual Boolean | Ungroup () |
Ungroup current markup annotation from the group it belongs to. More... | |
virtual List< PointF^ >^ | GetQuadPoints () |
Get quadrilaterals points. More... | |
virtual void | SetQuadPoints (const List< PointF^ >^quadPoints) |
Set quadrilaterals points. More... | |
Boolean | ResetApppearanceStream () |
Reset(regenerate) the appearance stream. 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. | |
Class to represents strikout annotation.
Strike out annotation is a kind of text markup annotation and it is used to draw a line to strike text out.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
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. |
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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:
|
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Get border information.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get creation time.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Get annotation flags.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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:
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Get the last modification time.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get annotation name string.
The annotation name, a text string uniquely identifying it among all the annotations on its page.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Get opacity value.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Get quadrilaterals points.
The order of points of a quadrilateral should be as follows:
(x1, y1) (x2, y2) ---------------- | | | | ---------------- (x3, y3) (x4, y4)
Implements Foxit::PDF::Annotations::ITextMarkup.
|
virtual |
Get rectangle value.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Get subject string.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Get title string.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Get the type of current annotation.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Check if current annotation is a markup annotation.
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IMarkup.
Boolean Foxit::PDF::Annotations::StrikeOut::ResetApppearanceStream | ( | ) |
Reset(regenerate) the appearance stream.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Set annotation flags.
[in] | flags | Value of flags. Please refer to enumeration Annotations::Flags and this can be one or combination of its values. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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:
|
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
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. |
Implements Foxit::PDF::Annotations::IAnnot.
|
virtual |
Set opacity value.
[in] | opacity | New opacity value to be set. Valid range is from 0.0 to 1.0. |
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Set quadrilaterals points.
The order of points of a quadrilateral should be as follows:
(x1, y1) (x2, y2) ---------------- | | | | ---------------- (x3, y3) (x4, y4)
[in] | quadPoints | A point array that specifies the new quadrilaterals points. The count of this array should be above 0 and a multiple of 4. |
Implements Foxit::PDF::Annotations::ITextMarkup.
|
virtual |
Set subject string.
[in] | subject | A String object that specifies the new title string to be set. It can be nullptr or empty. |
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
Set title string.
[in] | title | A String object that specifies the new title string to be set. It can be nullptr or empty. |
Implements Foxit::PDF::Annotations::IMarkup.
|
virtual |
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.
Implements Foxit::PDF::Annotations::IMarkup.