Skip to end of metadata
Go to start of metadata

Note:  The features listed in this Page are supported only in GroupDocs.Viewer Cloud V1

Options Objects

Page contains description for option objects and object fields.

DocumentInfoOptions Object

Provides options for retrieving attachment information.

Example DocumentInfoOptions object

 Info Object Fields (Click here to expand)

Name

Type

Description

Password

string

Allows to specify document password in case when document is password-protected.

AttachmentPasswordstringAllows to specify attachment password in case when attachment is password-protected.

ExtractText

bool

Enables document text extraction. For rendering document as image only.

RenderComments

bool

Enables document comments rendering.

RenderHiddenPagesboolEnables document hidden pages, sheets or slides rendering.
DefaultFontNamestring

The name of the default font.
Default font name may be specified in following cases:
- You want to generally specify the default font to fall back on, if particular font
in the document cannot be found during rendering.
- Your document uses fonts, that contain non-English characters and you want to make sure
any missing font is replaced with one that has the same character set available.

Transforms

string[]

Transforms to apply. Available transforms ["Rotate","Reorder","AddPrintAction"].
Rotate - Pages will be rotated on angle if angle was set before.
Reorder - For rendering document as PDF only. Pages will be ordered according to rearrangements made before.
AddPrintAction - For rendering document as PDF only. An JavaScript action will be added which opens print dialog when PDF document is opened.

Watermark

Watermark Object

Allows to specify watermark.

CellsOptions

CellsOptions Object

The Spreadsheet documents rendering options.

CadOptions

CadOptions Object

The CAD documents rendering options.

EmailOptions

EmailOptions Object

The Email documents rendering options.

WordsOptions

WordsOptions Object

The Text documents rendering options.

PdfOptions

PdfOptions Object

The PDF documents rendering options.

SlidesOptionsSlidesOptions ObjectThe Presentation documents rendering options.
ProjectOptionsProjectOptions ObjectThe Microsoft Project documents rendering options.

ImageOptions Object

Provides options for rendering document as image.

Example ImageOptions object

 ImageOptions Object Fields (Click here to expand)

Name

Type

Description

Formatstring

Allows to set image format ("png", "jpg", "bmp").

Default value is "png".

Quality int

Allows to specify quality when format = "jpg". Valid values are between 1 and 100. 

Default value is 90.

Widthint

Allows to specify output image width.
Specify image width in case when you want to change output image dimensions.
When Width has value and Height value is 0 then Height value will be calculated to save image proportions.

Heightint

Allows to specify output image height.
Specify image height in case when you want to change output image dimensions.
When Height has value and Width value is 0 then Width value will be calculated to save image proportions.

Password

string

Allows to specify document password in case when document is password-protected.

AttachmentPasswordstringAllows to specify attachment password in case when attachment is password-protected.

ExtractText

bool

Enables document text extraction. For rendering document as image only.

RenderComments

bool

Enables document comments rendering.

DefaultFontNamestring

The name of the default font.
Default font name may be specified in following cases:
- You want to generally specify the default font to fall back on, if particular font
in the document cannot be found during rendering.
- Your document uses fonts, that contain non-English characters and you want to make sure
any missing font is replaced with one that has the same character set available.

Transforms

string[]

Transforms to apply. Available transforms ["Rotate","Reorder","AddPrintAction"].
Rotate - Pages will be rotated on angle if angle was set before.
Reorder - For rendering document as PDF only. Pages will be ordered according to rearrangements made before.
AddPrintAction - For rendering document as PDF only. An JavaScript action will be added which opens print dialog when PDF document is opened.

Watermark

Watermark Object

Allows to specify watermark.

CellsOptions

CellsOptions Object

The Spreadsheet documents rendering options.

CadOptions

CadOptions Object

The CAD documents rendering options.

EmailOptions

EmailOptions Object

The Email documents rendering options.

WordsOptions

WordsOptions Object

The Text documents rendering options.

PdfOptions

PdfOptions Object

The PDF documents rendering options.

SlidesOptionsSlidesOptions ObjectThe Presentation documents rendering options.
ProjectOptionsProjectOptions ObjectThe Microsoft Project documents rendering options.

HtmlOptions Object

Provides options for rendering document pages as HTML.

Example HtmlOptions object

 HtmlOptions Fields (Click here to expand)

Name

Type

Description

ResourcePathstring

Allows to specify HTML resources (styles, images and fonts) path.

For example when resource path is http://example.com/api/pages/{page-number}/resources/{resource-name} the {page-number} and {resource-name} templates will be replaced with page number and resource name accordingly.

Ignored when EmbedResources option is set to true.

IgnoreResourcePathInResourcesbool

Allows to ignore ResourcePath when processing *.css and *.svg files.

