|
| getAdditionalAction () |
| Retrives the additional action object. More...
|
|
| getAlignment () |
| Retrieves the text alignment of a widget in a PDF form. More...
|
|
| getDefaultAppearance () |
| Retrieves the default appearance of the form widget. More...
|
|
| getDirectionRTL () |
| Retrieves the text direction of a widget in a PDF form. More...
|
|
| getExportValue () |
| Retrieves the export value of the form widget. The export value is typically used for checkboxes and radio buttons. More...
|
|
| getField () |
| Retrieves the PDFFormField object associated with the widget. More...
|
|
| getFont () |
| Retrieves the font of the form widget. More...
|
|
| getHighlightingMode () |
| Retrieves the highlighting mode of the widget Highlighting mode is the visual effect to be used when the mouse button is pressed or held down inside its active area. More...
|
|
| getIconCaptionRelation () |
| Retrieves the relation of the icon and caption of the form widget. More...
|
|
| getIconFitOptions () |
| Retrieves the icon fit options of the form widget. More...
|
|
| getMKBorderColor () |
| Retrieves the border color of the form widget. More...
|
|
| getMKCaptionOptions () |
| Retrieves the caption options of the form widget. More...
|
|
| getMKFillColor () |
| Retrieves the fill color of the form widget. More...
|
|
async | getMKIcon (state:WidgetGestureState) |
| Retrieves the icon of the form widget in a given state. More...
|
|
| getMKIconOptions () |
| Retrieves the icon options of the form widget. More...
|
|
| getNormalCaption () |
| Retrieves the normal caption of the (push button/checkbox/radio button) widget. More...
|
|
| getPage () |
| Retrieves the PDF page associated with the widget. More...
|
|
| getRotation () |
| Retrieves the rotation of the form widget. More...
|
|
| getTextColor () |
| Retrieves the text color of the form widget. More...
|
|
| getTextSize () |
| Retrieves the text size of the form widget. More...
|
|
| getWidgetId () |
| Retrieves the unique identifier of the form widget. This method is an alias for the Annot.getAnnotId method. It provides the same unique identifier used for annotations. More...
|
|
async | removeMKIcon (state:WidgetGestureState) |
| Removes the icon of the form widget in a given state. More...
|
|
async | setAlignment (alignment:TextWidgetAlignment) |
| Sets the text alignment of a widget in a PDF form. More...
|
|
| setDefaultAppearance (appearance:Partial<{ textColor:number;textSize:number;fontName:string;}>) |
| Sets the default appearance of the form widget. More...
|
|
async | setDirectionRTL (direction:FormWidgetDirection) |
| Sets the text direction of a widget in a PDF form. More...
|
|
| setExportValue (value:string) |
| Sets the export value of the form widget(checkbox/radio button). More...
|
|
| setFontName (fontName:string) |
| Sets the font name of the form widget. More...
|
|
async | setHighlightingMode (mode:HighlightingMode) |
| Sets the highlighting mode of the form widget. More...
|
|
async | setIconCaptionRelation (relation:WidgetIconCaptionRelation) |
| Sets the relation of the icon and caption of the form widget. More...
|
|
| setIconFitOptions (options:MKIconFitOptions) |
| Sets the options for fitting icons to the widget bounds. More...
|
|
| setMKBorderColor (color:number|undefined) |
| Sets the border color of the form widget. More...
|
|
async | setMKCaption (state:WidgetGestureState, caption:string) |
| Sets the caption of the form widget in a given state. More...
|
|
| setMKFillColor (color:number|undefined) |
| Sets the fill color of the form widget. More...
|
|
async | setMKIcon (state:WidgetGestureState, buffer:ArrayBuffer) |
| Sets the icon of the form widget in a given state. More...
|
|
| setNormalCaption (caption:string='') |
| Sets the normal caption of the (push button/checkbox/radio button) widget. More...
|
|
async | setRotation (rotation:FormWidgetRotation) |
| Sets the rotation of the form widget. More...
|
|
| setTextColor (textColor:number) |
| Sets the text color of the form widget. More...
|
|
| setTextSize (textSize:number) |
| Sets the text size of the form widget. More...
|
|
| appendAction (actionSpec) |
| Appends a action to the annotation. This function cannot be used to append action which is used as additional action. More...
|
|
| exportToJSON () |
| Export the current annotation to a Json object. [Support in Server] More...
|
|
| getActionData () |
| Retrieves the action associated with this annotation. This function cannot be used to get action which is used as additional action. More...
|
|
| getAllActionData () |
| Gets all action data associated with the annotation. This method retrieves all action data including both primary and additional actions of the annotation. The action will be grouped by action trigger type: ActionTriggerEvents.ANNOT_MOUSE_BUTTON_RELEASED. More...
|
|
| getAnnotId () |
| Retrieves the unique identifier of the annotation. The identifier consists of two components: the page index and the object number, which together ensure the annotation's uniqueness within the document. More...
|
|
| getBorderColor () |
| Get annotation's border color. [Support in Server] More...
|
|
| getBorderInfo () |
| Get annotation's border information. [Support in Server] More...
|
|
| getBorderStyle () |
| Get annotation's border style. More...
|
|
| getContent () |
| Get annotation's contents. [Support in Server] More...
|
|
| getDictionaryEntry (key) |
| Get the dictionary property of Annot by key. More...
|
|
| getFlags () |
| Get annotation's flag. [Support in Server] More...
|
|
| getModifiedDateTime () |
| Get annotation's last modified date time. [Support in Server] More...
|
|
| getObjectNumber () |
| Get annotation's object number. More...
|
|
| getPage () |
| Get annotation's page. [Support in Server] More...
|
|
| getRect () |
| Get annotation's rect. [Support in Server] More...
|
|
| getTitle () |
| Get annotation's title. [Support in Server] More...
|
|
| getType () |
| Get annotation's type. [Support in Server] More...
|
|
| getUniqueID () |
| Get annotation's unique ID. [Support in Server] More...
|
|
| isEmpty () |
| Check annotation is empty or not. [Support in Server] More...
|
|
| isMarkup () |
| Check if current annotation is a markup annotation. [Support in Server] More...
|
|
| removeAction (actionObjNumber) |
| Removes a action from the annotation. This function cannot be used to remove action which is used as additional action. More...
|
|
| setAction (actionSpec) |
| Set the action for the annotation. This function cannot be used to set action which is used as additional action. More...
|
|
| setBorderColor (borderColor) |
| Set annotation's border color. [Support in Server] More...
|
|
| setBorderInfo (borderInfo) |
| Set annotation's border information. [Support in Server] More...
|
|
| setBorderStyle (borderStyle, styleParam) |
| Set annotation's border style. More...
|
|
| setContent (content) |
| Set contents for the currently gotten annotation. [Support in Server] More...
|
|
| setCustomAPStream (appearanceType, appearanceStream) |
|
| setDictionaryEntry (key, value) |
| Add a new entry or replace the existing entry of the annotation dictionary. Caller could use this method to store their private data to the annotation. Do not use any standard key of the annotation dictionary, such as 'Type', 'Subtype', 'Rect' defined in PDF Reference. If any standard key is used, this behaviour will be undefined. More...
|
|
| setFlags (flag, notTriggerEvent) |
| Set annotation's flag. [Support in Server] More...
|
|
| setModifiedDateTime (date) |
| Set annotation's last modified date time. [Support in Server] More...
|
|
| setRect (rect) |
| Set annotation's rect. More...
|
|
| supportsAction () |
| This method checks the annotation type and returns true if the type is screen, link or sound annotation, Indicating that are supports actions. For other types of annotation, it returns false. More...
|
|
| updateAction (actionObjNumber, actionData) |
| Updates an existing action in the annotation. This function cannot be used to update action which is used as additional action. More...
|
|
| addDestroyHook (...hooks) |
| Add a function to destroyHooks list, which will be called during destroy. More...
|
|
| destroy () |
|
| ownsTo (owner) |
| Establishes an ownership relationship where this instance will be destroyed when the owner is destroyed. Additionally, the owner will be automatically removed from the destroyHooks list when this instance is destroyed. More...
|
|
A class that represents a form widget in a PDF document.
- Since
- 11.0.0