ComPDFKit Web SDK
    Preparing search index...

    Class FileAttachmentCreateTool

    Base class for objects that fire named events. Listener arguments are passed by position.

    Hierarchy (View Summary)

    • Tool
      • FileAttachmentCreateTool
    Index
    • get ALLOW_ANNOTS_OUTSIDE_PAGE(): boolean

      Whether annotations can be dragged outside the page (off by default: dragging stops at the page edge and does not move in a direction where the annotation is larger than the page).

      Returns boolean

    • set ALLOW_ANNOTS_OUTSIDE_PAGE(allow: boolean): void

      Whether annotations can be dragged outside the page (off by default: dragging stops at the page edge and does not move in a direction where the annotation is larger than the page).

      Parameters

      • allow: boolean

      Returns void

    • Adds a listener for an event. Adding the same function twice for one event has no effect.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K

        Event name.

      • fn: (...args: ToolEvents[K]) => void

        Listener, called with the event arguments.

      • Optionaloptions: { once?: boolean }

        Listener options.

        • Optionalonce?: boolean

          When true, the listener is removed after it runs once.

      Returns void

    • Allows annotations to be dragged outside the page (sets ALLOW_ANNOTS_OUTSIDE_PAGE to true).

      Returns void

    • Called when the context menu is requested on the viewer; does nothing in the base class.

      Parameters

      • _e: MouseEvent

        The mouse event.

      Returns void

    • Turns off hover cursors: the tool's own cursor is always used (sets ENABLE_ANNOTATION_HOVER_CURSORS to false).

      Returns void

    • Turns off automatic text selection by the edit tool (sets ENABLE_AUTO_SWITCH to false).

      Returns void

    • Keeps dragged annotations inside the page (sets ALLOW_ANNOTS_OUTSIDE_PAGE to false; the default).

      Returns void

    • Turns on hover cursors (sets ENABLE_ANNOTATION_HOVER_CURSORS to true).

      Returns void

    • Turns on automatic text selection by the edit tool (sets ENABLE_AUTO_SWITCH to true).

      Returns void

    • Viewport event → the page and page coordinates under the pointer (unrotated page, top-left origin, pt).

      Parameters

      • e: Pick<MouseEvent, "clientX" | "clientY">

      Returns MouseLocation

    • Called when a key is pressed while the viewer has focus; does nothing in the base class.

      Parameters

      • _e: KeyboardEvent

        The keyboard event.

      Returns void

    • Called on a double-click in the viewer; does nothing in the base class.

      Parameters

      • _e: MouseEvent

        The mouse event.

      Returns void

    • Called when the left mouse button or a touch goes down on the viewer; does nothing in the base class.

      Parameters

      • e: PointerEvent

      Returns void

    • Called when the left mouse button or a touch is released; does nothing in the base class.

      Parameters

      • _e: PointerEvent

        The pointer event.

      Returns void

    • Called when the pointer moves over the viewer; does nothing in the base class.

      Parameters

      • _e: PointerEvent

        The pointer event.

      Returns void

    • Called when the right mouse button goes down on the viewer; does nothing in the base class.

      Parameters

      • _e: PointerEvent

        The pointer event.

      Returns void

    • Removes a listener, or every listener of the event when fn is omitted.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K

        Event name.

      • Optionalfn: (...args: ToolEvents[K]) => void

        The function that was passed to addEventListener.

      Returns void

    • Sets the name of the tool.

      Parameters

      • name: string

        The tool name.

      Returns void

    • Changes the tool's default style (used by annotations created afterwards); fires toolUpdated.

      Parameters

      • styles: Record<string, unknown>

      Returns void

      const { documentViewer, Annotations, Tools } = instance.Core;
      const freeTextTool = documentViewer.getTool(Tools.ToolNames.FREETEXT);
      freeTextTool.setStyles({ TextColor: new Annotations.Color(0, 0, 0), FontSize: '14pt', Font: 'Helvetica' });
      documentViewer.getTool(Tools.ToolNames.HIGHLIGHT).setStyles({ StrokeColor: new Annotations.Color(0, 255, 0), Opacity: 0.6 });
    • The hover cursor is off while placing an attachment.

      Parameters

      • OptionaloldTool: Tool

      Returns void

    • Switch out: the cursor returns to default.

      Parameters

      • OptionalnewTool: Tool

      Returns void

    • Called on a tap (a touch press and release without moving); does nothing in the base class.

      Parameters

      • _e: PointerEvent

        The pointer event.

      Returns void

    • A listener that throws does not affect the others; the error is reported through logger.error.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K
      • Optionalargs: ToolEvents[K]

      Returns void

    • Like trigger, but awaits the Promise returned by each listener in turn; a failing listener does not affect the others.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K
      • Optionalargs: ToolEvents[K]

      Returns Promise<void>

    ACCEPTED_FILE_SIZE: number | null

    Maximum file size in bytes; larger files fire fileRejected. null means no limit.

    ACCEPTED_FILE_TYPES: string | null

    File types accepted by the file picker (its accept attribute); null accepts all files.

    cursor: string

    The tool's own cursor: used when switching in and when hovering over empty space (default for the edit tool, crosshair for creation tools, text for text tools, grab for pan...).

    defaults: Record<string, unknown>

    Default style of annotations created by the tool (such as StrokeColor, StrokeThickness, Opacity); changed with setStyles.

    ENABLE_ANNOTATION_HOVER_CURSORS: boolean

    Changes the cursor on hover by what is under the pointer (annotations, handles, text); the stamp, attachment, eraser and marquee zoom tools turn it off, and it is turned back on when they switch out (Tool.ENABLE_ANNOTATION_HOVER_CURSORS).

    ENABLE_AUTO_SWITCH: boolean

    Whether the edit tool selects text automatically when hovering over text (the edit tool selects text itself, so when this is off it neither selects text nor shows the text cursor; the instance enable / disableTextSelection must also be on). Turned off on touch screens.

    Events: {
        ANNOTATION_ADDED: "annotationAdded";
        ANNOTATION_CREATED: "annotationCreated";
        FILE_REJECTED: "fileRejected";
    }

    Event names of the file attachment tool.

    Type Declaration

    • ReadonlyANNOTATION_ADDED: "annotationAdded"

      'annotationAdded': a file attachment annotation was added to the document.

    • ReadonlyANNOTATION_CREATED: "annotationCreated"

      'annotationCreated': a file attachment annotation was created.

    • ReadonlyFILE_REJECTED: "fileRejected"

      'fileRejected': the picked file is larger than ACCEPTED_FILE_SIZE.

    name: string

    Name the tool is registered under (one of ToolNames).