When this options is enabled ResourcePath won't be added to resource references in *.css and *.svg files.

 EmbedResourcesbool

Controls output HTML document resources (styles, images and fonts) saving.

When this options set to true all resources will be embedded into HTML document and <see cref="ResourcePath"/> option value will be ignored.

EnableMinification (added in 18.2)boolEnables content (HTML and SVG) minification.
EnableResponsiveRendering (added in 18.2)boolIndicates whether rendering will provide responsive web pages, that look well on different device types.
ExcludeFonts (added in 18.5)boolPrevents adding fonts to the output HTML document.
ExcludeFontsList (added in 18.11)string[]The list of font names, that will be excluded from HTML. Active only when ExcludeFonts is set to false.
StartPageNumberintAllows to specify document page number as starting page to render.
CountPagesintAllows to specify count of document pages to render.

Password

string

Allows to specify document password in case when document is password-protected.

AttachmentPasswordstringAllows to specify attachment password in case when attachment is password-protected.

ExtractText

bool

Enables document text extraction. For rendering document as image only.

RenderComments

bool

Enables document comments rendering.

RenderHiddenPagesbool

Enables document hidden pages, sheets or slides rendering.

DefaultFontNamestring

The name of the default font.
Default font name may be specified in following cases:
- You want to generally specify the default font to fall back on, if particular font
in the document cannot be found during rendering.
- Your document uses fonts, that contain non-English characters and you want to make sure
any missing font is replaced with one that has the same character set available.

Transforms

string[]

Transforms to apply. Available transforms ["Rotate","Reorder","AddPrintAction"].
Rotate - Pages will be rotated on angle if angle was set before.
Reorder - For rendering document as PDF only. Pages will be ordered according to rearrangements made before.
AddPrintAction - For rendering document as PDF only. An JavaScript action will be added which opens print dialog when PDF document is opened.

Watermark

Watermark

Allows to specify watermark.

CellsOptions

CellsOptions

The Spreadsheet documents rendering options.

CadOptions

CadOptions

The CAD documents rendering options.

EmailOptions

EmailOptions

The Email documents rendering options.

WordsOptions

WordsOptions

The Text documents rendering options.

PdfOptions

PdfOptions

The PDF documents rendering options.

SlidesOptionsSlidesOptionsThe Presentation documents rendering options.
ProjectOptionsProjectOptionsThe Microsoft Project documents rendering options.

PdfFileOptions Object

Provides options for rendering document as PDF.

Example PdfFileOptions object

 PdfFileOptions Object Fields (Click here to expand)

Name

Type

Description

Password

string

Allows to specify document password in case when document is password-protected.

ExtractText

bool

Enables document text extraction. For rendering document as image only.

RenderComments

bool

Enables document comments rendering.

RenderHiddenPagesbool

Enables document hidden pages, sheets or slides rendering.

DefaultFontNamestring

The name of the default font.
Default font name may be specified in following cases:
- You want to generally specify the default font to fall back on, if particular font
in the document cannot be found during rendering.
- Your document uses fonts, that contain non-English characters and you want to make sure
any missing font is replaced with one that has the same character set available.

Transforms

string[]

Transforms to apply. Available transforms ["Rotate","Reorder","AddPrintAction"].
Rotate - Pages will be rotated on angle if angle was set before.
Reorder - For rendering document as PDF only. Pages will be ordered according to rearrangements made before.
AddPrintAction - For rendering document as PDF only. An JavaScript action will be added which opens print dialog when PDF document is opened.

Watermark

Watermark Object

Allows to specify watermark.

CellsOptions

CellsOptions Object

The Spreadsheet documents rendering options.

CadOptions

CadOptions Object

The CAD documents rendering options.

EmailOptions

EmailOptions Object

The Email documents rendering options.

WordsOptions

WordsOptions Object

The Text documents rendering options.

PdfOptions

PdfOptions Object

The PDF documents rendering options.

SlidesOptionsSlidesOptions ObjectThe Presentation documents rendering options.
ProjectOptionsProjectOptions ObjectThe Microsoft Project documents rendering options.

RotateOptions Object

Provides options for rotating document pages.

Example RotateOptions object

 RotateOptions Object Fields (Click here to expand)

Name

Type

Description

PageNumberint

The page number which angle should be changed.

Angle int

The angle in degrees to which the page should be rotated.

Password

string

Allows to specify document password in case when document is password-protected.

ReorderOptions Object 

Provides options for reordering document pages.

Example ReorderOptions object

 

 ReorderOptions Object Fields (Click here to expand)

Name

Type

Description

PageNumberint

The page number which angle should be changed.

NewPosition

int

The position where page should be placed.

Password

string

Allows to specify document password in case when document is password-protected.

