DocumentOptions Class

Represents options for a document loaded in the document viewer.

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

Definition

Namespace: GleamTech.DocumentUltimate.AspNet.UI
Assembly: GleamTech.DocumentUltimate (in GleamTech.DocumentUltimate.dll) Version: 7.0.0
C#
public class DocumentOptions : DocumentCacheOptions
Inheritance
Object    DocumentCacheOptions    DocumentOptions

Constructors

DocumentOptions Initializes a new instance of the DocumentOptions class.

Properties

Attachments Gets the collection of the attachments that will be added to the displayed document. Downloading as PDF will also include the same attachments.

Note that changes in this property change CachePdfKey and in effect CacheXpzKey.

DownloadFileName Gets or sets a value that specifies the custom file name used for downloading the document.

This property will override the original file name specified in Document.


(Inherited from DocumentCacheOptions)
DownloadUrl Gets or sets a value that specifies the custom url that should be used for downloading the document.

By default, when you click the download button, the download is handled internally by the document viewer. You can override the default behaviour by specifying your own url which handles the download.


(Inherited from DocumentCacheOptions)
Format Gets or sets the document format to use for the document. By default, the format is determined from the file extension but you can use this property when you don't have an extension or when you need to override the format determined from the extension (e.g. you want file.xml to be treated as Txt).

Note that changes in this property change CachePdfKey and in effect CacheXpzKey.


(Inherited from DocumentCacheOptions)
HighQualityEnabled Gets or sets a value that specifies whether to use high quality rendering for the document when converting to the special web format to be displayed in the document viewer. The default is false.

For providing some guarantees regarding how quickly a page can be rendered on different systems such as mobile devices, by default some parts of a page that are very complex and would take really long to render in the browser, are rasterized to an image (flattened). However as a side effect, parts of some pages may look blurry when you zoom in. You can set this property to true to disable this possible flattening (if you observe it's happening with your specific document). This way you can ensure vector quality rendering for complex documents such as CAD drawings. If you have errors due to insufficient memory, keep it at false. This setting does not effect the first step of the conversion: Source -> PDF, it only effects the second step of the conversion: PDF -> XPZ.

Note that changes in this property change CacheXpzKey.


(Inherited from DocumentCacheOptions)
InputOptions Gets the collection of input options used when generating the displayed document. For example, when you add an instance of SpreadsheetInputOptions to this collection, it will be used only for spreadsheet input files.

Note that changes in this property change CachePdfKey and in effect CacheXpzKey.

Password Gets or sets the password which is used for loading a protected document.

Note that changes in this property change CachePdfKey and in effect CacheXpzKey.


(Inherited from DocumentCacheOptions)
Watermarks Gets the collection of the text or image watermarks to embed to the displayed document. Downloading as PDF will also include the same watermarks.

Note that changes in this property change CachePdfKey and in effect CacheXpzKey.

See Also