DocumentViewer Class

DeniedPermissions take precedence over AllowedPermissions. For instance, when AllowedPermissions is set to All and DeniedPermissions is set to Download and Print, all permissions except Download and Print will be allowed.

When combining permissions, they should be separated by comma in string and by bitwise 'or' operator in code (| in C# and OR in VB).

DeniedPermissions take precedence over AllowedPermissions. For instance, when AllowedPermissions is set to All and DeniedPermissions is set to Download and Print, all permissions except Download and Print will be allowed.

When combining permissions, they should be separated by comma in string and by bitwise 'or' operator in code (| in C# and OR in VB).

It is usually set as the two-letter language names like en, de, fr etc. as the bundled languages are usually for general language names. However, it can be also set to specific cultures like en-US, de-DE, fr-FR etc. For example, if the property is set to a specific culture like de-CH (German in Switzerland), the component will first look for the language file translation-de-CH.json and if the file is not found, it will load the general (fallback) language file of that culture which is translation-de.json. If not set, the language file which matches the current UICulture of the host application will be loaded. If there is no language file which matches the current UICulture or its fallback, then the default language file translation-en.json is loaded.

This property can be set to:

• A plain string which contains a physical/virtual path
  (e.g. "c:\SomeFolder\SomeFile.ext", "/SomeFolder/SomeFile.ext", "~/SomeFolder/SomeFile.ext").
  
  This is parsed as a FileSystemFileProvider instance with a PhysicalLocation instance. Note that virtual paths can only be resolved in a web application.
  and on Linux paths starting with "/" are physical paths and not virtual paths.
  
  
• A plain string which contains a URL or a Data URL.
  (e.g. "http://example.com/SomeFolder/SomeFile.ext", "data:image/gif;base64,...").
  
  Strings starting with http:// or https:// are parsed as a UrlFileProvider instance.
  Strings starting with data: are parsed as a DataUrlFileProvider instance.
  
  
• A FileProvider instance created with one of the builtin file providers
  (e.g. FileSystemFileProvider, UrlFileProvider, DataUrlFileProvider, StreamFileProvider, MemoryFileProvider, DatabaseFileProvider, AssemblyResourceFileProvider, TemporaryFileProvider).
  
  You can also override FileProvider base class to implement your custom file provider.
  
  
• A provider string which defines a specific file provider
  (e.g. "Type=FileSystem; File=SomeFile.ext; Location='Type=Physical; Path=c:\SomeFolder'").
  
  

The document viewer only needs a readable file provider as it only calls GetInfo and OpenRead.

You can specify document format, password, watermarks, attachments etc.

Format language is used for the number and date/time formats. It is usually set as the specific cultures like en-US, de-DE, fr-FR etc. If not set, the current Culture of the host application will be used.

Note that device features are not detected, instead browser's viewport size is used to decide the UI sizing. So if you manually resize the browser window (or emulate a device via browser's F12 dev tools), phone or tablet size can be triggered.

The default is OnAny which means phones and tablets.

For this property to be effective PageFitMode property should be set to Zoom.

The options will be reflected as default values on the print dialog of the document viewer.

If you want the document viewer to discard any view history entries and always load all documents at the first page (and with default zoom values), then you should set this property to .

Note that if RememberViewHistory is set to , then History will be treated as Vertical or derived from 'PageLayout' setting inside PDF if exists.

If you specify a search term, an automatic search will be done when the document is displayed, i.e. the specified term will be searched and results with clickable positions will be listed on the left pane and the term will be highlighted in the pages. For example, if you launch the document viewer from a search results page, you can pass the same search term to the document viewer.

Note that if RememberViewHistory is set to , then History will be treated as None or derived from 'PageMode' setting inside PDF if exists.

Note that if RememberViewHistory is set to , then History will be treated as None or derived from 'PageLayout' setting inside PDF if exists.

Possible values are "slate", "classic-light", "classic-dark" or the CSS class name of a custom theme. When two values separated by comma is set, the second value will be the dark theme. Dark theme is used when a user indicates their preference through an operating system setting (e.g. light or dark mode) or a user agent setting. When single value is provided, dark theme is disabled, i.e. the only provided theme will be used always even when user prefers dark mode.

The default is "slate, classic-dark".

The document viewer has about 111 language files, however for some few custom text which are not inside those language files, this property is used to override. For example, you can override the default "preparing document..." message for localization purpose.

Note that if a custom zoom level is set via ZoomLevel property then it will override this setting.