Foxit::PDF::Annotations::ITextMarkup Interface Reference

Interface class to define basic method of text markup annotation. More...

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

Inherited by Foxit::PDF::Annotations::Highlight, Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, and Foxit::PDF::Annotations::Underline.

Public Member Functions

Array< PointF^ >^ GetQuadPoints ()
 Get quadrilaterals points. More...
 
void SetQuadPoints (const Array< PointF^ >^quadPoints)
 Set quadrilaterals points. More...
 
- Public Member Functions inherited from Foxit::PDF::Annotations::IMarkup
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...
 
float32 GetOpacity ()
 Get opacity value. More...
 
void SetOpacity (float32 opacity)
 Set opacity value. More...
 
String^ GetIntent ()
 Get intent name. More...
 
void SetIntent (String^ intent)
 Set intent name. More...
 
DateTimeGetCreationTime ()
 Get creation time. More...
 
void SetCreationTime (DateTime^ creationTime)
 Set the creation time. More...
 
PopupGetPopup ()
 Get related pop-up annotation. More...
 
int32 CountStates (int32 stateModel)
 Count state annotations with specific state model, related to current markup annotation. More...
 
NoteGetState (int32 stateModel, int32 index)
 Get a state annoation with specific state model, related to current markup annotation. More...
 
NoteAddState (State state)
 Add a new state annotation. More...
 
Boolean RemoveAllStates ()
 Remove all the state annotations. More...
 
int32 CountReplies ()
 Count reply annotations. More...
 
NoteGetReply (int32 index)
 Get a reply annotation by index. More...
 
NoteAddReply ()
 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...
 
IMarkupGetGroupHeader ()
 Get the header annotation (as primary annotation) of the group which current markup annotation belongs to. More...
 
Array< 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...
 
- Public Member Functions inherited from Foxit::PDF::Annotations::IAnnot
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...
 
DateTimeGetModifiedTime ()
 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...
 
RectFGetRect ()
 Get rectangle value. More...
 
Boolean Move (RectF^ rect)
 Move current annotation to a new position specified by a rectangle. More...
 
BorderInfoGetBorderInfo ()
 Get border information. More...
 
void SetBorderInfo (BorderInfo^ border)
 Set border information. 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

Interface class to define basic method of text markup annotation.

Member Function Documentation

Array<PointF^> ^ Foxit::PDF::Annotations::ITextMarkup::GetQuadPoints ( )

Get quadrilaterals points.

The order of points of a quadrilateral should be as follows:

                (x1, y1)           (x2, y2)
                        ----------------
                        |              |
                        |              |
                        ----------------
                (x3, y3)           (x4, y4)
                
Returns
A point array that receives all the quadrilaterals points. The count of this array would be above 0 and a multiple of 4. 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 quadrilaterals points 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.

Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, and Foxit::PDF::Annotations::Highlight.

void Foxit::PDF::Annotations::ITextMarkup::SetQuadPoints ( const Array< PointF^ >^  quadPoints)

Set quadrilaterals points.

The order of points of a quadrilateral should be as follows:

                (x1, y1)           (x2, y2)
                        ----------------
                        |              |
                        |              |
                        ----------------
                (x3, y3)           (x4, y4)
                
Parameters
[in]quadPointsA point array that specifies the new quadrilaterals points. The count of this array should be above 0 and a multiple of 4.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter quadPoints 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.

Implemented in Foxit::PDF::Annotations::Squiggly, Foxit::PDF::Annotations::StrikeOut, Foxit::PDF::Annotations::Underline, and Foxit::PDF::Annotations::Highlight.

Foxit Corporation