Foxit PDF SDK
|
Public Types | |
enum | FillSignObjectType { FillSignObjectType.e_FillSignObjectTypeText = 0, FillSignObjectType.e_FillSignObjectTypeCrossMark = 1, FillSignObjectType.e_FillSignObjectTypeCheckMark = 2, FillSignObjectType.e_FillSignObjectTypeRoundRectangle = 3, FillSignObjectType.e_FillSignObjectTypeLine = 4, FillSignObjectType.e_FillSignObjectTypeDot = 5, FillSignObjectType.e_FillSignObjectTypeSignature = 6, FillSignObjectType.e_FillSignObjectTypeInitialsSignature = 7 } |
Enumeration for fill-sign object type. More... | |
Public Member Functions | |
FillSign (PDFPage page) | |
Constructor, from a PDF page object. More... | |
FillSign (FillSign other) | |
Constructor, with another FillSign object. More... | |
FillSignObject | AddObject (FillSign.FillSignObjectType type, PointF point, float width, float height, Rotation rotation) |
Add a new fill-sign object (except text fill-sign object) to related PDF page (which is used in constructor). More... | |
FillSignObject | AddTextObject (TextFillSignObjectDataArray text_data, PointF point, float width, float height, Rotation rotation, bool is_comb_field_mode) |
Add a new text fill-sign object to related PDF page (which is used in constructor). More... | |
FillSignObject | GetObjectAtDevicePoint (PointF point, Matrix2D matrix) |
Get a fill-sign object by specified point in device coordinate system. More... | |
FillSignObject | GetObjectAtPoint (PointF point) |
Get a fill-sign object by specified point in PDF coordinate system. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | RemoveObject (FillSignObject fillsign_object) |
Remove a specified fill-sign object. More... | |
Fill-sign means to fill some graphics objects to PDF page and sign them. This class is used as a manager for fill-sign objects. User can use this class to add/get/remove fill-sign objects (including cross mark, check mark, dot, line, round rectangle, signature and initials signature) to PDF page.
Enumeration for fill-sign object type.
Values of this enumeration can be used alone.
|
inline |
Constructor, from a PDF page object.
Please ensure input PDF page has been parsed successfully.
[in] | page | A valid PDF page object. |
|
inline |
Constructor, with another FillSign object.
[in] | other | Another object. |
|
inline |
Add a new fill-sign object (except text fill-sign object) to related PDF page (which is used in constructor).
This function can be used to add fill-sign object except type foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeText . If you want to add a fill-sign object with type foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeText , please call function FillSign.AddTextObject instead.
[in] | type | Fill-sign type which is used to specify what kind of fill-sign object is to be added. Please refer to values starting from foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeCrossMark and this should be one of these values. |
[in] | point | Left-bottom point for new fill-sign object, in PDF coordinate system. |
[in] | width | Width for new fill-sign object. |
[in] | height | Height for new fill-sign object. |
[in] | rotation | Rotation status information. This rotation value includes the view rotation and page rotation property information. Please refer to values starting from foxit.common.Rotation.e_Rotation0 and this should be one of these values except foxit.common.Rotation.e_RotationUnknown . |
|
inline |
Add a new text fill-sign object to related PDF page (which is used in constructor).
[in] | text_data | A text data array to be set to new text fill-sign object. For each text fill-sign object data, origin_position of member text_state will not be used. |
[in] | point | Left-bottom point for new fill-sign object, in PDF coordinate system. |
[in] | width | Width for new fill-sign object. |
[in] | height | Height for new fill-sign object. |
[in] | rotation | Rotation status information. This rotation value includes the view rotation and page rotation property information. Please refer to values starting from foxit.common.Rotation.e_Rotation0 and this should be one of these values except foxit.common.Rotation.e_RotationUnknown . |
[in] | is_comb_field_mode | A boolean value to decide whether for comb field mode or normal mode:
|
|
inline |
Get a fill-sign object by specified point in device coordinate system.
After adding the fill-sign object with type foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeSignature or foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeInitialsSignature ,all the existed fill-sign objects which belong to the same PDF document cannot be retrieved.
[in] | point | A specified point in device coordinate system. |
[in] | matrix | A transform matrix from device coordinate system to PDF coordinate system. |
|
inline |
Get a fill-sign object by specified point in PDF coordinate system.
After adding a fill-sign object with type foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeSignature or foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeInitialsSignature , all the existed fill-sign objects which belong to the same PDF document cannot be retrieved.
[in] | point | A specified point in PDF coordinate system. |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Remove a specified fill-sign object.
After adding a fill-sign object with type foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeSignature or foxit.pdf.FillSign.FillSignObjectType.e_FillSignObjectTypeInitialsSignature , all the existed fill-sign objects which belong to the same PDF document cannot be removed. For this case, this function will return false if any existed fill-sign object is to be removed.
[in] | fillsign_object | A fill-sign object to be removed. |