Foxit::PDF::Annotations::Note Class Reference

Class to represent note annotation. More...

Inherits Foxit::PDF::Annotations::IMarkup.

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 DateTimeGetModifiedTime ()
 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 RectFGetRect ()
 Get rectangle value. More...
 
virtual Boolean Move (RectF^ rect)
 Move current annotation to a new position specified by a rectangle. More...
 
virtual BorderInfoGetBorderInfo ()
 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 float32 GetOpacity ()
 Get opacity value. More...
 
virtual void SetOpacity (float32 opacity)
 Set opacity value. More...
 
virtual String^ GetIntent ()
 Get intent name. More...
 
virtual void SetIntent (String^ intent)
 Set intent name. More...
 
virtual DateTimeGetCreationTime ()
 Get creation time. More...
 
virtual void SetCreationTime (DateTime^ creationTime)
 Set the creation time. More...
 
virtual PopupGetPopup ()
 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 NoteGetState (int32 stateModel, int32 index)
 Get a state annoation with specific state model, related to current markup annotation. More...
 
virtual NoteAddState (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 NoteGetReply (int32 index)
 Get a reply annotation by index. More...
 
virtual NoteAddReply ()
 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 IMarkupGetGroupHeader ()
 Get the header annotation (as primary annotation) of the group which current markup annotation belongs to. More...
 
virtual Array< 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...
 
Boolean GetOpenStatus ()
 Get the open status. More...
 
void SetOpenStatus (Boolean status)
 Set the open status. More...
 
String^ GetIconName ()
 Get icon name. More...
 
void SetIconName (String^ iconName)
 Set icon name. More...
 
State GetStateValue ()
 Get state value. More...
 
void SetStateValue (State state)
 Set state value. More...
 
Boolean ResetApppearanceStream ()
 Reset(regenerate) the appearance stream. More...
 

Additional Inherited Members

- Properties inherited from Foxit::PDF::Annotations::IAnnot
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.
 

Detailed Description

Class to represent note annotation.

Note annotation is just "Text" annotation defined in PDF reference 1.7. A text annotation represents a “sticky note?attached to a point in the PDF document.

Member Function Documentation

virtual Note ^ Foxit::PDF::Annotations::Note::AddReply ( )
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.

Returns
An Annotations::Note object that receives the new reply annotation. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual Note ^ Foxit::PDF::Annotations::Note::AddState ( State  state)
virtual

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.

Parameters
[in]stateState value of the new state annotation. Please refer to enumeration Annotations::State and this should be one of its values.
Returns
An Annotations::Note object that receives the new state annotation. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter state is invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual int32 Foxit::PDF::Annotations::Note::CountReplies ( )
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.

Returns
The count of reply annotations related to current markup annotation.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual int32 Foxit::PDF::Annotations::Note::CountStates ( int32  stateModel)
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.

Parameters
[in]stateModelThe state model. It should be one of following values:
Returns
The count of state with specific state model.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter stateModel is invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual BorderInfo ^ Foxit::PDF::Annotations::Note::GetBorderInfo ( )
virtual

Get border information.

Returns
A Annotations::BorderInfo object that receives the border information value. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no border property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual String ^ Foxit::PDF::Annotations::Note::GetContents ( )
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

Returns
A String object that receives the contents data. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no content data can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual DateTime ^ Foxit::PDF::Annotations::Note::GetCreationTime ( )
virtual

Get creation time.

Returns
A Foxit::DateTime object that receives the creation time data. If the property cannot be found or there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no creation time property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual uint32 Foxit::PDF::Annotations::Note::GetFlags ( )
virtual

Get annotation flags.

Returns
Value of flags. Please refer to enumeration Annotations::Flags and this would be one or combination of its values.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no flags property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual Array<IMarkup^> ^ Foxit::PDF::Annotations::Note::GetGroupElements ( )
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.

Returns
A markup annotation array that receives all the markup annotations in the group. If current annotation does not belong to a group or there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means current annotation does not belong to any group.
ErrorCode::InvalidType means there is any non-markup annotation in the group which current annotation belongs to.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual IMarkup ^ Foxit::PDF::Annotations::Note::GetGroupHeader ( )
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.

Returns
A Annotation::IMarkup object that receives the header annotation of the group which current markup annotation belongs to. If current annotation does not belong to a group or there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no header annotation can be found – that means current markup annotation does not belong to any group.
ErrorCode::InvalidType means the header annotation is not a markup annotation.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

String ^ Foxit::PDF::Annotations::Note::GetIconName ( )

Get icon name.

Returns
A String object that receives the icon name. It may be one of following standard icon names:
"Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow".
If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no icon name property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
virtual String ^ Foxit::PDF::Annotations::Note::GetIntent ( )
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:

Returns
A String object that receives the intent name. If the property cannot be found or there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no intent name property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual DateTime ^ Foxit::PDF::Annotations::Note::GetModifiedTime ( )
virtual

Get the last modification time.

Returns
A Foxit::DateTime object that receives the last modification time. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no modified time data can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual String ^ Foxit::PDF::Annotations::Note::GetName ( )
virtual

Get annotation name string.

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

Returns
A String object that receives the name string. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no name property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual float32 Foxit::PDF::Annotations::Note::GetOpacity ( )
virtual

Get opacity value.

Returns
Opacity value. Valid Range is from 0.0 to 1.0.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no opacity property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

Boolean Foxit::PDF::Annotations::Note::GetOpenStatus ( )

Get the open status.

Open status indicates whether current pop-up annotation should initially be displayed open or closed.

Returns
A boolean value: true means open status is "open", while false means open status is "closed".
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no open status property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
virtual Popup ^ Foxit::PDF::Annotations::Note::GetPopup ( )
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.

Returns
An Annotations::Popup object that receives the related pop-up annotation. If the property cannot be found or there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means current annotation doesn't have a pop-up annotation.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual RectF ^ Foxit::PDF::Annotations::Note::GetRect ( )
virtual

Get rectangle value.

Returns
A Foxit::RectF object that receives the rectangle value. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no rectangle property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual Note ^ Foxit::PDF::Annotations::Note::GetReply ( int32  index)
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.

Parameters
[in]indexIndex of the replay annotation to be got. Range: 0 to (replyCount-1). replyCount is returned by function IMarkup::CountReplies.
Returns
An Annotations::Note object that receives the specified reply annotation. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means parameter index is out of range.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual Note ^ Foxit::PDF::Annotations::Note::GetState ( int32  stateModel,
int32  index 
)
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.

Parameters
[in]stateModelThe state model. It should be one of following values:
[in]indexThe index of a state annotation to be got. Range: 0 to (stateCount-1). stateCount is returned by function IMarkup::CountStates.
Returns
An Annotations::Note object that receives the specified state annotation. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter stateModel is invalid.
ErrorCode::NotFound means parameter index is out of range.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

State Foxit::PDF::Annotations::Note::GetStateValue ( )

Get state value.

State value is meaningful only when current note annotation represents as a state annotation.

Returns
State value. Please refer to enumeration Annotations::State and this would be one of its values.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
virtual String ^ Foxit::PDF::Annotations::Note::GetSubject ( )
virtual

Get subject string.

Returns
A String object that receives the subject string.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no subject property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual String ^ Foxit::PDF::Annotations::Note::GetTitle ( )
virtual

Get title string.

Returns
A String object that receives the title string.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means no title property can be found.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual AnnotType Foxit::PDF::Annotations::Note::GetType ( )
virtual

Get the type of current annotation.

Returns
Annotation type. Please refer to enumeration Annotations::AnnotType and this would be one of its values.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual Boolean Foxit::PDF::Annotations::Note::IsGrouped ( )
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.

Returns
A boolean value: true means current markup annotation is in a group, while false means current markup annotation does not belong to any group.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual Boolean Foxit::PDF::Annotations::Note::IsMarkup ( )
virtual

Check if current annotation is a markup annotation.

Returns
A boolean value: true means current annotation is a markup annotation, while false means current annotation is not a markup annotation.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual Boolean Foxit::PDF::Annotations::Note::Move ( RectF rect)
virtual

Move current annotation to a new position specified by a rectangle.

To move an annotation is to reset its rectangle.

Parameters
[in]rectA 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.
Returns
A boolean value: true means success, while false means failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter rect is invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual Boolean Foxit::PDF::Annotations::Note::RemoveAllReplies ( )
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.

Returns
A boolean value: true means success, while false means failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual Boolean Foxit::PDF::Annotations::Note::RemoveAllStates ( )
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.

Returns
A boolean value: true means success, while false means failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual Boolean Foxit::PDF::Annotations::Note::RemoveReply ( int32  index)
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.

Parameters
[in]indexIndex of the replay annotation to be got. Range: 0 to (replyCount-1). replyCount is returned by function IMarkup::CountReplies.
Returns
A boolean value: true means success, while false means failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means parameter index is out of range.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

Boolean Foxit::PDF::Annotations::Note::ResetApppearanceStream ( )

Reset(regenerate) the appearance stream.

Returns
A boolean value: true means success, while false means error.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::UnknownState means some necessary property of current annotation does not be set correctly.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
virtual void Foxit::PDF::Annotations::Note::SetBorderInfo ( BorderInfo border)
virtual

Set border information.

Parameters
[in]borderAn Annotations::BorderInfo object that specifies the new border information to be set. Please refer to comment of Annotations::BorderInfo for more details.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter border is nullptr or some properties of border is invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual void Foxit::PDF::Annotations::Note::SetContents ( String^  content)
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.

Parameters
[in]contentA String object that specifies the new contents data to be set. It can be nullptr or empty.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual void Foxit::PDF::Annotations::Note::SetCreationTime ( DateTime creationTime)
virtual

Set the creation time.

Parameters
[in]creationTimeA Foxit::DateTime object that specifies the new creation time data to be set. It should be valid and should not be nullptr.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter creationTime is nullptr or invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual void Foxit::PDF::Annotations::Note::SetFlags ( uint32  flags)
virtual

Set annotation flags.

Parameters
[in]flagsValue of flags. Please refer to enumeration Annotations::Flags and this can be one or combination of its values.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

void Foxit::PDF::Annotations::Note::SetIconName ( String^  iconName)

Set icon name.

Parameters
[in]iconNameA String object that specifies the icon name. It could be one of following standard icon names:
"Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow".
Or user can set other additional icon names.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter iconName is nullptr or empty.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
virtual void Foxit::PDF::Annotations::Note::SetIntent ( String^  intent)
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.

Parameters
[in]intentA 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:
Returns
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter intent is nullptr or empty.
ErrorCode::Unsupported, only for line, polygon or polyline annotation, means parameter intent represents a predefined intent name which is not supported currently.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual void Foxit::PDF::Annotations::Note::SetModifiedTime ( DateTime modifiedTime)
virtual

Set the last modification time.

Parameters
[in]modifiedTimeA Foxit::DateTime object that specifies the new last modification time data to be set. It should be valid and should not be nullptr.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter modifiedTime is nullptr or invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual void Foxit::PDF::Annotations::Note::SetName ( String^  name)
virtual

Get annotation name string.

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

Parameters
[in]nameA String object that specifies the new name string. This can be nullptr or empty.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IAnnot.

virtual void Foxit::PDF::Annotations::Note::SetOpacity ( float32  opacity)
virtual

Set opacity value.

Parameters
[in]opacityNew opacity value to be set. Valid range is from 0.0 to 1.0.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter opacity is invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

void Foxit::PDF::Annotations::Note::SetOpenStatus ( Boolean  status)

Set the open status.

Open status indicates whether current pop-up annotation should initially be displayed open or closed.

Parameters
[in]statusA boolean value that specifies the new open status: true means open status is "open", while false means open status is "closed".
Returns
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
void Foxit::PDF::Annotations::Note::SetStateValue ( State  state)

Set state value.

State value is meaningful only when current note annotation represents as a state annotation.

Parameters
[in]stateNew state value. Please refer to enumeration Annotations::State and this should be one of its values.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter state is invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
virtual void Foxit::PDF::Annotations::Note::SetSubject ( String^  subject)
virtual

Set subject string.

Parameters
[in]subjectA String object that specifies the new title string to be set. It can be nullptr or empty.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual void Foxit::PDF::Annotations::Note::SetTitle ( String^  title)
virtual

Set title string.

Parameters
[in]titleA String object that specifies the new title string to be set. It can be nullptr or empty.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

virtual Boolean Foxit::PDF::Annotations::Note::Ungroup ( )
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.

Returns
A boolean value: true means success, while false means failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Implements Foxit::PDF::Annotations::IMarkup.

Foxit Corporation