Watermark Object

Provides options for watermarking.

Example Watermark object.

 Watermark Object Fields (Click here to expand)

Name

Type

Description

Text

string

The watermark text.

Color

string

The watermark color.
Supported formats "Magenta", "(112,222,11)", "(50,112,222,11)".
Default value is "Red".

Position

string

The watermark position.
Supported positions "Diagonal", "TopLeft", "TopCenter", "TopRight", "BottomLeft", "BottomCenter" and "BottomRight".
Default value is "Diagonal".

Size

int

Watermark size in percents.
Default value is 100. 

CellsOptions Object

Provides options for rendering spreadsheet documents.

Example CellOptions object.

 CellsOptions Fields (Click here to expand)
NameTypeDescription
RenderGridLinesbool

Indicates whether to render grid lines.

PaginateSheetsbool

Enables worksheets pagination. By default one worksheet is rendered into one page.

EncodingstringThe text (*.csv) document encoding.
InternalHyperlinkPrefixstring

Prefix for hyperlink that references worksheet inside the same document.

For rendering document as HTML only.

CountRowsPerPageint

The number of rows rendered into one page when PaginateSheets = true.
Default value is 50.

TextOverflowModestring
Text overflow mode applied when the text is too big to fit into the cell.
Supported modes "Overlay", "OverlayIfNextIsEmpty", "HideText" and "AutoFitColumn".
Overlay - Overlay next cells even they are not empty.
OverlayIfNextIsEmpty - Overlay next cells only if they are not empty
HideText - Hide overflow text
AutoFitColumn (added in 18.5) - Expand cell width to fit overflowed text
Default value is OverlayIfNextIsEmpty.
IgnoreEmptyRowsbool

Indicates whether empty rows should be ignored.

RenderHiddenRows (added in 18.5)boolEnables rendering of hidden rows.
RenderHiddenColumns (added in 18.5)boolEnables rendering of hidden columns.
RenderPrintAreaOnly (added in 18.5)bool

Enables rendering worksheet(s) sections which is defined as print area.

Renders each print area in a worksheet as a separate page.

CadOptions Object

Provides options for rendering CAD documents.

Example CadOptions object.

 CadOptions Object Fields (Click here to expand)
NameTypeDescription
ScaleFactorfloatThe scale factor affects the size of an output document.
WidthintThe width of the render result in pixels.
HeightintThe height of the render result in pixels.
RenderLayoutsbool

Indicates whether layouts from CAD document should be rendered.

LayoutNamestringThe name of the specific layout to render. 
Layersstring[]The list of document layers to render. By default all layers will be rendered. Layer names are case sensitive. (since 18.2)

EmailOptions Object

Provides options for rendering Email documents.

Example EmailOptions object.

 EmailOptions Fileds (Click here to expand)
NameTypeDescription
EncodingstringThe document encoding e.g. "utf-8".
PageSize (added in 18.7)string

The size of the output page when rendering as PDF or image.
Supported values {Unknown|Letter|Ledger|A0|A1|A2|A3}:
1. Unknown - the default, unspecified page size.
2. Letter - the size of the Letter page in points is 792x612.
3. Ledger - the size of the Letter page in points is 1224x792.
4. A0 - the size of the A0 page in points is 3371x2384.
5. A1 - the size of the A1 page in points is 2384x1685.
6. A2 - the size of the A2 page in points is 1684x1190.
7. A3 - the size of the A3 page in points is 1190x842.
8. A4 - the size of the A4 page in points is 842x595.

FieldLabels (added in 18.7)array

The list of supported email message field labels:
1. Field: "Anniversary" - default value is "Anniversary".
2. Field: "Attachments" - default value is "Attachments".
3. Field: "Bcc" - default value is "Bcc".
4. Field: "Birthday" - default value is "Birthday".
5. Field: "Business" - default value is "Business".
6. Field: "BusinessAddress" - default value is "Business Address".
7. Field: "BusinessFax" - default value is "Business Fax".
8. Field: "BusinessHomepage" - default value is "BusinessHomePage".
9. Field: "Cc" - default value is "Cc".
10. Field: "Company" - default value is "Company".
11. Field: "Department" - default value is "Department".
12. Field: "Email" - default value is "Email".
13. Field: "EmailDisplayAs" - default value is "Email Display As".
14. Field: "Email2" - default value is "Email2".
15. Field: "Email2DisplayAs" - default value is "Email2 Display As".
16. Field: "Email3" - default value is "Email3".
17. Field: "Email3DisplayAs" - default value is "Email3 Display As".
18. Field: "End" - default value is "End".
19. Field: "FirstName" - default value is "First Name".
20. Field: "From" - default value is "From".
21. Field: "FullName" - default value is "Full Name".
22. Field: "Gender" - default value is "Gender".
23. Field: "Hobbies" - default value is "Hobbies".
24. Field: "Home" - default value is "Home".
25. Field: "HomeAddress" - default value is "Home Address".
26. Field: "Importance" - default value is "Importance".
27. Field: "JobTitle" - default value is "Job Title".
28. Field: "LastName" - default value is "Last Name".
29. Field: "Location" - default value is "Location".
30. Field: "MiddleName" - default value is "Middle Name".
31. Field: "Mobile" - default value is "Mobile".
32. Field: "Organizer" - default value is "Organizer".
33. Field: "OtherAddress" - default value is "Other Address".
34. Field: "PersonalHomepage" - default value is "PersonalHomePage".
35. Field: "Profession" - default value is "Profession".
36. Field: "Recurrence" - default value is "Recurrence".
37. Field: "RecurrencePattern" - default value is "Recurrence Pattern".
38. Field: "RequiredAttendees" - default value is "Required Attendees".
39. Field: "Sent" - default value is "Sent".
40. Field: "ShowTimeAs" - default value is "Show Time As".
41. Field: "SpousePartner" - default value is "Spouse/Partner".
42. Field: "Start" - default value is "Start".
43. Field: "Subject" - default value is "Subject".
44. Field: "To" - default value is "To".
45. Field: "UserField1" - default value is "User Field 1".
46. Field: "UserField2" - default value is "User Field 2".
47. Field: "UserField3" - default value is "User Field 3".
48. Field: "UserField4" - default value is "User Field 4".

WordsOptions Object

Provides options for rendering Text documents.

Example WordsOptions object.

 WordsOptions Object Fields (Click here to expand)
NameTypeDescription
EncodingstringThe document encoding e.g. "utf-8".
RenderTrackedChangesbool

Indicates whether Tracked Changes (Revisions) should be rendered or not.

PdfOptions Object

Provides options for rendering PDF documents.

Example PdfOptions object.

 PdfOptions Fields (Click here to expand)
NameTypeDescription
EnablePreciseRenderingbool

Indicates whether the PDF document is rendered in a precise mode or not. It is recommended to enable this option when rendering documents with complex content e.g. documents which contains hieroglyphs or any kind o glyphs which should be rendered separately from each other.

EnableInitialContentOrderingbool

When this option is enabled content (graphics and text) will be added to HTML document accordingly Z-order in original PDF document. When this option is disabled content (graphics and text) will be added to a single layer.

RenderLayersSeparatelybool

When this option is enabled layers will be separated from each other in the HTML document.

ImageQuality (added in 18.5)

string

Specifies output image quality for image resources when rendering as HTML. The default value is Low. Supported values Low, Medium and High:

- Low - satisfying image quality and smallest image size.
- Medium - better image quality and larger image size.
- High - best image quality with largest image size.

SlidesOptions Object

Provides options for rendering Presentation documents.

Example SlidesOptions object.

 SlidesOptions Object Fields (Click here to expand)
NameTypeDescription
RenderNotesbool

Indicates whether slide notes should be rendered.

ProjectOptions Object

This object supported starting from v18.2

Provides options for rendering Microsoft Project documents.

Example ProjectOptions object.

 ProjectOptions Object Fields (Click here to expand)
NameTypeDescription
PageSizestring

The size of the page.
Supported values {Unknown|Letter|A0|A1|A2|A3}:
1. Unknown - the default, unspecified page size.
2. Letter - the size of the Letter page in points is 792 × 612.
3. Ledger - the size of the Letter page in points is 1224 × 792.
4. A0 - the size of the A0 page in points is 3371 × 2384.
5. A1 - the size of the A1 page in points is 2384 × 1685.
6. A2 - the size of the A2 page in points is 1684 × 1190.
7. A3 - the size of the A3 page in points is 1190 × 842.
8. A4 - the size of the A4 page in points is 842 × 595.

TimeUnitstring

The time unit to use as minimal point.
Supported values {Unknown|Days|ThirdsOfMonths|Months}:
1. Unknown - unknown, unspecified time scale.
2. Days - one day interval.
3. ThirdsOfMonths - one third of the month.
4. Months - one month interval.

StartDate

 

 

DateTime

The start date of a Gantt Chart View to render. 

(info) Supported starting from v18.11

 
EndDateDateTime

The end date of a Gantt Chart View to render.

(info) Supported starting from v18.11 

OutlookOptions Object 

OutlookOptions supported starting from v18.11

Provides options for rendering Microsoft Outlook data files (.pst|.ost).

Example of OutlookOptions

 OutlookOptions fields
NameTypeDescription
MaxItemsInFolder
intThe limit of items to render in mailbox folders
Labels
  • No labels