ASP.NET Core MVC Controls | ComponentOne
In This Topic
    ViewerBase Class
    In This Topic
    File
    wijmo.viewer.js
    Module
    wijmo.viewer
    Base Class
    Control
    Derived Classes
    PdfViewer, ReportViewer
    Implements
    IHttpRequestHandler

    Base class for all the viewer controls.

    Constructor

    Properties

    Methods

    Events

    Constructor

    constructor

    constructor(element: any, options?: any): ViewerBase
    

    Initializes a new instance of the ViewerBase class.

    Parameters
    • element: any

      The DOM element that will host the control, or a CSS selector for the host element (e.g. '#theCtrl').

    • options: any
    Optional

    JavaScript object containing initialization data for the control.

    Returns
    ViewerBase

    Properties

     

    Static controlTemplate

    Gets or sets the template used to instantiate the viewer controls.

    Type
    any

    filePath

    Gets or sets the full path to the document on the server.

    The path starts with the key of a provider which is registered at server for locating specified document.

    Type
    string

    fullScreen

    Gets or sets a value indicating whether the viewer is under full screen mode.

    Type
    boolean

    hostElement

    Gets the DOM element that is hosting the control.

    Inherited From
    Control
    Type
    HTMLElement

    isDisabled

    Gets or sets a value that determines whether the control is disabled.

    Disabled controls cannot get mouse or keyboard events.

    Inherited From
    Control
    Type
    boolean

    isTouching

    Gets a value that indicates whether the control is currently handling a touch event.

    Inherited From
    Control
    Type
    boolean

    isUpdating

    Gets a value that indicates whether the control is currently being updated.

    Inherited From
    Control
    Type
    boolean

    mouseMode

    Gets or sets a value indicating the mouse behavior.

    The default is SelectTool which means clicking and dragging the mouse will select the text.

    Type
    MouseMode

    pageIndex

    Gets the index of the page which is currently displayed in the view panel.

    Type
    number

    requestHeaders

    Gets or sets an object containing request headers to be used when sending or requesting data.

    The most typical use for this property is in scenarios where authentication is required. For example:

    viewer.requestHeaders = {
        Authorization: 'Bearer ' + appAuthService.getToken();
    };
    
    Type
    any

    rightToLeft

    Gets a value indicating whether the control is hosted in an element with right-to-left layout.

    Inherited From
    Control
    Type
    boolean

    serviceUrl

    Gets or sets the address of C1 Web API service.

    For example, http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report

    Type
    string

    tabOrder

    Gets or sets a value of the **tabindex** attribute associated with the control.

    **tabindex** attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.

    Because of this, to read or change control's **tabindex** dynamically, you should do it using this property.

    Inherited From
    Control
    Type
    number

    thresholdWidth

    Gets or sets the threshold to switch between mobile and PC template.

    Default value is 767px. If width of control is smaller than thresholdWidth, mobile template will be applied. If width of control is equal or greater than thresholdWidth, PC template will be applied. If thresholdWidth is set to 0, then only PC template is applied and if it's set to a large number e.g. 9999, then only mobile template is applied.

    Type
    number

    viewMode

    Gets or sets a value indicating how to show the document pages.

    Type
    ViewMode

    zoomFactor

    Gets or sets a value indicating the current zoom factor to show the document pages.

    Type
    number

    zoomMode

    Gets or sets a value indicating the current zoom mode to show the document pages.

    Type
    ZoomMode

    Methods

    addEventListener

    addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
    

    Adds an event listener to an element owned by this Control.

    The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).

    Failing to remove event listeners may cause memory leaks.

    The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.

    For details on passive event listeners, please see Improving scrolling performance with passive listeners.

    Parameters
    • target: EventTarget

      Target element for the event.

    • type: string

      String that specifies the event.

    • fn: any

      Function to execute when the event occurs.

    • capture: boolean
    Optional

    Whether the listener should be handled by the control before it is handled by the target element.

    Indicates that the handler will never call preventDefault().

    Inherited From
    Control
    Returns
    void

    applyTemplate

    applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
    

    Applies the template to a new instance of a control, and returns the root element.

    This method should be called by constructors of templated controls. Therefore, this method is not available. It is responsible for binding the template parts to the corresponding control members.

    For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

    this.applyTemplate('wj-control wj-inputnumber', templateString, {
      _tbx: 'input',
      _btnUp: 'btn-inc',
      _btnDn: 'btn-dec'
    }, 'input');
    
    
    ```

    Parameters
    • classNames: string

      Names of classes to add to the control's host element.

    • template: string

      An HTML string that defines the control template.

    • parts: Object

      A dictionary of part variables and their names.

    • namePart: string Optional

      Name of the part to be named after the host element. This determines how the control submits data when used in forms.

    Inherited From
    Control
    Returns
    HTMLElement

    beginUpdate

    beginUpdate(): void
    

    Suspends notifications until the next call to endUpdate.

    Inherited From
    Control
    Returns
    void

    containsFocus

    containsFocus(): boolean
    

    Checks whether this control contains the focused element.

    Inherited From
    Control
    Returns
    boolean

    deferUpdate

    deferUpdate(fn: Function): void
    

    Executes a function within a beginUpdate/endUpdate block.

    The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.

    Parameters
    Inherited From
    Control
    Returns
    void

    dispose

    dispose(): void
    

    Disposes of the control by removing its association with the host element.

    The dispose method automatically removes any event listeners added with the addEventListener method.

    Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.

    Inherited From
    Control
    Returns
    void

    Static disposeAll

    disposeAll(e?: HTMLElement): void
    

    Disposes of all Wijmo controls contained in an HTML element.

    Parameters
    Inherited From
    Control
    Returns
    void

    endUpdate

    endUpdate(): void
    

    Resumes notifications suspended by calls to beginUpdate.

    Inherited From
    Control
    Returns
    void

    focus

    focus(): void
    

    Sets the focus to this control.

    Inherited From
    Control
    Returns
    void

    Static getControl

    getControl(element: any): Control
    

    Gets the control that is hosted in a given DOM element.

    Parameters
    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Inherited From
    Control
    Returns
    Control

    getTemplate

    getTemplate(): string
    

    Gets the HTML template used to create instances of the control.

    This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).

    Inherited From
    Control
    Returns
    string

    initialize

    initialize(options: any): void
    

    Initializes the control by copying the properties from a given object.

    This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

    For example:

    grid.initialize({
      itemsSource: myList,
      autoGenerateColumns: false,
      columns: [
        { binding: 'id', header: 'Code', width: 130 },
        { binding: 'name', header: 'Name', width: 60 } 
      ]
    });



    // is equivalent to grid.itemsSource = myList; grid.autoGenerateColumns = false; // etc.

    The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.

    Parameters
    • options: any

      Object that contains the initialization data.

    Inherited From
    Control
    Returns
    void

    invalidate

    invalidate(fullUpdate?: boolean): void
    

    Invalidates the control causing an asynchronous refresh.

    Parameters
    • fullUpdate: boolean Optional

      Whether to update the control layout as well as the content.

    Inherited From
    Control
    Returns
    void

    Static invalidateAll

    invalidateAll(e?: HTMLElement): void
    

    Invalidates all Wijmo controls contained in an HTML element.

    Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

    If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.

    Parameters
    • e: HTMLElement Optional

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Inherited From
    Control
    Returns
    void

    moveToPage

    moveToPage(index: number): IPromise
    

    Moves to the page at the specified index.

    Parameters
    • index: number

      Index (0-base) of the page to move to.

    Returns
    IPromise

    onBeforeSendRequest

    onBeforeSendRequest(e: RequestEventArgs): void
    

    Raises the beforeSendRequest event.

    Parameters
    Returns
    void

    onFullScreenChanged

    onFullScreenChanged(e?: EventArgs): void
    

    Raises the fullScreenChanged event.

    Parameters
    Returns
    void

    onGotFocus

    onGotFocus(e?: EventArgs): void
    

    Raises the gotFocus event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onInvalidInput

    onInvalidInput(e: CancelEventArgs): void
    

    Raises the invalidInput event.

    If the event handler cancels the event, the control will keep the invalid input and the focus.

    Parameters
    Inherited From
    Control
    Returns
    void

    onLostFocus

    onLostFocus(e?: EventArgs): void
    

    Raises the lostFocus event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onMouseModeChanged

    onMouseModeChanged(e?: EventArgs): void
    

    Raises the mouseModeChanged event.

    Parameters
    Returns
    void

    onPageIndexChanged

    onPageIndexChanged(e?: EventArgs): void
    

    Raises the pageIndexChanged event.

    Parameters
    Returns
    void

    onPageLoaded

    onPageLoaded(e: PageLoadedEventArgs): void
    

    Raises the pageLoaded event.

    Parameters
    Returns
    void

    onQueryLoadingData

    onQueryLoadingData(e: QueryLoadingDataEventArgs): void
    

    Raises the queryLoadingData event.

    Parameters
    Returns
    void

    onRefreshed

    onRefreshed(e?: EventArgs): void
    

    Raises the refreshed event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onRefreshing

    onRefreshing(e?: EventArgs): void
    

    Raises the refreshing event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onViewModeChanged

    onViewModeChanged(oldValue: ViewMode, newValue: ViewMode): void
    

    Raises the viewModeChanged event.

    Parameters
    Returns
    void

    onZoomFactorChanged

    onZoomFactorChanged(e?: EventArgs): void
    

    Raises the zoomFactorChanged event.

    Parameters
    Returns
    void

    onZoomModeChanged

    onZoomModeChanged(e?: EventArgs): void
    

    Raises the zoomModeChanged event.

    Parameters
    Returns
    void

    refresh

    refresh(fullUpdate?: boolean): void
    

    Refreshes the control.

    Parameters
    • fullUpdate: boolean Optional

      Whether to update the control layout as well as the content.

    Returns
    void

    Static refreshAll

    refreshAll(e?: HTMLElement): void
    

    Refreshes all Wijmo controls contained in an HTML element.

    This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.

    Parameters
    • e: HTMLElement Optional

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Inherited From
    Control
    Returns
    void

    reload

    reload(): void
    

    Reloads the document.

    This is useful for force reloading and rerendering the document.

    Returns
    void

    removeEventListener

    removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
    

    Removes one or more event listeners attached to elements owned by this Control.

    Parameters
    • target: EventTarget Optional

      Target element for the event. If null, removes listeners attached to all targets.

    • type: string Optional

      String that specifies the event. If null, removes listeners attached to all events.

    • fn: any Optional

      Handler to remove. If null, removes all handlers.

    • capture: boolean Optional

      Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

    Inherited From
    Control
    Returns
    number

    showPageSetupDialog

    showPageSetupDialog(): void
    

    Shows the page setup dialog.

    Returns
    void

    zoomToView

    zoomToView(): void
    

    Scales the current page to show the whole page in view panel.

    Returns
    void

    zoomToViewWidth

    zoomToViewWidth(): void
    

    Scales the current page to fit the width of the view panel.

    Returns
    void

    Events

    beforeSendRequest

    Occurs before every request sent to the server.

    The event allows you to modify request options like URL, headers, data and even the request method, before sending them to the server. The event passes an argument of the RequestEventArgs type, whose properties have the same meaning and structure as the parameters of the httpRequest method, and can be modified to update the request attributes.

    For example, you can put an authentication token to the 'Authorization' header:

    viewer.beforeSendRequest.addHandler((s, e) => {
        e.settings.requestHeaders.Authorization = 'Bearer ' + appAuthService.getToken();
    });
    

    If the URL is used to induce an HTTP request that is executed by the browser automatically (for example, if the URL is used as a parameter to the window.open() function, or as a HTML link), then the e.settings argument will be null.

    Arguments
    RequestEventArgs

    fullScreenChanged

    Occurs after the full screen mode is changed.

    Arguments
    EventArgs

    gotFocus

    Occurs when the control gets the focus.

    Inherited From
    Control
    Arguments
    EventArgs

    invalidInput

    Occurs when invalid input is detected.

    Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.

    If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.

    If the event is not canceled, the control will ignore the invalid input and will retain the original content.

    Inherited From
    Control
    Arguments
    CancelEventArgs

    lostFocus

    Occurs when the control loses the focus.

    Inherited From
    Control
    Arguments
    EventArgs

    mouseModeChanged

    Occurs after the mouse mode is changed.

    Arguments
    EventArgs

    pageIndexChanged

    Occurs after the page index is changed.

    Arguments
    EventArgs

    pageLoaded

    Occurs when the next page has been loaded from the server, and its SVG has been rendered.

    Arguments
    PageLoadedEventArgs

    queryLoadingData

    Occurs when querying the request data sent to the service before loading the document.

    Arguments
    QueryLoadingDataEventArgs

    refreshed

    Occurs after the control has refreshed its contents.

    Inherited From
    Control
    Arguments
    EventArgs

    refreshing

    Occurs when the control is about to refresh its contents.

    Inherited From
    Control
    Arguments
    EventArgs

    viewModeChanged

    Occurs after the view mode is changed.

    Arguments
    EventArgs

    zoomFactorChanged

    Occurs after the zoom factor is changed.

    Arguments
    EventArgs

    zoomModeChanged

    Occurs after the zoom mode is changed.

    Arguments
    EventArgs