Foxit::PDF::Annotations::Popup Class Reference

Class to represent pop-up annotation. More...

Inherits Foxit::PDF::Annotations::IAnnot.

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...
 
Boolean GetOpenStatus ()
 Get the open status. More...
 
void SetOpenStatus (Boolean status)
 Set the open status. 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 pop-up annotation.

A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. It typically does not appear alone but is associated with a markup annotation, its parent annotation, and is used for editing the parent’s text. It has no appearance stream or associated actions of its own.

Member Function Documentation

virtual BorderInfo ^ Foxit::PDF::Annotations::Popup::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::Popup::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 UInt32 Foxit::PDF::Annotations::Popup::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 DateTime ^ Foxit::PDF::Annotations::Popup::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::Popup::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.

Boolean Foxit::PDF::Annotations::Popup::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 RectF ^ Foxit::PDF::Annotations::Popup::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 AnnotType Foxit::PDF::Annotations::Popup::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::Popup::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::Popup::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 void Foxit::PDF::Annotations::Popup::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::Popup::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::Popup::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.

virtual void Foxit::PDF::Annotations::Popup::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::Popup::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.

void Foxit::PDF::Annotations::Popup::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.

Foxit Corporation