ASP.NET MVC Controls
PdfViewer Class
File
wijmo.viewer.js
Module
wijmo.viewer
Base Class
ViewerBase

Defines the PDFViewer control for displaying the PDF document.

The serviceUrl property indicates the url of C1 Web API which provides PDF services. The PDF services use C1PdfDocumentSource to process PDF document.

Here is the sample to show a PDF document:

var pdfViewer = new wijmo.viewer.PdfViewer('#pdfViewer');
pdfViewer.serviceUrl= 'http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report';
pdfViewer.filePath= 'PdfsRoot/C1XapOptimizer.pdf';

Constructor

Properties

Methods

Events

Constructor

constructor

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

Initializes a new instance of the PdfViewer class.

Parameters
Returns
PdfViewer

Properties

Static controlTemplate

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

Inherited From
ViewerBase
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.

Inherited From
ViewerBase
Type
string

fullScreen

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

Inherited From
ViewerBase
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

pageIndex

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

Inherited From
ViewerBase
Type
number

rightToLeft

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

Inherited From
Control
Type
boolean

selectMouseMode

Gets or sets a value indicating whether clicking and dragging the mouse in the view panel selects text.

This property only works for desktop. The default is true which means clicking and dragging the mouse will select the text. Setting it to false means clicking and dragging the mouse will move the view page in the view panel.

Inherited From
ViewerBase
Type
boolean

serviceUrl

Gets or sets the address of C1 Web API service.

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

Inherited From
ViewerBase
Type
string

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.

Inherited From
ViewerBase
Type
number

viewMode

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

Inherited From
ViewerBase
Type
ViewMode

zoomFactor

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

Inherited From
ViewerBase
Type
number

zoomMode

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

Inherited From
ViewerBase
Type
ZoomMode

Methods

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: 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 method).

Failing to remove event listeners may cause memory leaks.

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 is capturing.

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. 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', template, {
  _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 is hosting the control, or a 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, it will override the template defined by the DropDown base class.

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.

Inherited From
ViewerBase
Returns
IPromise

onFullScreenChanged

onFullScreenChanged(e?: EventArgs): void

Raises the fullScreenChanged event.

Parameters
Inherited From
ViewerBase
Returns
void

onGotFocus

onGotFocus(e?: EventArgs): void

Raises the gotFocus event.

Parameters
Inherited From
Control
Returns
void

onLostFocus

onLostFocus(e?: EventArgs): void

Raises the lostFocus event.

Parameters
Inherited From
Control
Returns
void

onPageIndexChanged

onPageIndexChanged(e?: EventArgs): void

Raises the pageIndexChanged event.

Parameters
Inherited From
ViewerBase
Returns
void

onQueryLoadingData

onQueryLoadingData(e: QueryLoadingDataEventArgs): void

Raises the queryLoadingData event.

Parameters
Inherited From
ViewerBase
Returns
void

onSelectMouseModeChanged

onSelectMouseModeChanged(e?: EventArgs): void

Raises the selectMouseModeChanged event.

Parameters
Inherited From
ViewerBase
Returns
void

onViewModeChanged

onViewModeChanged(e?: EventArgs): void

Raises the viewModeChanged event.

Parameters
Inherited From
ViewerBase
Returns
void

onZoomFactorChanged

onZoomFactorChanged(e?: EventArgs): void

Raises the zoomFactorChanged event.

Parameters
Inherited From
ViewerBase
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.

Inherited From
ViewerBase
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.

Inherited From
ViewerBase
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.

Inherited From
ViewerBase
Returns
void

zoomToView

zoomToView(): void

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

Inherited From
ViewerBase
Returns
void

zoomToViewWidth

zoomToViewWidth(): void

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

Inherited From
ViewerBase
Returns
void

Events

fullScreenChanged

Occurs after the full screen mode is changed.

Inherited From
ViewerBase
Arguments
EventArgs

gotFocus

Occurs when the control gets the focus.

Inherited From
Control
Arguments
EventArgs

lostFocus

Occurs when the control loses the focus.

Inherited From
Control
Arguments
EventArgs

pageIndexChanged

Occurs after the page index is changed.

Inherited From
ViewerBase
Arguments
EventArgs

queryLoadingData

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

Inherited From
ViewerBase
Arguments
QueryLoadingDataEventArgs

selectMouseModeChanged

Occurs after the select mouse mode is changed.

Inherited From
ViewerBase
Arguments
EventArgs

viewModeChanged

Occurs after the view mode is changed.

Inherited From
ViewerBase
Arguments
EventArgs

zoomFactorChanged

Occurs after the zoom factor is changed.

Inherited From
ViewerBase
Arguments
EventArgs

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback