GemBox.PdfViewer
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    @gembox/pdfviewer Namespace

    Classes

    Annotations

    Provides functionality for managing and interacting with PDF annotations.

    BasicButtonUI

    Represents a basic button component that can emit events and be clicked.

    DigitalSignatureUI

    Represents the digital signature panel in the PDF viewer's side panel.

    DigitalSigning

    Provides functionality for digitally signing PDF documents.

    DownloadButtonUI

    Represents a download button in the PDF viewer toolbar that allows users to download the current document.

    ESignatureUI

    Represents the e-signature element in the PDF viewer's side panel.

    Features

    Provides access to various features available in the PDF viewer.

    FreeText
    FreeTextUI

    Represents the free text annotation component in the PDF viewer's toolbar.

    GemBoxPdfViewer

    Represents the main PDF viewer class that provides functionality for displaying and interacting with PDF documents.

    HandDrawingUI

    Represents the hand drawing annotation component in the PDF viewer's toolbar.

    NextPageButtonUI

    Represents a button in the PDF viewer toolbar that navigates to the next page of the document.

    NextSearchButtonUI

    Represents a button in the PDF viewer toolbar that navigates to the next search match.

    OpenButtonUI

    Represents a button in the PDF viewer toolbar that opens file dialog for loading PDF documents.

    PageNavigation

    Provides functionality for managing and navigating through pages in a PDF document.

    PageNavigationFieldUI

    Represents a field in the PDF viewer toolbar that allows users to navigate to specific pages by entering page numbers.

    PageNavigationUI

    Represents page navigation controls for the viewer toolbar.

    PanModeButtonUI

    Represents a button in the PDF viewer toolbar that enables pan mode for document navigation.

    PreviousPageButtonUI

    Represents a button in the PDF viewer toolbar that navigates to the previous page of the document.

    PreviousSearchButtonUI

    Represents a button in the PDF viewer toolbar that navigates to the previous search match.

    PrintButtonUI

    Represents a button in the PDF viewer toolbar that allows users to print the current document.

    Search

    Provides search functionality for finding text within PDF documents.

    SearchFieldUI

    Represents a field in the PDF viewer toolbar that allows users to search for text within documents.

    SearchUI

    Represents search controls for the viewer toolbar.

    SidePanelButtonUI

    Represents a button that toggles the visibility of the side panel in the PDF viewer.

    SidePanelUI

    Represents the side panel component of the PDF viewer.

    SignatureButtonUI

    Represents a button in the PDF viewer toolbar that opens the signature panel for digital signing and e-signature.

    TextSelectionButtonUI

    Represents a button in the PDF viewer toolbar that enables text selection mode.

    ToolbarUI

    Represents the toolbar component in the PDF viewer that contains various buttons and controls for document interaction.

    UI

    Provides access to user interface components and configuration options for the PDF viewer.

    Zoom

    Provides zoom functionality for the PDF viewer.

    ZoomDropdownUI

    Represents a dropdown in the PDF viewer toolbar that allows users to select different zoom levels.

    ZoomInButtonUI

    Represents a button in the PDF viewer toolbar that increases the magnification level of the document view.

    ZoomOutButtonUI

    Represents a button in the PDF viewer toolbar that decreases the magnification level of the document view.

    ZoomUI

    Represents zoom controls for the viewer toolbar.

    Interfaces

    Annotation

    Represents an annotation in a PDF document.

    AnnotationCreatedEvent

    Represents an event that is emitted when a new annotation has been successfully created.

    AnnotationCreatingEvent

    Represents an event that is emitted when a new annotation is being created.

    AnnotationEventMap

    AnnotationEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    AnnotationOptions

    Represents options for creating or modifying an annotation.

    ButtonClickingEvent

    Represents an event that is emitted when a button is clicked.

    ButtonEventMap

    ButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    DigitallySignedEvent

    Represents an event that is emitted when a digital signing operation completes successfully.

    DigitalSignatureUIOptions

    Represents the configuration options for the digital signature panel in the PDF viewer.

    DigitalSigningEvent

    Represents an event that is emitted when a digital signing operation is initiated.

    DigitalSigningEventMap

    DigitalSigningEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    DigitalSigningOptions

    Represents options for digital signing functionality in the PDF viewer.

    DownloadButtonUIOptions

    Represents options for configuring the download button in the PDF viewer.

    DropdownValues

    Represents the available values that can be displayed in dropdown menus for zoom options.

    ESignatureUIOptions

    Represents options for configuring the electronic signature feature in the PDF viewer.

    EventElement

    An event-emitting interface that allows for type-safe event handling.

    FeaturesOptions

    Represents the configuration options for various features available in the PDF viewer.

    FreeTextUIOptions

    Represents options for configuring the free text annotation feature in the PDF viewer.

    HandDrawingUIOptions

    Represents options for configuring the hand drawing annotation feature in the PDF viewer.

    NestedMessages

    Represents nested message structures where each key can map to either a string or another nested messages object.

    OpenButtonUIOptions

    Represents options for configuring the open button in the PDF viewer.

    PageChangingEvent

    Event triggered when changing pages in a PDF document.

    PageEventMap

    PageEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    PageInputChangedEvent

    Represents an event that is fired when the input value has changed and page navigation occurs.

    PageInputChangingEvent

    Represents an event that is fired when the input value is about to change.

    PageNavigationFieldEventMap

    PageNavigationFieldEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    PageNavigationUIOptions

    Represents options for configuring the page navigation controls in the PDF viewer.

    PanModeButtonUIOptions

    Represents options for configuring the pan mode button in the PDF viewer.

    PrintButtonUIOptions

    Represents options for configuring the print button in the PDF viewer.

    QueryChangedEvent

    Represents an event that is fired when the search query has changed and text searching occurs.

    QueryChangingEvent

    Represents an event that is fired when the search query is about to change.

    SearchCancelledEvent

    Event emitted when a search operation is cancelled.

    SearchCompletedEvent

    Event emitted when a search operation completes.

    SearchEventMap

    SearchEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    SearchFieldEventMap

    SearchFieldEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    SearchStartingEvent

    Event emitted when a search operation is starting.

    SearchUIOptions

    Represents options for configuring the search functionality in the PDF viewer.

    SidePanelButtonUIOptions

    Represents options for configuring the side panel button in the PDF viewer.

    SidePanelUIOptions

    Represents configuration options for the side panel in the PDF viewer.

    SignatureButtonUIOptions

    Represents options for configuring the signature button in the PDF viewer toolbar.

    TextSelectionButtonUIOptions

    Represents options for configuring the text selection button in the PDF viewer toolbar.

    Theme

    Represents the available theme options for the PDF viewer UI.

    ToolbarUIOptions

    Configuration options for the toolbar in the PDF viewer.

    UIOptions

    Options for configuring the user interface of the PDF viewer.

    ValueChangedEvent

    Represents an event that is fired when the zoom level has changed and been applied.

    ValueChangingEvent

    Represents an event that is fired when the zoom level is about to change.

    ViewerEvent

    Represents a base event interface for the PDF viewer that provides functionality similar to the standard DOM Event interface, allowing events to be canceled.

    ViewerOptions

    Represents the configuration options for the PDF viewer.

    VisibilityElement

    Represents an element that supports visibility capabilities.

    VisibilityOption

    Represents options for controlling the visibility of PDF viewer elements.

    ZoomChangedEvent

    Represents an event that is emitted when the zoom level has changed.

    ZoomChangingEvent

    Represents an event that is emitted when the zoom level is about to change.

    ZoomDropdownEventMap

    ZoomDropdownEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    ZoomEventMap

    ZoomEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    ZoomInButtonEventMap

    ZoomInButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    ZoomInClickEvent

    Represents an event that is fired when the zoom in button is clicked.

    ZoomLevel

    Represents the zoom level that can be applied to the PDF viewer.

    ZoomOutButtonEventMap

    ZoomOutButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    ZoomOutClickEvent

    Represents an event that is fired when the zoom out button is clicked.

    ZoomUIOptions

    Represents options for configuring the zoom controls in the PDF viewer.

    Enums

    AnnotationType

    Represents the types of annotations that can be added to a PDF document.

    CursorMode

    Defines the cursor modes available in the PDF viewer.

    SidePanelType

    Represents the different types of panels that can be displayed in the side panel.

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.