Skip to main content

Document Viewer

Use the Document Viewer control to render a document and display it inline in your app. For example, you can use the Document Viewer control to display an invoice document or a receipt which may be located in various sources, such as storage buckets, entities, or public links.

When assigning the file to an app variable, make sure the variable is of the type IResource.

If you only want to display an image, it is recommended to use the Image control.

important

The Document Viewer uses a built-in PDF.js viewer, which works consistently across browsers. No browser configuration is required. When loading PDFs from external file servers, the server must support cross-origin requests. If CORS is not enabled, the built-in PDF.js viewer will not be able to render the document.

Working with IResource​

If you obtain a file as an ILocalResource, it is automatically converted into an IResource using:

JobAttachment.fromResource(file) // file is a ILocalResource
important

The following functions have been deprecated and should no longer be used:

  • .toLocalResource
  • .toAppsFile

General​

  • Hidden - If true, hides the control at runtime.
  • Disabled - If true, disables the control at runtime.

Events​

No events.

Style​

  • Control Alignment - By default, inherits the parent alignment. A different alignment other than the parent can be set. To default back to the parent alignment, deselect the overridden options.
    note

    The alignment is dependent on the layout selected for the parent (Vertical vs. Horizontal).

  • Border - The border for the control. Border Thickness, Color, and Radius can be configured.
  • Margin - The margin of the control. By default, a margin of 4 px is set. Top/Bottom and Left/Right margin properties are combined. These properties can be detached using the Link button at the right side of the Margin section.
  • Size - The width and height of the control. By default, the size is set to auto, which means 320 x 410px. To set minimum or maximum values, select the three dot icon (...).

VB properties​

VB propertyData typeDescription
SourceAppsFileThe source file currently viewed.
ValueAppsFileValue attached or outputted from the Document Viewer control.
HiddenBooleanIf true, hides the control at runtime.
DisabledBooleanIf true, disables the control at runtime.