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.2.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.

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.


(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.

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

Note that changes in this property change CachePdfKey.


(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.

See Also