Foxit PDF RDK

Public Member Functions | List of all members
FillSignObject Class Reference
Inheritance diagram for FillSignObject:

## Public Member Functions
| constructor ()
| Constructor.
| GenerateContent ()
| Generate content for current fill-sign object. More...
| GetRect ()
| Get rectangle, in PDF coordinate system. More...
| GetType ()
| Get fill-sign type. More...
| IsEmpty ()
| Check whether current object is empty or not. More...
| Move (point, width, height, rotation)
| Move current fill-sign object. More...
Public Member Functions inherited from NativeObjectWrapper
| constructor (r)
| GetPointerAsNumber ()

## Detailed Description

Class FillSignObject is the base class for all kinds of fill-sign object. This class offers base functions to get type, to move a fill-sign object or to generate content for a fill-sign object.

Examples
  /Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

## Member Function Documentation

## ◆ GenerateContent()

FillSignObject.GenerateContent | ( |  | ) |

Generate content for current fill-sign object.

For fill-sign object with type FillSign.e_FillSignObjectTypeSignature or FillSign.e_FillSignObjectTypeInitialsSignature, function SignatureFillSignObject.SetBitmap should be called first.

Returns
  true means success, while false means failure.

Examples
  /Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

## ◆ GetRect()

FillSignObject.GetRect | ( |  | ) |

Get rectangle, in PDF coordinate system.

Returns
  Fill-sign object rectangle. If there is no rectangle information, a RectF object with all 0 values would be returned.

Examples
  /Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

## ◆ GetType()

FillSignObject.GetType | ( |  | ) |

Get fill-sign type.

Returns
  Fill-sign type. Please refer to values starting from FillSign.e_FillSignObjectTypeText and this would be one of these values.

Examples
  /Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

## ◆ IsEmpty()

FillSignObject.IsEmpty | ( |  | ) |

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
  true means current object is empty, while false means not.

Examples
  /Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

## ◆ Move()

FillSignObject.Move | ( | point | ,
|  | width | ,
|  | height | ,
|  | rotation |
| ) |  |

Move current fill-sign object.

- If to add a fill-sign object with type FillSign.e_FillSignObjectTypeCrossMark, FillSign.e_FillSignObjectTypeCheckMark, FillSign.e_FillSignObjectTypeLine or FillSign.e_FillSignObjectTypeDot, the bigger value of input width and height will be used as both width and height as the moving result.
- If to move a fill-sign object with type FillSign.e_FillSignObjectTypeLine, input height is useless and will be ignored.
- This function does not support to move a fill-sign object with FillSign.e_FillSignObjectTypeSignature or FillSign.e_FillSignObjectTypeInitialsSignature. For this case, exception e_ErrUnsupported will be thrown.

Parameters

  [in] | point | New left-bottom point for current fill-sign object, in PDF coordinate system.
  [in] | width | New width for current fill-sign object.
  [in] | height | New height for current 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 e_Rotation0 and this should be one of these values except e_RotationUnknown.

Returns
  None.

Examples
  /Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.