diff --git a/english/net/groupdocs.viewer.options/_index.md b/english/net/groupdocs.viewer.options/_index.md index 58859895a..be660d4d0 100644 --- a/english/net/groupdocs.viewer.options/_index.md +++ b/english/net/groupdocs.viewer.options/_index.md @@ -12,35 +12,35 @@ The namespace provides classes to specify additional options when rendering docu | Class | Description | | --- | --- | -| [ArchiveOptions](./archiveoptions) | Provides options for rendering archive files. | -| [BaseViewOptions](./baseviewoptions) | Provides base rendering options. | -| [CadOptions](./cadoptions) | Provides options for rendering CAD drawings. | -| [EmailOptions](./emailoptions) | Provides options for rendering email messages. | -| [Field](./field) | Represents email message field e.g. From, To, Subject etc. | +| [ArchiveOptions](./archiveoptions) | Contains options for rendering the archive files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/). | +| [BaseViewOptions](./baseviewoptions) | Contains the base rendering options. | +| [CadOptions](./cadoptions) | Contains options for rendering CAD drawings. For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/) and [Specify rendering options for CAD files](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/). | +| [EmailOptions](./emailoptions) | Contains options for rendering email messages. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/). | +| [Field](./field) | Represents email message field e.g. From, To, Subject etc. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#rename-fields-in-the-message-header). | | [FileName](./filename) | The filename. | -| [HtmlViewOptions](./htmlviewoptions) | Provides options for rendering documents into HTML format. | -| [JpgViewOptions](./jpgviewoptions) | Provides options for rendering documents into JPG format. | -| [LoadOptions](./loadoptions) | Provides options that used to open the file. | -| [MailStorageOptions](./mailstorageoptions) | Provides options for rendering Mail storage (Lotus Notes, MBox) data files. | -| [OutlookOptions](./outlookoptions) | Provides options for rendering Outlook data files. | -| [PdfOptimizationOptions](./pdfoptimizationoptions) | Use this class to specify PDF optimization options to apply to the output PDF file. | -| [PdfOptions](./pdfoptions) | Provides options for rendering PDF documents. | -| [PdfViewOptions](./pdfviewoptions) | Provides options for rendering documents into PDF format. | -| [PngViewOptions](./pngviewoptions) | Provides options for rendering documents into PNG format. | -| [PresentationOptions](./presentationoptions) | Provides options for rendering presentations options. | -| [ProjectManagementOptions](./projectmanagementoptions) | Provides options for rendering project management files. | -| [Resolution](./resolution) | Provides option to set resolution for images in output document. | -| [Security](./security) | Provides PDF document security options. | -| [Size](./size) | Watermark size. | -| [SpreadsheetOptions](./spreadsheetoptions) | Provides options for rendering spreadsheets. | +| [HtmlViewOptions](./htmlviewoptions) | Contains options for rendering documents into HTML format. For details, see the [topic](https://docs.groupdocs.com/viewer/net/rendering-to-html/) and its children. | +| [JpgViewOptions](./jpgviewoptions) | Provides options for rendering documents into JPG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children. | +| [LoadOptions](./loadoptions) | Contains options that used to open the file. For details, see this [page](https://docs.groupdocs.com/viewer/net/loading/) and its children. | +| [MailStorageOptions](./mailstorageoptions) | Contains options for rendering Mail storage (Lotus Notes, MBox) data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options). | +| [OutlookOptions](./outlookoptions) | Contains options for rendering Outlook data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options). | +| [PdfOptimizationOptions](./pdfoptimizationoptions) | Contains the PDF optimization options to apply to the output PDF file. For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children. | +| [PdfOptions](./pdfoptions) | Contains options for rendering to PDF documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/). | +| [PdfViewOptions](./pdfviewoptions) | Contains options for rendering documents into PDF format. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). | +| [PngViewOptions](./pngviewoptions) | Contains options for rendering documents into PNG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children. | +| [PresentationOptions](./presentationoptions) | Contains options for rendering presentations. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/). | +| [ProjectManagementOptions](./projectmanagementoptions) | Contains options for rendering project management files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/). | +| [Resolution](./resolution) | Contains option to set resolution for images in output document. | +| [Security](./security) | Contains the PDF document security options. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/). | +| [Size](./size) | Contains the watermark size. | +| [SpreadsheetOptions](./spreadsheetoptions) | Contains options for rendering spreadsheets. For details, see children of the [Render spreadsheet files](https://docs.groupdocs.com/viewer/net/render-spreadsheets/) topic. | | [TextOptions](./textoptions) | Text files splitting to pages options. | -| [Tile](./tile) | Represents drawing region. | -| [ViewInfoOptions](./viewinfooptions) | Provides options used for retrieving information about view. | -| [ViewOptions](./viewoptions) | Provides rendering options. | -| [VisioRenderingOptions](./visiorenderingoptions) | The Visio files processing documents view options. | -| [Watermark](./watermark) | Represents text watermark. | -| [WebDocumentOptions](./webdocumentoptions) | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [WordProcessingOptions](./wordprocessingoptions) | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [Tile](./tile) | Represents the drawing region. | +| [ViewInfoOptions](./viewinfooptions) | Contains options for retrieving information about view. | +| [ViewOptions](./viewoptions) | Contains the rendering options. | +| [VisioRenderingOptions](./visiorenderingoptions) | Contains options for rendering Visio documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/). | +| [Watermark](./watermark) | Represents a text watermark. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/add-text-watermark/). | +| [WebDocumentOptions](./webdocumentoptions) | Contains options for rendering web documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/). | +| [WordProcessingOptions](./wordprocessingoptions) | Contains options for rendering Word documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/). | ## Interfaces | Interface | Description | @@ -53,9 +53,9 @@ The namespace provides classes to specify additional options when rendering docu | [ImageQuality](./imagequality) | The quality of images in the output HTML contained by the PDF documents. | | [PageSize](./pagesize) | The size of the page. | | [Permissions](./permissions) | Defines PDF document permissions. | -| [Position](./position) | Defines watermark position. | -| [Rotation](./rotation) | Defines page rotation in degrees. | -| [TextOverflowMode](./textoverflowmode) | Defines text overflow mode for rendering spreadsheet documents into HTML. | +| [Position](./position) | Defines the watermark position. | +| [Rotation](./rotation) | Contains page rotation in degrees (clockwise). | +| [TextOverflowMode](./textoverflowmode) | Sets the text overflow mode for rendering spreadsheet documents into HTML. | | [TimeUnit](./timeunit) | Time unit of the project duration. | diff --git a/english/net/groupdocs.viewer.options/archiveoptions/_index.md b/english/net/groupdocs.viewer.options/archiveoptions/_index.md index 1be405556..f5de08321 100644 --- a/english/net/groupdocs.viewer.options/archiveoptions/_index.md +++ b/english/net/groupdocs.viewer.options/archiveoptions/_index.md @@ -1,14 +1,14 @@ --- title: ArchiveOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering archive files. +description: Contains options for rendering the archive files. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderarchivefiles/. type: docs weight: 240 url: /net/groupdocs.viewer.options/archiveoptions/ --- ## ArchiveOptions class -Provides options for rendering archive files. +Contains options for rendering the archive files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/). ```csharp public class ArchiveOptions @@ -18,14 +18,14 @@ public class ArchiveOptions | Name | Description | | --- | --- | -| [ArchiveOptions](archiveoptions)() | Initializes new instance of [`ArchiveOptions`](../archiveoptions) class. | +| [ArchiveOptions](archiveoptions)() | Initializes an instance of the [`ArchiveOptions`](../archiveoptions) class. | ## Properties | Name | Description | | --- | --- | -| [FileName](../../groupdocs.viewer.options/archiveoptions/filename) { get; set; } | The filename to display in the header. By default the name of the source file is displayed. | -| [Folder](../../groupdocs.viewer.options/archiveoptions/folder) { get; set; } | The folder inside the archive to be rendered. | +| [FileName](../../groupdocs.viewer.options/archiveoptions/filename) { get; set; } | Sets the displayed archive file name. | +| [Folder](../../groupdocs.viewer.options/archiveoptions/folder) { get; set; } | Sets the folder to be rendered. | | [ItemsPerPage](../../groupdocs.viewer.options/archiveoptions/itemsperpage) { get; set; } | Number of records per page (for rendering to HTML only) | ### See Also diff --git a/english/net/groupdocs.viewer.options/archiveoptions/archiveoptions/_index.md b/english/net/groupdocs.viewer.options/archiveoptions/archiveoptions/_index.md index c5e6d1428..87b90fa7a 100644 --- a/english/net/groupdocs.viewer.options/archiveoptions/archiveoptions/_index.md +++ b/english/net/groupdocs.viewer.options/archiveoptions/archiveoptions/_index.md @@ -1,14 +1,14 @@ --- title: ArchiveOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ArchiveOptionsgroupdocs.viewer.options/archiveoptions class. +description: Initializes an instance of the ArchiveOptionsgroupdocs.viewer.options/archiveoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/archiveoptions/archiveoptions/ --- ## ArchiveOptions constructor -Initializes new instance of [`ArchiveOptions`](../../archiveoptions) class. +Initializes an instance of the [`ArchiveOptions`](../../archiveoptions) class. ```csharp public ArchiveOptions() diff --git a/english/net/groupdocs.viewer.options/archiveoptions/filename/_index.md b/english/net/groupdocs.viewer.options/archiveoptions/filename/_index.md index 92a109815..aa3d9e003 100644 --- a/english/net/groupdocs.viewer.options/archiveoptions/filename/_index.md +++ b/english/net/groupdocs.viewer.options/archiveoptions/filename/_index.md @@ -1,19 +1,25 @@ --- title: FileName second_title: GroupDocs.Viewer for .NET API Reference -description: The filename to display in the header. By default the name of the source file is displayed. +description: Sets the displayed archive file name. type: docs weight: 20 url: /net/groupdocs.viewer.options/archiveoptions/filename/ --- ## ArchiveOptions.FileName property -The filename to display in the header. By default the name of the source file is displayed. +Sets the displayed archive file name. ```csharp public FileName FileName { get; set; } ``` +### Remarks + +By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property. + +For more information and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/#specify-the-archive-file-name). + ### See Also * class [FileName](../../filename) diff --git a/english/net/groupdocs.viewer.options/archiveoptions/folder/_index.md b/english/net/groupdocs.viewer.options/archiveoptions/folder/_index.md index f6320df8a..664966bce 100644 --- a/english/net/groupdocs.viewer.options/archiveoptions/folder/_index.md +++ b/english/net/groupdocs.viewer.options/archiveoptions/folder/_index.md @@ -1,19 +1,25 @@ --- title: Folder second_title: GroupDocs.Viewer for .NET API Reference -description: The folder inside the archive to be rendered. +description: Sets the folder to be rendered. type: docs weight: 30 url: /net/groupdocs.viewer.options/archiveoptions/folder/ --- ## ArchiveOptions.Folder property -The folder inside the archive to be rendered. +Sets the folder to be rendered. ```csharp public string Folder { get; set; } ``` +### Remarks + +By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/#render-a-specific-folder). + ### See Also * class [ArchiveOptions](../../archiveoptions) diff --git a/english/net/groupdocs.viewer.options/archiveoptions/itemsperpage/_index.md b/english/net/groupdocs.viewer.options/archiveoptions/itemsperpage/_index.md index 86bf1269a..4a6aeb0f6 100644 --- a/english/net/groupdocs.viewer.options/archiveoptions/itemsperpage/_index.md +++ b/english/net/groupdocs.viewer.options/archiveoptions/itemsperpage/_index.md @@ -10,10 +10,18 @@ url: /net/groupdocs.viewer.options/archiveoptions/itemsperpage/ Number of records per page (for rendering to HTML only) +Sets the number of archive items to display on each HTML page. + ```csharp public int ItemsPerPage { get; set; } ``` +### Remarks + +Use this property to set the number of archive items to display on each HTML page. The default value is `16`. This option is available for rendering to HTML format. + +For more information and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/#specify-the-number-of-items-to-render). + ### See Also * class [ArchiveOptions](../../archiveoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/_index.md index 357bbbec6..2401e6ad3 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: BaseViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides base rendering options. +description: Contains the base rendering options. type: docs weight: 250 url: /net/groupdocs.viewer.options/baseviewoptions/ --- ## BaseViewOptions class -Provides base rendering options. +Contains the base rendering options. ```csharp public abstract class BaseViewOptions @@ -20,21 +20,21 @@ public abstract class BaseViewOptions | --- | --- | | [ArchiveOptions](../../groupdocs.viewer.options/baseviewoptions/archiveoptions) { get; set; } | The archive files view options. | | [CadOptions](../../groupdocs.viewer.options/baseviewoptions/cadoptions) { get; set; } | The CAD drawing view options. | -| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Default font to be used when particular font used in document can't be found. | +| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Sets the default font for a document. | | [EmailOptions](../../groupdocs.viewer.options/baseviewoptions/emailoptions) { get; set; } | The email messages view options. | | [MailStorageOptions](../../groupdocs.viewer.options/baseviewoptions/mailstorageoptions) { get; set; } | Mail storage data files view options. | -| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The MS Outlook data files view options. | -| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF documents view options. | -| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation processing documents view options. | +| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The Microsoft Outlook data files view options. | +| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF document view options. | +| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation files view options. | | [ProjectManagementOptions](../../groupdocs.viewer.options/baseviewoptions/projectmanagementoptions) { get; set; } | The project management files view options. | | [RenderComments](../../groupdocs.viewer.options/baseviewoptions/rendercomments) { get; set; } | Enables rendering comments. | | [RenderHiddenPages](../../groupdocs.viewer.options/baseviewoptions/renderhiddenpages) { get; set; } | Enables rendering of hidden pages. | | [RenderNotes](../../groupdocs.viewer.options/baseviewoptions/rendernotes) { get; set; } | Enables rendering notes. | | [SpreadsheetOptions](../../groupdocs.viewer.options/baseviewoptions/spreadsheetoptions) { get; set; } | The spreadsheet files view options. | -| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files splitting to pages options. | -| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files processing documents view options. | -| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files view options. | +| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files view options. | +| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | The Web files view options. | +| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | The Word processing files view options. | ### See Also diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/archiveoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/archiveoptions/_index.md index f195ee641..3c84ad87d 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/archiveoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/archiveoptions/_index.md @@ -14,6 +14,10 @@ The archive files view options. public ArchiveOptions ArchiveOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/). + ### See Also * class [ArchiveOptions](../../archiveoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/cadoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/cadoptions/_index.md index 2d1be28e5..e327aa1ce 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/cadoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/cadoptions/_index.md @@ -14,6 +14,10 @@ The CAD drawing view options. public CadOptions CadOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/) and [Specify rendering options for CAD files](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/). + ### See Also * class [CadOptions](../../cadoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/defaultfontname/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/defaultfontname/_index.md index 915785eca..935c3dd3e 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/defaultfontname/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/defaultfontname/_index.md @@ -1,19 +1,25 @@ --- title: DefaultFontName second_title: GroupDocs.Viewer for .NET API Reference -description: Default font to be used when particular font used in document cant be found. +description: Sets the default font for a document. type: docs weight: 30 url: /net/groupdocs.viewer.options/baseviewoptions/defaultfontname/ --- ## BaseViewOptions.DefaultFontName property -Default font to be used when particular font used in document can't be found. +Sets the default font for a document. ```csharp public string DefaultFontName { get; set; } ``` +### Remarks + +Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts. + +For code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/replace-missing-font/). + ### See Also * class [BaseViewOptions](../../baseviewoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/emailoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/emailoptions/_index.md index 3a9bf4299..9a364f64c 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/emailoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/emailoptions/_index.md @@ -14,6 +14,10 @@ The email messages view options. public EmailOptions EmailOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/). + ### See Also * class [EmailOptions](../../emailoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/mailstorageoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/mailstorageoptions/_index.md index 77df6b416..4102a36b0 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/mailstorageoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/mailstorageoptions/_index.md @@ -14,6 +14,10 @@ Mail storage data files view options. public MailStorageOptions MailStorageOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/). + ### See Also * class [MailStorageOptions](../../mailstorageoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/outlookoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/outlookoptions/_index.md index 8915883a8..4f58326a4 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/outlookoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/outlookoptions/_index.md @@ -1,19 +1,23 @@ --- title: OutlookOptions second_title: GroupDocs.Viewer for .NET API Reference -description: The MS Outlook data files view options. +description: The Microsoft Outlook data files view options. type: docs weight: 60 url: /net/groupdocs.viewer.options/baseviewoptions/outlookoptions/ --- ## BaseViewOptions.OutlookOptions property -The MS Outlook data files view options. +The Microsoft Outlook data files view options. ```csharp public OutlookOptions OutlookOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/). + ### See Also * class [OutlookOptions](../../outlookoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/pdfoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/pdfoptions/_index.md index 871be9859..d34e4b283 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/pdfoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/pdfoptions/_index.md @@ -1,19 +1,23 @@ --- title: PdfOptions second_title: GroupDocs.Viewer for .NET API Reference -description: The PDF documents view options. +description: The PDF document view options. type: docs weight: 70 url: /net/groupdocs.viewer.options/baseviewoptions/pdfoptions/ --- ## BaseViewOptions.PdfOptions property -The PDF documents view options. +The PDF document view options. ```csharp public PdfOptions PdfOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/). + ### See Also * class [PdfOptions](../../pdfoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/presentationoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/presentationoptions/_index.md index 41df0a80b..6cad77084 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/presentationoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/presentationoptions/_index.md @@ -1,19 +1,23 @@ --- title: PresentationOptions second_title: GroupDocs.Viewer for .NET API Reference -description: The presentation processing documents view options. +description: The presentation files view options. type: docs weight: 80 url: /net/groupdocs.viewer.options/baseviewoptions/presentationoptions/ --- ## BaseViewOptions.PresentationOptions property -The presentation processing documents view options. +The presentation files view options. ```csharp public PresentationOptions PresentationOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/). + ### See Also * class [PresentationOptions](../../presentationoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/projectmanagementoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/projectmanagementoptions/_index.md index 1c81dd8be..a79b17439 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/projectmanagementoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/projectmanagementoptions/_index.md @@ -14,6 +14,10 @@ The project management files view options. public ProjectManagementOptions ProjectManagementOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/). + ### See Also * class [ProjectManagementOptions](../../projectmanagementoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/rendercomments/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/rendercomments/_index.md index 3b1997c2f..00a76f0de 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/rendercomments/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/rendercomments/_index.md @@ -14,6 +14,12 @@ Enables rendering comments. public bool RenderComments { get; set; } ``` +### Remarks + +By default, GroupDocs.Viewer does not render comments. To do this, set this property to `true`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#render-comments). + ### See Also * class [BaseViewOptions](../../baseviewoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/renderhiddenpages/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/renderhiddenpages/_index.md index 9ed27e8b2..d29ef00e0 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/renderhiddenpages/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/renderhiddenpages/_index.md @@ -14,6 +14,12 @@ Enables rendering of hidden pages. public bool RenderHiddenPages { get; set; } ``` +### Remarks + +Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to `true`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/#render-hidden-slides). + ### See Also * class [BaseViewOptions](../../baseviewoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/rendernotes/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/rendernotes/_index.md index 402336400..948e03580 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/rendernotes/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/rendernotes/_index.md @@ -14,6 +14,12 @@ Enables rendering notes. public bool RenderNotes { get; set; } ``` +### Remarks + +Some files, such as presentations or Microsoft project files, may contain notes. By default, GroupDocs.Viewer does not render notes. To do this, set this property to `true`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/#render-speaker-notes). + ### See Also * class [BaseViewOptions](../../baseviewoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/spreadsheetoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/spreadsheetoptions/_index.md index cbca70208..0317445da 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/spreadsheetoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/spreadsheetoptions/_index.md @@ -14,6 +14,10 @@ The spreadsheet files view options. public SpreadsheetOptions SpreadsheetOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/), [Split a worksheet into pages](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/), and [Specify spreadsheet rendering options](https://docs.groupdocs.com/viewer/net/specify-rendering-options/). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/textoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/textoptions/_index.md index dddd4c737..d1e3b7598 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/textoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/textoptions/_index.md @@ -1,19 +1,23 @@ --- title: TextOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Text files splitting to pages options. +description: Text files view options. type: docs weight: 140 url: /net/groupdocs.viewer.options/baseviewoptions/textoptions/ --- ## BaseViewOptions.TextOptions property -Text files splitting to pages options. +Text files view options. ```csharp public TextOptions TextOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/). + ### See Also * class [TextOptions](../../textoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/visiorenderingoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/visiorenderingoptions/_index.md index beb047b74..68f9b3419 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/visiorenderingoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/visiorenderingoptions/_index.md @@ -1,19 +1,23 @@ --- title: VisioRenderingOptions second_title: GroupDocs.Viewer for .NET API Reference -description: The Visio files processing documents view options. +description: The Visio files view options. type: docs weight: 150 url: /net/groupdocs.viewer.options/baseviewoptions/visiorenderingoptions/ --- ## BaseViewOptions.VisioRenderingOptions property -The Visio files processing documents view options. +The Visio files view options. ```csharp public VisioRenderingOptions VisioRenderingOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/). + ### See Also * class [VisioRenderingOptions](../../visiorenderingoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/webdocumentoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/webdocumentoptions/_index.md index d507cc076..2772aa7ee 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/webdocumentoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/webdocumentoptions/_index.md @@ -1,19 +1,23 @@ --- title: WebDocumentOptions second_title: GroupDocs.Viewer for .NET API Reference -description: This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. +description: The Web files view options. type: docs weight: 160 url: /net/groupdocs.viewer.options/baseviewoptions/webdocumentoptions/ --- ## BaseViewOptions.WebDocumentOptions property -This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. +The Web files view options. ```csharp public WebDocumentOptions WebDocumentOptions { get; set; } ``` +### Remarks + +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/). + ### See Also * class [WebDocumentOptions](../../webdocumentoptions) diff --git a/english/net/groupdocs.viewer.options/baseviewoptions/wordprocessingoptions/_index.md b/english/net/groupdocs.viewer.options/baseviewoptions/wordprocessingoptions/_index.md index 1a1bbefdf..f0bed98e0 100644 --- a/english/net/groupdocs.viewer.options/baseviewoptions/wordprocessingoptions/_index.md +++ b/english/net/groupdocs.viewer.options/baseviewoptions/wordprocessingoptions/_index.md @@ -1,14 +1,14 @@ --- title: WordProcessingOptions second_title: GroupDocs.Viewer for .NET API Reference -description: This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. +description: The Word processing files view options. type: docs weight: 170 url: /net/groupdocs.viewer.options/baseviewoptions/wordprocessingoptions/ --- ## BaseViewOptions.WordProcessingOptions property -This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. +The Word processing files view options. ```csharp public WordProcessingOptions WordProcessingOptions { get; set; } @@ -16,7 +16,7 @@ public WordProcessingOptions WordProcessingOptions { get; set; } ### Remarks -See also Render Word documents as HTML, PDF, or image files for more details and code snippets. +For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/). ### See Also diff --git a/english/net/groupdocs.viewer.options/cadoptions/_index.md b/english/net/groupdocs.viewer.options/cadoptions/_index.md index 3ad94ceff..3ca4a09ac 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/_index.md @@ -1,14 +1,14 @@ --- title: CadOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering CAD drawings. +description: Contains options for rendering CAD drawings. For more information and code examples see the Render CAD drawings and models as HTML PDF and image fileshttps//docs.groupdocs.com/viewer/net/rendercaddrawingsandmodels/ and Specify rendering options for CAD fileshttps//docs.groupdocs.com/viewer/net/specifycadrenderingoptions/. type: docs weight: 260 url: /net/groupdocs.viewer.options/cadoptions/ --- ## CadOptions class -Provides options for rendering CAD drawings. +Contains options for rendering CAD drawings. For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/) and [Specify rendering options for CAD files](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/). ```csharp public class CadOptions @@ -18,24 +18,24 @@ public class CadOptions | Name | Description | | --- | --- | -| [BackgroundColor](../../groupdocs.viewer.options/cadoptions/backgroundcolor) { get; set; } | Image background color | -| [Height](../../groupdocs.viewer.options/cadoptions/height) { get; } | The height of the output result in pixels. | +| [BackgroundColor](../../groupdocs.viewer.options/cadoptions/backgroundcolor) { get; set; } | Image background color. | +| [Height](../../groupdocs.viewer.options/cadoptions/height) { get; } | The height of the output result (in pixels). | | [Layers](../../groupdocs.viewer.options/cadoptions/layers) { get; set; } | The CAD drawing layers to render. | | [LayoutName](../../groupdocs.viewer.options/cadoptions/layoutname) { get; set; } | The name of the specific layout to render. Layout name is case-sensitive. | | [Pc3File](../../groupdocs.viewer.options/cadoptions/pc3file) { get; set; } | PC3 - plotter configuration file | -| [RenderLayouts](../../groupdocs.viewer.options/cadoptions/renderlayouts) { get; set; } | Indicates whether layouts from CAD document should be rendered. | -| [ScaleFactor](../../groupdocs.viewer.options/cadoptions/scalefactor) { get; } | Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller. | +| [RenderLayouts](../../groupdocs.viewer.options/cadoptions/renderlayouts) { get; set; } | Flag if layouts from CAD document should be rendered. | +| [ScaleFactor](../../groupdocs.viewer.options/cadoptions/scalefactor) { get; } | Value higher than 1 enlarges output result; value between 0 and 1 reduces output result. | | [Tiles](../../groupdocs.viewer.options/cadoptions/tiles) { get; set; } | The drawing regions to render. | -| [Width](../../groupdocs.viewer.options/cadoptions/width) { get; } | The width of the output result in pixels. | +| [Width](../../groupdocs.viewer.options/cadoptions/width) { get; } | The width of the output result (in pixels). | ## Methods | Name | Description | | --- | --- | -| static [ForRenderingByHeight](../../groupdocs.viewer.options/cadoptions/forrenderingbyheight)(int) | Initializes new instance of [`CadOptions`](../cadoptions) class for rendering by height. | -| static [ForRenderingByScaleFactor](../../groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor)(float) | Initializes new instance of [`CadOptions`](../cadoptions) class for rendering by scale factor. | -| static [ForRenderingByWidth](../../groupdocs.viewer.options/cadoptions/forrenderingbywidth)(int) | Initializes new instance of [`CadOptions`](../cadoptions) class for rendering by width. | -| static [ForRenderingByWidthAndHeight](../../groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight)(int, int) | Initializes new instance of [`CadOptions`](../cadoptions) class for rendering by width and height. | +| static [ForRenderingByHeight](../../groupdocs.viewer.options/cadoptions/forrenderingbyheight)(int) | Initializes an instance of the [`CadOptions`](../cadoptions) class for rendering by height. | +| static [ForRenderingByScaleFactor](../../groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor)(float) | Initializes an instance of the [`CadOptions`](../cadoptions) class for rendering by scale factor. | +| static [ForRenderingByWidth](../../groupdocs.viewer.options/cadoptions/forrenderingbywidth)(int) | Initializes an instance of the [`CadOptions`](../cadoptions) class for rendering by width. | +| static [ForRenderingByWidthAndHeight](../../groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight)(int, int) | Initializes an instance of the [`CadOptions`](../cadoptions) class for rendering by width and height. | ### See Also diff --git a/english/net/groupdocs.viewer.options/cadoptions/backgroundcolor/_index.md b/english/net/groupdocs.viewer.options/cadoptions/backgroundcolor/_index.md index d8e535a2e..547644a28 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/backgroundcolor/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/backgroundcolor/_index.md @@ -1,14 +1,14 @@ --- title: BackgroundColor second_title: GroupDocs.Viewer for .NET API Reference -description: Image background color +description: Image background color. type: docs weight: 50 url: /net/groupdocs.viewer.options/cadoptions/backgroundcolor/ --- ## CadOptions.BackgroundColor property -Image background color +Image background color. ```csharp public Color BackgroundColor { get; set; } diff --git a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyheight/_index.md b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyheight/_index.md index 409f317f5..677d27c8c 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyheight/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyheight/_index.md @@ -1,14 +1,14 @@ --- title: ForRenderingByHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by height. +description: Initializes an instance of the CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by height. type: docs weight: 10 url: /net/groupdocs.viewer.options/cadoptions/forrenderingbyheight/ --- ## CadOptions.ForRenderingByHeight method -Initializes new instance of [`CadOptions`](../../cadoptions) class for rendering by height. +Initializes an instance of the [`CadOptions`](../../cadoptions) class for rendering by height. ```csharp public static CadOptions ForRenderingByHeight(int height) @@ -16,11 +16,11 @@ public static CadOptions ForRenderingByHeight(int height) | Parameter | Type | Description | | --- | --- | --- | -| height | Int32 | The height of the output result in pixels. | +| height | Int32 | The height of the output result (in pixels). | ### Return Value -New instance of [`CadOptions`](../../cadoptions) class for rendering by height. +New instance of the [`CadOptions`](../../cadoptions) class for rendering by height. ### Exceptions @@ -28,6 +28,10 @@ New instance of [`CadOptions`](../../cadoptions) class for rendering by height. | --- | --- | | ArgumentException | Thrown when *height* is less or equal to zero. | +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size). + ### See Also * class [CadOptions](../../cadoptions) diff --git a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor/_index.md b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor/_index.md index 877cb3ebd..00ebe7196 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor/_index.md @@ -1,14 +1,14 @@ --- title: ForRenderingByScaleFactor second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by scale factor. +description: Initializes an instance of the CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by scale factor. type: docs weight: 20 url: /net/groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor/ --- ## CadOptions.ForRenderingByScaleFactor method -Initializes new instance of [`CadOptions`](../../cadoptions) class for rendering by scale factor. +Initializes an instance of the [`CadOptions`](../../cadoptions) class for rendering by scale factor. ```csharp public static CadOptions ForRenderingByScaleFactor(float scaleFactor) @@ -16,11 +16,21 @@ public static CadOptions ForRenderingByScaleFactor(float scaleFactor) | Parameter | Type | Description | | --- | --- | --- | -| scaleFactor | Single | Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller. | +| scaleFactor | Single | Value higher than 1 enlarges output result; value between 0 and 1 reduces output result. | ### Return Value -New instance of [`CadOptions`](../../cadoptions) class for rendering by scale factor. +New instance of the [`CadOptions`](../../cadoptions) class for rendering by scale factor. + +### Exceptions + +| exception | condition | +| --- | --- | +| ArgumentException | Thrown when *scaleFactor* is less or equal to zero. | + +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size). ### See Also diff --git a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidth/_index.md b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidth/_index.md index 528c268ec..53ba9df04 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidth/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidth/_index.md @@ -1,14 +1,14 @@ --- title: ForRenderingByWidth second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by width. +description: Initializes an instance of the CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by width. type: docs weight: 30 url: /net/groupdocs.viewer.options/cadoptions/forrenderingbywidth/ --- ## CadOptions.ForRenderingByWidth method -Initializes new instance of [`CadOptions`](../../cadoptions) class for rendering by width. +Initializes an instance of the [`CadOptions`](../../cadoptions) class for rendering by width. ```csharp public static CadOptions ForRenderingByWidth(int width) @@ -16,11 +16,11 @@ public static CadOptions ForRenderingByWidth(int width) | Parameter | Type | Description | | --- | --- | --- | -| width | Int32 | The width of the output result in pixels. | +| width | Int32 | The width of the output result (in pixels). | ### Return Value -New instance of [`CadOptions`](../../cadoptions) class for rendering by width. +New instance of the [`CadOptions`](../../cadoptions) class for rendering by width. ### Exceptions @@ -28,6 +28,10 @@ New instance of [`CadOptions`](../../cadoptions) class for rendering by width. | --- | --- | | ArgumentException | Thrown when *width* is less or equal to zero. | +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size). + ### See Also * class [CadOptions](../../cadoptions) diff --git a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight/_index.md b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight/_index.md index b8e73331d..618d4bb43 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight/_index.md @@ -1,14 +1,14 @@ --- title: ForRenderingByWidthAndHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by width and height. +description: Initializes an instance of the CadOptionsgroupdocs.viewer.options/cadoptions class for rendering by width and height. type: docs weight: 40 url: /net/groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight/ --- ## CadOptions.ForRenderingByWidthAndHeight method -Initializes new instance of [`CadOptions`](../../cadoptions) class for rendering by width and height. +Initializes an instance of the [`CadOptions`](../../cadoptions) class for rendering by width and height. ```csharp public static CadOptions ForRenderingByWidthAndHeight(int width, int height) @@ -16,8 +16,8 @@ public static CadOptions ForRenderingByWidthAndHeight(int width, int height) | Parameter | Type | Description | | --- | --- | --- | -| width | Int32 | The width of the output result in pixels. | -| height | Int32 | The height of the output result in pixels. | +| width | Int32 | The width of the output result (in pixels). | +| height | Int32 | The height of the output result (in pixels). | ### Return Value @@ -30,6 +30,10 @@ New instance of [`CadOptions`](../../cadoptions) class for rendering by width an | ArgumentException | Thrown when *width* is less or equal to zero. | | ArgumentException | Thrown when *height* is less or equal to zero. | +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size). + ### See Also * class [CadOptions](../../cadoptions) diff --git a/english/net/groupdocs.viewer.options/cadoptions/height/_index.md b/english/net/groupdocs.viewer.options/cadoptions/height/_index.md index a1d332817..cabe28973 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/height/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/height/_index.md @@ -8,7 +8,7 @@ url: /net/groupdocs.viewer.options/cadoptions/height/ --- ## CadOptions.Height property -The height of the output result in pixels. +The height of the output result (in pixels). ```csharp public int Height { get; } diff --git a/english/net/groupdocs.viewer.options/cadoptions/layers/_index.md b/english/net/groupdocs.viewer.options/cadoptions/layers/_index.md index 10d731194..69bfd6c4c 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/layers/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/layers/_index.md @@ -16,7 +16,7 @@ public IList Layers { get; set; } ### Remarks -By default all layers are rendered; Layer names are case-sensitive. +By default all layers are rendered. Layer names are case-sensitive. ### See Also diff --git a/english/net/groupdocs.viewer.options/cadoptions/layoutname/_index.md b/english/net/groupdocs.viewer.options/cadoptions/layoutname/_index.md index 0b4a56fb5..b95644b00 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/layoutname/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/layoutname/_index.md @@ -16,7 +16,7 @@ public string LayoutName { get; set; } ### Remarks -This option applies only to CAD drawings that support layouts [`DXF`](../../../groupdocs.viewer/filetype/dxf), [`DWG`](../../../groupdocs.viewer/filetype/dwg), [`DWT`](../../../groupdocs.viewer/filetype/dwt), and [`DWF`](../../../groupdocs.viewer/filetype/dwf) and also [`DWFX`](../../../groupdocs.viewer/filetype/dwfx); By default only Model is rendered. +This option is available only for the CAD drawings that support layouts: [`DXF`](../../../groupdocs.viewer/filetype/dxf), [`DWG`](../../../groupdocs.viewer/filetype/dwg), [`DWT`](../../../groupdocs.viewer/filetype/dwt), [`DWF`](../../../groupdocs.viewer/filetype/dwf), and [`DWFX`](../../../groupdocs.viewer/filetype/dwfx); By default only the Model is rendered. ### See Also diff --git a/english/net/groupdocs.viewer.options/cadoptions/renderlayouts/_index.md b/english/net/groupdocs.viewer.options/cadoptions/renderlayouts/_index.md index 5b72dda95..9c2da0601 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/renderlayouts/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/renderlayouts/_index.md @@ -1,14 +1,14 @@ --- title: RenderLayouts second_title: GroupDocs.Viewer for .NET API Reference -description: Indicates whether layouts from CAD document should be rendered. +description: Flag if layouts from CAD document should be rendered. type: docs weight: 100 url: /net/groupdocs.viewer.options/cadoptions/renderlayouts/ --- ## CadOptions.RenderLayouts property -Indicates whether layouts from CAD document should be rendered. +Flag if layouts from CAD document should be rendered. ```csharp public bool RenderLayouts { get; set; } @@ -16,7 +16,7 @@ public bool RenderLayouts { get; set; } ### Remarks -This option applies only to CAD drawings that support layouts [`DXF`](../../../groupdocs.viewer/filetype/dxf), [`DWG`](../../../groupdocs.viewer/filetype/dwg), [`DWT`](../../../groupdocs.viewer/filetype/dwt), and [`DWF`](../../../groupdocs.viewer/filetype/dwf) and also [`DWFX`](../../../groupdocs.viewer/filetype/dwfx); By default only Model is rendered. +This option is available only for the CAD drawings that support layouts [`DXF`](../../../groupdocs.viewer/filetype/dxf), [`DWG`](../../../groupdocs.viewer/filetype/dwg), [`DWT`](../../../groupdocs.viewer/filetype/dwt), and [`DWF`](../../../groupdocs.viewer/filetype/dwf), and [`DWFX`](../../../groupdocs.viewer/filetype/dwfx). By default only the Model is rendered. ### See Also diff --git a/english/net/groupdocs.viewer.options/cadoptions/scalefactor/_index.md b/english/net/groupdocs.viewer.options/cadoptions/scalefactor/_index.md index c4c63466d..9fd948a5e 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/scalefactor/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/scalefactor/_index.md @@ -1,14 +1,14 @@ --- title: ScaleFactor second_title: GroupDocs.Viewer for .NET API Reference -description: Values higher than 1 will enlarge output result values between 0 and 1 will make output result smaller. +description: Value higher than 1 enlarges output result value between 0 and 1 reduces output result. type: docs weight: 110 url: /net/groupdocs.viewer.options/cadoptions/scalefactor/ --- ## CadOptions.ScaleFactor property -Values higher than 1 will enlarge output result; values between 0 and 1 will make output result smaller. +Value higher than 1 enlarges output result; value between 0 and 1 reduces output result. ```csharp public float ScaleFactor { get; } diff --git a/english/net/groupdocs.viewer.options/cadoptions/tiles/_index.md b/english/net/groupdocs.viewer.options/cadoptions/tiles/_index.md index 26995e703..0443b9ce5 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/tiles/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/tiles/_index.md @@ -16,7 +16,7 @@ public IList Tiles { get; set; } ### Remarks -This option supported only for [`DWG`](../../../groupdocs.viewer/filetype/dwg) and [`DWT`](../../../groupdocs.viewer/filetype/dwt) file types. The [`RenderLayouts`](../renderlayouts) and [`LayoutName`](../layoutname) options are ignored when rendering by tiles. +This option is available only for the [`DWG`](../../../groupdocs.viewer/filetype/dwg) and [`DWT`](../../../groupdocs.viewer/filetype/dwt) file types. The [`RenderLayouts`](../renderlayouts) and [`LayoutName`](../layoutname) options are ignored when rendering by tiles. ### See Also diff --git a/english/net/groupdocs.viewer.options/cadoptions/width/_index.md b/english/net/groupdocs.viewer.options/cadoptions/width/_index.md index a581f98dc..41976405a 100644 --- a/english/net/groupdocs.viewer.options/cadoptions/width/_index.md +++ b/english/net/groupdocs.viewer.options/cadoptions/width/_index.md @@ -8,7 +8,7 @@ url: /net/groupdocs.viewer.options/cadoptions/width/ --- ## CadOptions.Width property -The width of the output result in pixels. +The width of the output result (in pixels). ```csharp public int Width { get; } diff --git a/english/net/groupdocs.viewer.options/emailoptions/_index.md b/english/net/groupdocs.viewer.options/emailoptions/_index.md index 5749303da..e6bf4d79d 100644 --- a/english/net/groupdocs.viewer.options/emailoptions/_index.md +++ b/english/net/groupdocs.viewer.options/emailoptions/_index.md @@ -1,14 +1,14 @@ --- title: EmailOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering email messages. +description: Contains options for rendering email messages. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderemailmessages/. type: docs weight: 270 url: /net/groupdocs.viewer.options/emailoptions/ --- ## EmailOptions class -Provides options for rendering email messages. +Contains options for rendering email messages. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/). ```csharp public class EmailOptions @@ -18,16 +18,16 @@ public class EmailOptions | Name | Description | | --- | --- | -| [EmailOptions](emailoptions)() | Initializes new instance of [`EmailOptions`](../emailoptions) class. | +| [EmailOptions](emailoptions)() | Initializes an instance of the [`EmailOptions`](../emailoptions) class. | ## Properties | Name | Description | | --- | --- | -| [DateTimeFormat](../../groupdocs.viewer.options/emailoptions/datetimeformat) { get; set; } | Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used | +| [DateTimeFormat](../../groupdocs.viewer.options/emailoptions/datetimeformat) { get; set; } | Time Format (can be include TimeZone). For example: 'MM d yyyy HH:mm tt', if not set - current system format is used | | [FieldTextMap](../../groupdocs.viewer.options/emailoptions/fieldtextmap) { get; set; } | The mapping between email message [`Field`](../field) and field text representation. | | [PageSize](../../groupdocs.viewer.options/emailoptions/pagesize) { get; set; } | The size of the output page. | -| [TimeZoneOffset](../../groupdocs.viewer.options/emailoptions/timezoneoffset) { get; set; } | Message time zone offset | +| [TimeZoneOffset](../../groupdocs.viewer.options/emailoptions/timezoneoffset) { get; set; } | Message time zone offset. | ### See Also diff --git a/english/net/groupdocs.viewer.options/emailoptions/datetimeformat/_index.md b/english/net/groupdocs.viewer.options/emailoptions/datetimeformat/_index.md index 741f5ab13..0782e47d1 100644 --- a/english/net/groupdocs.viewer.options/emailoptions/datetimeformat/_index.md +++ b/english/net/groupdocs.viewer.options/emailoptions/datetimeformat/_index.md @@ -1,19 +1,23 @@ --- title: DateTimeFormat second_title: GroupDocs.Viewer for .NET API Reference -description: Time Format can be include TimeZone for example MM d yyyy HHmm tt if not set current system format is used +description: Time Format can be include TimeZone. For example MM d yyyy HHmm tt if not set current system format is used type: docs weight: 20 url: /net/groupdocs.viewer.options/emailoptions/datetimeformat/ --- ## EmailOptions.DateTimeFormat property -Time Format (can be include TimeZone) for example: 'MM d yyyy HH:mm tt', if not set - current system format is used +Time Format (can be include TimeZone). For example: 'MM d yyyy HH:mm tt', if not set - current system format is used ```csharp public string DateTimeFormat { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone). + ### See Also * class [EmailOptions](../../emailoptions) diff --git a/english/net/groupdocs.viewer.options/emailoptions/emailoptions/_index.md b/english/net/groupdocs.viewer.options/emailoptions/emailoptions/_index.md index e905197e3..f38243ab9 100644 --- a/english/net/groupdocs.viewer.options/emailoptions/emailoptions/_index.md +++ b/english/net/groupdocs.viewer.options/emailoptions/emailoptions/_index.md @@ -1,14 +1,14 @@ --- title: EmailOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of EmailOptionsgroupdocs.viewer.options/emailoptions class. +description: Initializes an instance of the EmailOptionsgroupdocs.viewer.options/emailoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/emailoptions/emailoptions/ --- ## EmailOptions constructor -Initializes new instance of [`EmailOptions`](../../emailoptions) class. +Initializes an instance of the [`EmailOptions`](../../emailoptions) class. ```csharp public EmailOptions() diff --git a/english/net/groupdocs.viewer.options/emailoptions/timezoneoffset/_index.md b/english/net/groupdocs.viewer.options/emailoptions/timezoneoffset/_index.md index 30389f947..7bde52ce8 100644 --- a/english/net/groupdocs.viewer.options/emailoptions/timezoneoffset/_index.md +++ b/english/net/groupdocs.viewer.options/emailoptions/timezoneoffset/_index.md @@ -1,19 +1,23 @@ --- title: TimeZoneOffset second_title: GroupDocs.Viewer for .NET API Reference -description: Message time zone offset +description: Message time zone offset. type: docs weight: 50 url: /net/groupdocs.viewer.options/emailoptions/timezoneoffset/ --- ## EmailOptions.TimeZoneOffset property -Message time zone offset +Message time zone offset. ```csharp public TimeSpan TimeZoneOffset { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone). + ### See Also * class [EmailOptions](../../emailoptions) diff --git a/english/net/groupdocs.viewer.options/field/_index.md b/english/net/groupdocs.viewer.options/field/_index.md index e27d8eb1a..2cc5ff96a 100644 --- a/english/net/groupdocs.viewer.options/field/_index.md +++ b/english/net/groupdocs.viewer.options/field/_index.md @@ -1,14 +1,14 @@ --- title: Field second_title: GroupDocs.Viewer for .NET API Reference -description: Represents email message field e.g. From To Subject etc. +description: Represents email message field e.g. From To Subject etc. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderemailmessages/renamefieldsinthemessageheader. type: docs weight: 280 url: /net/groupdocs.viewer.options/field/ --- ## Field class -Represents email message field e.g. From, To, Subject etc. +Represents email message field e.g. From, To, Subject etc. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#rename-fields-in-the-message-header). ```csharp public class Field diff --git a/english/net/groupdocs.viewer.options/filename/_index.md b/english/net/groupdocs.viewer.options/filename/_index.md index b2da0ad6a..9709aa981 100644 --- a/english/net/groupdocs.viewer.options/filename/_index.md +++ b/english/net/groupdocs.viewer.options/filename/_index.md @@ -18,7 +18,7 @@ public class FileName | Name | Description | | --- | --- | -| [FileName](filename)(string) | Initializes new instance of [`FileName`](../filename) class. | +| [FileName](filename)(string) | Initializes an instance of the [`FileName`](../filename) class. | ## Methods diff --git a/english/net/groupdocs.viewer.options/filename/filename/_index.md b/english/net/groupdocs.viewer.options/filename/filename/_index.md index e3985ff43..8bf1f25db 100644 --- a/english/net/groupdocs.viewer.options/filename/filename/_index.md +++ b/english/net/groupdocs.viewer.options/filename/filename/_index.md @@ -1,14 +1,14 @@ --- title: FileName second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of FileNamegroupdocs.viewer.options/filename class. +description: Initializes an instance of the FileNamegroupdocs.viewer.options/filename class. type: docs weight: 10 url: /net/groupdocs.viewer.options/filename/filename/ --- ## FileName constructor -Initializes new instance of [`FileName`](../../filename) class. +Initializes an instance of the [`FileName`](../../filename) class. ```csharp public FileName(string fileName) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/_index.md index f5e8fcb0c..08bbedb65 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: HtmlViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering documents into HTML format. +description: Contains options for rendering documents into HTML format. For details see the topichttps//docs.groupdocs.com/viewer/net/renderingtohtml/ and its children. type: docs weight: 300 url: /net/groupdocs.viewer.options/htmlviewoptions/ --- ## HtmlViewOptions class -Provides options for rendering documents into HTML format. +Contains options for rendering documents into HTML format. For details, see the [topic](https://docs.groupdocs.com/viewer/net/rendering-to-html/) and its children. ```csharp public class HtmlViewOptions : ViewOptions @@ -20,54 +20,54 @@ public class HtmlViewOptions : ViewOptions | --- | --- | | [ArchiveOptions](../../groupdocs.viewer.options/baseviewoptions/archiveoptions) { get; set; } | The archive files view options. | | [CadOptions](../../groupdocs.viewer.options/baseviewoptions/cadoptions) { get; set; } | The CAD drawing view options. | -| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Default font to be used when particular font used in document can't be found. | +| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Sets the default font for a document. | | [EmailOptions](../../groupdocs.viewer.options/baseviewoptions/emailoptions) { get; set; } | The email messages view options. | -| [ExcludeFonts](../../groupdocs.viewer.options/htmlviewoptions/excludefonts) { get; set; } | When enabled prevents adding any fonts into HTML document. | -| [FontsToExclude](../../groupdocs.viewer.options/htmlviewoptions/fontstoexclude) { get; set; } | The list of font names, to exclude from HTML document. | -| [ForPrinting](../../groupdocs.viewer.options/htmlviewoptions/forprinting) { get; set; } | Indicates whether to optimize output HTML for printing. | -| [ImageHeight](../../groupdocs.viewer.options/htmlviewoptions/imageheight) { get; set; } | The height of an output image in pixels. (When converting single image to HTML only) | -| [ImageMaxHeight](../../groupdocs.viewer.options/htmlviewoptions/imagemaxheight) { get; set; } | Max height of an output image in pixels. (When converting single image to HTML only) | -| [ImageMaxWidth](../../groupdocs.viewer.options/htmlviewoptions/imagemaxwidth) { get; set; } | Max width of an output image in pixels. (When converting single image to HTML only) | -| [ImageWidth](../../groupdocs.viewer.options/htmlviewoptions/imagewidth) { get; set; } | The width of the output image in pixels. (When converting single image to HTML only) | +| [ExcludeFonts](../../groupdocs.viewer.options/htmlviewoptions/excludefonts) { get; set; } | Disables adding any fonts into HTML document. | +| [FontsToExclude](../../groupdocs.viewer.options/htmlviewoptions/fontstoexclude) { get; set; } | The list of font names to exclude from HTML document. | +| [ForPrinting](../../groupdocs.viewer.options/htmlviewoptions/forprinting) { get; set; } | Enables optimization the output HTML for printing. | +| [ImageHeight](../../groupdocs.viewer.options/htmlviewoptions/imageheight) { get; set; } | The height of an output image (in pixels). The property is available when converting single image to HTML only. | +| [ImageMaxHeight](../../groupdocs.viewer.options/htmlviewoptions/imagemaxheight) { get; set; } | Max height of an output image (in pixels). The property is available when converting single image to HTML only. | +| [ImageMaxWidth](../../groupdocs.viewer.options/htmlviewoptions/imagemaxwidth) { get; set; } | Max width of an output image (in pixels). The property is available when converting single image to HTML only. | +| [ImageWidth](../../groupdocs.viewer.options/htmlviewoptions/imagewidth) { get; set; } | The width of the output image (in pixels). The property is available when converting single image to HTML only. | | [MailStorageOptions](../../groupdocs.viewer.options/baseviewoptions/mailstorageoptions) { get; set; } | Mail storage data files view options. | | [Minify](../../groupdocs.viewer.options/htmlviewoptions/minify) { get; set; } | Enables HTML content and HTML resources minification. | -| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The MS Outlook data files view options. | -| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF documents view options. | -| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation processing documents view options. | +| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The Microsoft Outlook data files view options. | +| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF document view options. | +| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation files view options. | | [ProjectManagementOptions](../../groupdocs.viewer.options/baseviewoptions/projectmanagementoptions) { get; set; } | The project management files view options. | | [RenderComments](../../groupdocs.viewer.options/baseviewoptions/rendercomments) { get; set; } | Enables rendering comments. | | [RenderHiddenPages](../../groupdocs.viewer.options/baseviewoptions/renderhiddenpages) { get; set; } | Enables rendering of hidden pages. | | [RenderNotes](../../groupdocs.viewer.options/baseviewoptions/rendernotes) { get; set; } | Enables rendering notes. | -| [RenderResponsive](../../groupdocs.viewer.options/htmlviewoptions/renderresponsive) { get; set; } | Enables responsive rendering; Responsive web-pages render well on a devices with different screen size. | +| [RenderResponsive](../../groupdocs.viewer.options/htmlviewoptions/renderresponsive) { get; set; } | Enables responsive rendering. | | [RenderToSinglePage](../../groupdocs.viewer.options/htmlviewoptions/rendertosinglepage) { get; set; } | Enables rendering an entire document to one HTML file. | | [SpreadsheetOptions](../../groupdocs.viewer.options/baseviewoptions/spreadsheetoptions) { get; set; } | The spreadsheet files view options. | -| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files splitting to pages options. | -| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files processing documents view options. | -| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark applied to each page. | -| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files view options. | +| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files view options. | +| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark to be applied to each page. | +| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | The Web files view options. | +| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | The Word processing files view options. | ## Methods | Name | Description | | --- | --- | -| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources)() | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class. | -| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_1)(CreatePageStream) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with embedded resources. | -| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_3)(IPageStreamFactory) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with embedded resources. | -| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_4)(string) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class. | -| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_2)(CreatePageStream, ReleasePageStream) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with embedded resources. | -| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources)() | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class. | -| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_3)(IPageStreamFactory, IResourceStreamFactory) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with external resources. | -| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_1)(CreatePageStream, CreateResourceStream, CreateResourceUrl) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with external resources. | -| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_4)(string, string, string) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class. | -| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_2)(CreatePageStream, CreateResourceStream, CreateResourceUrl, ReleasePageStream, ReleaseResourceStream) | Initializes new instance of [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with external resources. | -| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies clockwise rotation to the page. | +| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources)() | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class. | +| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_1)(CreatePageStream) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with embedded resources. | +| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_3)(IPageStreamFactory) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with embedded resources. | +| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_4)(string) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class. | +| static [ForEmbeddedResources](../../groupdocs.viewer.options/htmlviewoptions/forembeddedresources#forembeddedresources_2)(CreatePageStream, ReleasePageStream) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with embedded resources. | +| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources)() | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class. | +| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_3)(IPageStreamFactory, IResourceStreamFactory) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with external resources. | +| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_1)(CreatePageStream, CreateResourceStream, CreateResourceUrl) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with external resources. | +| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_4)(string, string, string) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class. | +| static [ForExternalResources](../../groupdocs.viewer.options/htmlviewoptions/forexternalresources#forexternalresources_2)(CreatePageStream, CreateResourceStream, CreateResourceUrl, ReleasePageStream, ReleaseResourceStream) | Initializes an instance of the [`HtmlViewOptions`](../htmlviewoptions) class for rendering into HTML with external resources. | +| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies the clockwise rotation to a page. | ## Fields | Name | Description | | --- | --- | -| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotations. | +| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotation. | ### See Also diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/excludefonts/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/excludefonts/_index.md index ed12f5466..776d6885a 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/excludefonts/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/excludefonts/_index.md @@ -1,19 +1,25 @@ --- title: ExcludeFonts second_title: GroupDocs.Viewer for .NET API Reference -description: When enabled prevents adding any fonts into HTML document. +description: Disables adding any fonts into HTML document. type: docs weight: 30 url: /net/groupdocs.viewer.options/htmlviewoptions/excludefonts/ --- ## HtmlViewOptions.ExcludeFonts property -When enabled prevents adding any fonts into HTML document. +Disables adding any fonts into HTML document. ```csharp public bool ExcludeFonts { get; set; } ``` +### Remarks + +By default, GroupDocs.Viewer embeds the fonts used in the document into HTML. To prevent it, set this property to `true`. + +For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/exclude-fonts/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/fontstoexclude/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/fontstoexclude/_index.md index 586e97c02..75f70e765 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/fontstoexclude/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/fontstoexclude/_index.md @@ -8,7 +8,7 @@ url: /net/groupdocs.viewer.options/htmlviewoptions/fontstoexclude/ --- ## HtmlViewOptions.FontsToExclude property -The list of font names, to exclude from HTML document. +The list of font names to exclude from HTML document. ```csharp public List FontsToExclude { get; set; } @@ -16,7 +16,13 @@ public List FontsToExclude { get; set; } ### Remarks -This option is supported for presentations only. The fonts that are added into HTML document improve stability of the output view, at the same time they increase the size of the rendering result. This option, lets you find compromise, between stability and output size. Include the font names that are popular and installed into most systems. Please note, this property is active only when [`ExcludeFonts`](../excludefonts) options is disabled. +This option is supported for presentations only. + +The fonts that are added into the HTML document improve stability of the output view, at the same time they increase the size of the rendering result. This option lets you balance between stability and output size. Include the font names that are popular and installed into most systems. + +Please note, this property is active only when the [`ExcludeFonts`](../excludefonts) options is disabled. + +For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/exclude-fonts/). ### See Also diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/forembeddedresources/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/forembeddedresources/_index.md index 6db2d1d47..415497588 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/forembeddedresources/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/forembeddedresources/_index.md @@ -1,14 +1,14 @@ --- title: ForEmbeddedResources second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of HtmlViewOptionsgroupdocs.viewer.options/htmlviewoptions class for rendering into HTML with embedded resources. +description: Initializes an instance of the HtmlViewOptionsgroupdocs.viewer.options/htmlviewoptions class for rendering into HTML with embedded resources. type: docs weight: 10 url: /net/groupdocs.viewer.options/htmlviewoptions/forembeddedresources/ --- ## ForEmbeddedResources(CreatePageStream) {#forembeddedresources_1} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. ```csharp public static HtmlViewOptions ForEmbeddedResources(CreatePageStream createPageStream) @@ -20,7 +20,7 @@ public static HtmlViewOptions ForEmbeddedResources(CreatePageStream createPageSt ### Return Value -New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. +New instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. ### Exceptions @@ -28,6 +28,10 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i | --- | --- | | ArgumentNullException | Thrown when *createPageStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -39,7 +43,7 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i ## ForEmbeddedResources(CreatePageStream, ReleasePageStream) {#forembeddedresources_2} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. ```csharp public static HtmlViewOptions ForEmbeddedResources(CreatePageStream createPageStream, @@ -53,7 +57,7 @@ public static HtmlViewOptions ForEmbeddedResources(CreatePageStream createPageSt ### Return Value -New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. +New instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. ### Exceptions @@ -62,6 +66,10 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i | ArgumentNullException | Thrown when *createPageStream* is null. | | ArgumentNullException | Thrown when *releasePageStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -74,7 +82,7 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i ## ForEmbeddedResources(IPageStreamFactory) {#forembeddedresources_3} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. ```csharp public static HtmlViewOptions ForEmbeddedResources(IPageStreamFactory pageStreamFactory) @@ -86,7 +94,7 @@ public static HtmlViewOptions ForEmbeddedResources(IPageStreamFactory pageStream ### Return Value -New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. +New instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with embedded resources. ### Exceptions @@ -94,6 +102,10 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i | --- | --- | | ArgumentNullException | Thrown when *pageStreamFactory* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources). + ### See Also * interface [IPageStreamFactory](../../../groupdocs.viewer.interfaces/ipagestreamfactory) @@ -105,12 +117,16 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i ## ForEmbeddedResources() {#forembeddedresources} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class. ```csharp public static HtmlViewOptions ForEmbeddedResources() ``` +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) @@ -121,7 +137,7 @@ public static HtmlViewOptions ForEmbeddedResources() ## ForEmbeddedResources(string) {#forembeddedresources_4} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class. ```csharp public static HtmlViewOptions ForEmbeddedResources(string filePathFormat) @@ -137,6 +153,10 @@ public static HtmlViewOptions ForEmbeddedResources(string filePathFormat) | --- | --- | | ArgumentException | Thrown when *filePathFormat* is null or empty. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/forexternalresources/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/forexternalresources/_index.md index d02616000..810b67a3a 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/forexternalresources/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/forexternalresources/_index.md @@ -1,14 +1,14 @@ --- title: ForExternalResources second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of HtmlViewOptionsgroupdocs.viewer.options/htmlviewoptions class for rendering into HTML with external resources. +description: Initializes an instance of the HtmlViewOptionsgroupdocs.viewer.options/htmlviewoptions class for rendering into HTML with external resources. type: docs weight: 20 url: /net/groupdocs.viewer.options/htmlviewoptions/forexternalresources/ --- ## ForExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl) {#forexternalresources_1} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. ```csharp public static HtmlViewOptions ForExternalResources(CreatePageStream createPageStream, @@ -23,7 +23,7 @@ public static HtmlViewOptions ForExternalResources(CreatePageStream createPageSt ### Return Value -New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. +New instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. ### Exceptions @@ -33,6 +33,10 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i | ArgumentNullException | Thrown when *createResourceStream* is null. | | ArgumentNullException | Thrown when *createResourceUrl* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -46,7 +50,7 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i ## ForExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl, ReleasePageStream, ReleaseResourceStream) {#forexternalresources_2} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. ```csharp public static HtmlViewOptions ForExternalResources(CreatePageStream createPageStream, @@ -64,7 +68,7 @@ public static HtmlViewOptions ForExternalResources(CreatePageStream createPageSt ### Return Value -New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. +New instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. ### Exceptions @@ -76,6 +80,10 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i | ArgumentNullException | Thrown when *releasePageStream* is null. | | ArgumentNullException | Thrown when *releaseResourceStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -91,7 +99,7 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i ## ForExternalResources(IPageStreamFactory, IResourceStreamFactory) {#forexternalresources_3} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. ```csharp public static HtmlViewOptions ForExternalResources(IPageStreamFactory pageStreamFactory, @@ -105,7 +113,7 @@ public static HtmlViewOptions ForExternalResources(IPageStreamFactory pageStream ### Return Value -New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. +New instance of the [`HtmlViewOptions`](../../htmlviewoptions) class for rendering into HTML with external resources. ### Exceptions @@ -114,6 +122,10 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i | ArgumentNullException | Thrown when *pageStreamFactory* is null. | | ArgumentNullException | Thrown when *resourceStreamFactory* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources). + ### See Also * interface [IPageStreamFactory](../../../groupdocs.viewer.interfaces/ipagestreamfactory) @@ -126,7 +138,7 @@ New instance of [`HtmlViewOptions`](../../htmlviewoptions) class for rendering i ## ForExternalResources() {#forexternalresources} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class. ```csharp public static HtmlViewOptions ForExternalResources() @@ -134,7 +146,15 @@ public static HtmlViewOptions ForExternalResources() ### Remarks -This constructor initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) - with "p_{0}.html" as file path format for the output HTML files; - with "p_{0}_{1}" as file path format for the output HTML-resource files; - with "p_{0}_{1}" as URL format for HTML-resources; The output files will be placed into current working directory of the application. +This constructor initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) + +* with "p_{0}.html" as file path format for the output HTML files +* with "p_{0}_{1}" as file path format for the output HTML-resource files +* with "p_{0}_{1}" as URL format for HTML-resources + +The output files will be placed into current working directory of the application. + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources). ### See Also @@ -146,7 +166,7 @@ This constructor initializes new instance of [`HtmlViewOptions`](../../htmlviewo ## ForExternalResources(string, string, string) {#forexternalresources_4} -Initializes new instance of [`HtmlViewOptions`](../../htmlviewoptions) class. +Initializes an instance of the [`HtmlViewOptions`](../../htmlviewoptions) class. ```csharp public static HtmlViewOptions ForExternalResources(string filePathFormat, @@ -167,6 +187,10 @@ public static HtmlViewOptions ForExternalResources(string filePathFormat, | ArgumentException | Thrown when *resourceFilePathFormat* is null or empty. | | ArgumentException | Thrown when *resourceUrlFormat* is null or empty. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/forprinting/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/forprinting/_index.md index 811fad59d..f5121c20b 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/forprinting/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/forprinting/_index.md @@ -1,19 +1,25 @@ --- title: ForPrinting second_title: GroupDocs.Viewer for .NET API Reference -description: Indicates whether to optimize output HTML for printing. +description: Enables optimization the output HTML for printing. type: docs weight: 50 url: /net/groupdocs.viewer.options/htmlviewoptions/forprinting/ --- ## HtmlViewOptions.ForPrinting property -Indicates whether to optimize output HTML for printing. +Enables optimization the output HTML for printing. ```csharp public bool ForPrinting { get; set; } ``` +### Remarks + +Enable this option to convert the output HTML pages to the vector SVG format. + +For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/how-to-optimize-output-html-for-printing/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/imageheight/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/imageheight/_index.md index 88fca2b8f..3164b5b71 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/imageheight/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/imageheight/_index.md @@ -1,19 +1,23 @@ --- title: ImageHeight second_title: GroupDocs.Viewer for .NET API Reference -description: The height of an output image in pixels. When converting single image to HTML only +description: The height of an output image in pixels. The property is available when converting single image to HTML only. type: docs weight: 60 url: /net/groupdocs.viewer.options/htmlviewoptions/imageheight/ --- ## HtmlViewOptions.ImageHeight property -The height of an output image in pixels. (When converting single image to HTML only) +The height of an output image (in pixels). The property is available when converting single image to HTML only. ```csharp public int ImageHeight { get; set; } ``` +### Remarks + +For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxheight/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxheight/_index.md index 4e7690d9c..21146b2f1 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxheight/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxheight/_index.md @@ -1,19 +1,23 @@ --- title: ImageMaxHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Max height of an output image in pixels. When converting single image to HTML only +description: Max height of an output image in pixels. The property is available when converting single image to HTML only. type: docs weight: 70 url: /net/groupdocs.viewer.options/htmlviewoptions/imagemaxheight/ --- ## HtmlViewOptions.ImageMaxHeight property -Max height of an output image in pixels. (When converting single image to HTML only) +Max height of an output image (in pixels). The property is available when converting single image to HTML only. ```csharp public int ImageMaxHeight { get; set; } ``` +### Remarks + +For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxwidth/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxwidth/_index.md index a7476b925..d421acae5 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxwidth/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/imagemaxwidth/_index.md @@ -1,19 +1,23 @@ --- title: ImageMaxWidth second_title: GroupDocs.Viewer for .NET API Reference -description: Max width of an output image in pixels. When converting single image to HTML only +description: Max width of an output image in pixels. The property is available when converting single image to HTML only. type: docs weight: 80 url: /net/groupdocs.viewer.options/htmlviewoptions/imagemaxwidth/ --- ## HtmlViewOptions.ImageMaxWidth property -Max width of an output image in pixels. (When converting single image to HTML only) +Max width of an output image (in pixels). The property is available when converting single image to HTML only. ```csharp public int ImageMaxWidth { get; set; } ``` +### Remarks + +For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/imagewidth/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/imagewidth/_index.md index 2ab137472..41132ff14 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/imagewidth/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/imagewidth/_index.md @@ -1,19 +1,23 @@ --- title: ImageWidth second_title: GroupDocs.Viewer for .NET API Reference -description: The width of the output image in pixels. When converting single image to HTML only +description: The width of the output image in pixels. The property is available when converting single image to HTML only. type: docs weight: 90 url: /net/groupdocs.viewer.options/htmlviewoptions/imagewidth/ --- ## HtmlViewOptions.ImageWidth property -The width of the output image in pixels. (When converting single image to HTML only) +The width of the output image (in pixels). The property is available when converting single image to HTML only. ```csharp public int ImageWidth { get; set; } ``` +### Remarks + +For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/minify/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/minify/_index.md index f9f2fd9be..598f519ee 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/minify/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/minify/_index.md @@ -14,6 +14,12 @@ Enables HTML content and HTML resources minification. public bool Minify { get; set; } ``` +### Remarks + +Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to `true`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/minify-html/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/renderresponsive/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/renderresponsive/_index.md index 91e4b226a..900658918 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/renderresponsive/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/renderresponsive/_index.md @@ -1,19 +1,25 @@ --- title: RenderResponsive second_title: GroupDocs.Viewer for .NET API Reference -description: Enables responsive rendering Responsive webpages render well on a devices with different screen size. +description: Enables responsive rendering. type: docs weight: 110 url: /net/groupdocs.viewer.options/htmlviewoptions/renderresponsive/ --- ## HtmlViewOptions.RenderResponsive property -Enables responsive rendering; Responsive web-pages render well on a devices with different screen size. +Enables responsive rendering. ```csharp public bool RenderResponsive { get; set; } ``` +### Remarks + +Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to `true`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-with-responsive-layout/). + ### See Also * class [HtmlViewOptions](../../htmlviewoptions) diff --git a/english/net/groupdocs.viewer.options/htmlviewoptions/rendertosinglepage/_index.md b/english/net/groupdocs.viewer.options/htmlviewoptions/rendertosinglepage/_index.md index aacfee312..d6efeb5bf 100644 --- a/english/net/groupdocs.viewer.options/htmlviewoptions/rendertosinglepage/_index.md +++ b/english/net/groupdocs.viewer.options/htmlviewoptions/rendertosinglepage/_index.md @@ -16,28 +16,7 @@ public bool RenderToSinglePage { get; set; } ### Remarks -**See the following topics for more information:** - -* [Render archives as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-archive-files/#create-a-single-html-page) -* [Render text documents as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-text-files/#create-a-single-html-page) -* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/#convert-all-excel-worksheets-to-one-html-file) -* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/#convert-all-excel-worksheets-to-one-html-file) -* [Render web documents as PDF, PNG, and JPEG files](https://docs.groupdocs.com/viewer/net/render-web-documents/#create-an-html-file-with-embedded-resources) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (Viewer viewer = new Viewer("invoice.docx")) -{ - HtmlViewOptions viewOptions = - HtmlViewOptions.ForEmbeddedResources(); - viewOptions.RenderToSinglePage = true; - - viewer.View(viewOptions); -} -``` +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/#create-a-single-html-page). ### See Also diff --git a/english/net/groupdocs.viewer.options/imagequality/_index.md b/english/net/groupdocs.viewer.options/imagequality/_index.md index 11aa3cc1a..9016e5985 100644 --- a/english/net/groupdocs.viewer.options/imagequality/_index.md +++ b/english/net/groupdocs.viewer.options/imagequality/_index.md @@ -20,7 +20,7 @@ public enum ImageQuality | --- | --- | --- | | Low | `96` | The acceptable quality and best performance. | | Medium | `198` | Better quality and slower performance. | -| High | `300` | Best quality but slow performance. | +| High | `300` | The best quality but slow performance. | ### See Also diff --git a/english/net/groupdocs.viewer.options/imaxsizeoptions/_index.md b/english/net/groupdocs.viewer.options/imaxsizeoptions/_index.md index aa4f394bb..f8784c4f4 100644 --- a/english/net/groupdocs.viewer.options/imaxsizeoptions/_index.md +++ b/english/net/groupdocs.viewer.options/imaxsizeoptions/_index.md @@ -18,8 +18,8 @@ public interface IMaxSizeOptions | Name | Description | | --- | --- | -| [MaxHeight](../../groupdocs.viewer.options/imaxsizeoptions/maxheight) { get; set; } | Max height of an output image in pixels. | -| [MaxWidth](../../groupdocs.viewer.options/imaxsizeoptions/maxwidth) { get; set; } | Max width of an output image in pixels. | +| [MaxHeight](../../groupdocs.viewer.options/imaxsizeoptions/maxheight) { get; set; } | Maximum height of an output image in pixels. | +| [MaxWidth](../../groupdocs.viewer.options/imaxsizeoptions/maxwidth) { get; set; } | Maximum width of an output image in pixels. | ### See Also diff --git a/english/net/groupdocs.viewer.options/imaxsizeoptions/maxheight/_index.md b/english/net/groupdocs.viewer.options/imaxsizeoptions/maxheight/_index.md index bf62b3a1b..bec20935d 100644 --- a/english/net/groupdocs.viewer.options/imaxsizeoptions/maxheight/_index.md +++ b/english/net/groupdocs.viewer.options/imaxsizeoptions/maxheight/_index.md @@ -1,14 +1,14 @@ --- title: MaxHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Max height of an output image in pixels. +description: Maximum height of an output image in pixels. type: docs weight: 10 url: /net/groupdocs.viewer.options/imaxsizeoptions/maxheight/ --- ## IMaxSizeOptions.MaxHeight property -Max height of an output image in pixels. +Maximum height of an output image in pixels. ```csharp public int MaxHeight { get; set; } diff --git a/english/net/groupdocs.viewer.options/imaxsizeoptions/maxwidth/_index.md b/english/net/groupdocs.viewer.options/imaxsizeoptions/maxwidth/_index.md index 9fd245f2a..a8d204fc9 100644 --- a/english/net/groupdocs.viewer.options/imaxsizeoptions/maxwidth/_index.md +++ b/english/net/groupdocs.viewer.options/imaxsizeoptions/maxwidth/_index.md @@ -1,14 +1,14 @@ --- title: MaxWidth second_title: GroupDocs.Viewer for .NET API Reference -description: Max width of an output image in pixels. +description: Maximum width of an output image in pixels. type: docs weight: 20 url: /net/groupdocs.viewer.options/imaxsizeoptions/maxwidth/ --- ## IMaxSizeOptions.MaxWidth property -Max width of an output image in pixels. +Maximum width of an output image in pixels. ```csharp public int MaxWidth { get; set; } diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/_index.md index 8e8301ab2..0bbe947c7 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: JpgViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering documents into JPG format. +description: Provides options for rendering documents into JPG format. For details see this pagehttps//docs.groupdocs.com/viewer/net/renderingtopngorjpeg/ and its children. type: docs weight: 330 url: /net/groupdocs.viewer.options/jpgviewoptions/ --- ## JpgViewOptions class -Provides options for rendering documents into JPG format. +Provides options for rendering documents into JPG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children. ```csharp public class JpgViewOptions : ViewOptions, IMaxSizeOptions @@ -18,11 +18,11 @@ public class JpgViewOptions : ViewOptions, IMaxSizeOptions | Name | Description | | --- | --- | -| [JpgViewOptions](jpgviewoptions#constructor)() | Initializes new instance of [`JpgViewOptions`](../jpgviewoptions) class. | -| [JpgViewOptions](jpgviewoptions#constructor_1)(CreatePageStream) | Initializes new instance of [`JpgViewOptions`](../jpgviewoptions) class. | -| [JpgViewOptions](jpgviewoptions#constructor_3)(IPageStreamFactory) | Initializes new instance of [`JpgViewOptions`](../jpgviewoptions) class. | -| [JpgViewOptions](jpgviewoptions#constructor_4)(string) | Initializes new instance of [`JpgViewOptions`](../jpgviewoptions) class. | -| [JpgViewOptions](jpgviewoptions#constructor_2)(CreatePageStream, ReleasePageStream) | Initializes new instance of [`JpgViewOptions`](../jpgviewoptions) class. | +| [JpgViewOptions](jpgviewoptions#constructor)() | Initializes an instance of the [`JpgViewOptions`](../jpgviewoptions) class. | +| [JpgViewOptions](jpgviewoptions#constructor_1)(CreatePageStream) | Initializes an instance of the [`JpgViewOptions`](../jpgviewoptions) class. | +| [JpgViewOptions](jpgviewoptions#constructor_3)(IPageStreamFactory) | Initializes an instance of the [`JpgViewOptions`](../jpgviewoptions) class. | +| [JpgViewOptions](jpgviewoptions#constructor_4)(string) | Initializes an instance of the [`JpgViewOptions`](../jpgviewoptions) class. | +| [JpgViewOptions](jpgviewoptions#constructor_2)(CreatePageStream, ReleasePageStream) | Initializes an instance of the [`JpgViewOptions`](../jpgviewoptions) class. | ## Properties @@ -30,40 +30,40 @@ public class JpgViewOptions : ViewOptions, IMaxSizeOptions | --- | --- | | [ArchiveOptions](../../groupdocs.viewer.options/baseviewoptions/archiveoptions) { get; set; } | The archive files view options. | | [CadOptions](../../groupdocs.viewer.options/baseviewoptions/cadoptions) { get; set; } | The CAD drawing view options. | -| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Default font to be used when particular font used in document can't be found. | +| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Sets the default font for a document. | | [EmailOptions](../../groupdocs.viewer.options/baseviewoptions/emailoptions) { get; set; } | The email messages view options. | | [ExtractText](../../groupdocs.viewer.options/jpgviewoptions/extracttext) { get; set; } | Enables text extraction. | -| [Height](../../groupdocs.viewer.options/jpgviewoptions/height) { get; set; } | The height of an output image in pixels. | +| [Height](../../groupdocs.viewer.options/jpgviewoptions/height) { get; set; } | Sets the height of an output image (in pixels). | | [MailStorageOptions](../../groupdocs.viewer.options/baseviewoptions/mailstorageoptions) { get; set; } | Mail storage data files view options. | -| [MaxHeight](../../groupdocs.viewer.options/jpgviewoptions/maxheight) { get; set; } | Max height of an output image in pixels. | -| [MaxWidth](../../groupdocs.viewer.options/jpgviewoptions/maxwidth) { get; set; } | Max width of an output image in pixels. | -| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The MS Outlook data files view options. | -| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF documents view options. | -| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation processing documents view options. | +| [MaxHeight](../../groupdocs.viewer.options/jpgviewoptions/maxheight) { get; set; } | Sets the maximum height of an output image (in pixels). | +| [MaxWidth](../../groupdocs.viewer.options/jpgviewoptions/maxwidth) { get; set; } | Sets the maximum width of an output image (in pixels). | +| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The Microsoft Outlook data files view options. | +| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF document view options. | +| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation files view options. | | [ProjectManagementOptions](../../groupdocs.viewer.options/baseviewoptions/projectmanagementoptions) { get; set; } | The project management files view options. | -| [Quality](../../groupdocs.viewer.options/jpgviewoptions/quality) { get; set; } | Quality of the output image; Valid values are between 1 and 100; Default value is 90. | +| [Quality](../../groupdocs.viewer.options/jpgviewoptions/quality) { get; set; } | Sets the quality of the output image. | | [RenderComments](../../groupdocs.viewer.options/baseviewoptions/rendercomments) { get; set; } | Enables rendering comments. | | [RenderHiddenPages](../../groupdocs.viewer.options/baseviewoptions/renderhiddenpages) { get; set; } | Enables rendering of hidden pages. | | [RenderNotes](../../groupdocs.viewer.options/baseviewoptions/rendernotes) { get; set; } | Enables rendering notes. | | [SpreadsheetOptions](../../groupdocs.viewer.options/baseviewoptions/spreadsheetoptions) { get; set; } | The spreadsheet files view options. | -| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files splitting to pages options. | -| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files processing documents view options. | -| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark applied to each page. | -| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [Width](../../groupdocs.viewer.options/jpgviewoptions/width) { get; set; } | The width of the output image in pixels. | -| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files view options. | +| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files view options. | +| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark to be applied to each page. | +| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | The Web files view options. | +| [Width](../../groupdocs.viewer.options/jpgviewoptions/width) { get; set; } | Sets the width of the output image (in pixels). | +| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | The Word processing files view options. | ## Methods | Name | Description | | --- | --- | -| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies clockwise rotation to the page. | +| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies the clockwise rotation to a page. | ## Fields | Name | Description | | --- | --- | -| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotations. | +| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotation. | ### See Also diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/extracttext/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/extracttext/_index.md index aea91ba89..7d08cadb9 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/extracttext/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/extracttext/_index.md @@ -16,7 +16,9 @@ public bool ExtractText { get; set; } ### Remarks -This option might be useful when you want to add selectable text layer over the image. +Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/). ### See Also diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/height/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/height/_index.md index d37e57983..0a052496f 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/height/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/height/_index.md @@ -1,19 +1,25 @@ --- title: Height second_title: GroupDocs.Viewer for .NET API Reference -description: The height of an output image in pixels. +description: Sets the height of an output image in pixels. type: docs weight: 30 url: /net/groupdocs.viewer.options/jpgviewoptions/height/ --- ## JpgViewOptions.Height property -The height of an output image in pixels. +Sets the height of an output image (in pixels). ```csharp public int Height { get; set; } ``` +### Remarks + +Use this property to set the output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/). + +If you set this property, the [`MaxHeight`](../maxheight) property is ignored. + ### See Also * class [JpgViewOptions](../../jpgviewoptions) diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/jpgviewoptions/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/jpgviewoptions/_index.md index a599e550f..5f101b66e 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/jpgviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/jpgviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: JpgViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of JpgViewOptionsgroupdocs.viewer.options/jpgviewoptions class. +description: Initializes an instance of the JpgViewOptionsgroupdocs.viewer.options/jpgviewoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/jpgviewoptions/jpgviewoptions/ --- ## JpgViewOptions(CreatePageStream) {#constructor_1} -Initializes new instance of [`JpgViewOptions`](../../jpgviewoptions) class. +Initializes an instance of the [`JpgViewOptions`](../../jpgviewoptions) class. ```csharp public JpgViewOptions(CreatePageStream createPageStream) @@ -16,7 +16,7 @@ public JpgViewOptions(CreatePageStream createPageStream) | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. | +| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. | ### Exceptions @@ -24,6 +24,10 @@ public JpgViewOptions(CreatePageStream createPageStream) | --- | --- | | ArgumentNullException | Thrown when *createPageStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -35,7 +39,7 @@ public JpgViewOptions(CreatePageStream createPageStream) ## JpgViewOptions(CreatePageStream, ReleasePageStream) {#constructor_2} -Initializes new instance of [`JpgViewOptions`](../../jpgviewoptions) class. +Initializes an instance of the [`JpgViewOptions`](../../jpgviewoptions) class. ```csharp public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) @@ -43,8 +47,8 @@ public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream relea | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. | -| releasePageStream | ReleasePageStream | The method that releases stream created by method assigned to delegate that passed to *createPageStream* parameter. | +| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. | +| releasePageStream | ReleasePageStream | The method that releases a stream created by method assigned to delegate that passed to *createPageStream* parameter. | ### Exceptions @@ -53,6 +57,10 @@ public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream relea | ArgumentNullException | Thrown when *createPageStream* is null. | | ArgumentNullException | Thrown when *releasePageStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -65,7 +73,7 @@ public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream relea ## JpgViewOptions(IPageStreamFactory) {#constructor_3} -Initializes new instance of [`JpgViewOptions`](../../jpgviewoptions) class. +Initializes an instance of the [`JpgViewOptions`](../../jpgviewoptions) class. ```csharp public JpgViewOptions(IPageStreamFactory pageStreamFactory) @@ -81,6 +89,10 @@ public JpgViewOptions(IPageStreamFactory pageStreamFactory) | --- | --- | | ArgumentNullException | Thrown when *pageStreamFactory* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg). + ### See Also * interface [IPageStreamFactory](../../../groupdocs.viewer.interfaces/ipagestreamfactory) @@ -92,7 +104,7 @@ public JpgViewOptions(IPageStreamFactory pageStreamFactory) ## JpgViewOptions() {#constructor} -Initializes new instance of [`JpgViewOptions`](../../jpgviewoptions) class. +Initializes an instance of the [`JpgViewOptions`](../../jpgviewoptions) class. ```csharp public JpgViewOptions() @@ -100,7 +112,9 @@ public JpgViewOptions() ### Remarks -This constructor initializes new instance of [`JpgViewOptions`](../../jpgviewoptions) with "p_{0}.jpg" as file path format for the output files. The output files will be placed into current working directory of the application. +This constructor initializes an instance of the [`JpgViewOptions`](../../jpgviewoptions) with "p_{0}.jpg" as file path format for the output files. The output files are placed into current working directory of the application. + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg). ### See Also @@ -112,7 +126,7 @@ This constructor initializes new instance of [`JpgViewOptions`](../../jpgviewopt ## JpgViewOptions(string) {#constructor_4} -Initializes new instance of [`JpgViewOptions`](../../jpgviewoptions) class. +Initializes an instance of the [`JpgViewOptions`](../../jpgviewoptions) class. ```csharp public JpgViewOptions(string filePathFormat) @@ -128,6 +142,10 @@ public JpgViewOptions(string filePathFormat) | --- | --- | | ArgumentException | Thrown when *filePathFormat* is null or empty. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg). + ### See Also * class [JpgViewOptions](../../jpgviewoptions) diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/maxheight/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/maxheight/_index.md index 68936ef9b..68edb069c 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/maxheight/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/maxheight/_index.md @@ -1,19 +1,25 @@ --- title: MaxHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Max height of an output image in pixels. +description: Sets the maximum height of an output image in pixels. type: docs weight: 40 url: /net/groupdocs.viewer.options/jpgviewoptions/maxheight/ --- ## JpgViewOptions.MaxHeight property -Max height of an output image in pixels. +Sets the maximum height of an output image (in pixels). ```csharp public int MaxHeight { get; set; } ``` +### Remarks + +Use this property to set the maximum output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/). + +If you set the [`Height`](../height) property, this property is ignored. + ### See Also * class [JpgViewOptions](../../jpgviewoptions) diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/maxwidth/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/maxwidth/_index.md index 731a37ae4..6bb18fc00 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/maxwidth/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/maxwidth/_index.md @@ -1,19 +1,25 @@ --- title: MaxWidth second_title: GroupDocs.Viewer for .NET API Reference -description: Max width of an output image in pixels. +description: Sets the maximum width of an output image in pixels. type: docs weight: 50 url: /net/groupdocs.viewer.options/jpgviewoptions/maxwidth/ --- ## JpgViewOptions.MaxWidth property -Max width of an output image in pixels. +Sets the maximum width of an output image (in pixels). ```csharp public int MaxWidth { get; set; } ``` +### Remarks + +Use this property to set the maximum output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/). + +If you set the [`Width`](../width) property, this property is ignored. + ### See Also * class [JpgViewOptions](../../jpgviewoptions) diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/quality/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/quality/_index.md index c6ff4225f..55976a05b 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/quality/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/quality/_index.md @@ -1,19 +1,25 @@ --- title: Quality second_title: GroupDocs.Viewer for .NET API Reference -description: Quality of the output image Valid values are between 1 and 100 Default value is 90. +description: Sets the quality of the output image. type: docs weight: 60 url: /net/groupdocs.viewer.options/jpgviewoptions/quality/ --- ## JpgViewOptions.Quality property -Quality of the output image; Valid values are between 1 and 100; Default value is 90. +Sets the quality of the output image. ```csharp public byte Quality { get; set; } ``` +### Remarks + +Use this property to adjust images quality. The value must be between 1 (minimum quality) and 100. The default value is 90. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-quality-for-jpg/). + ### See Also * class [JpgViewOptions](../../jpgviewoptions) diff --git a/english/net/groupdocs.viewer.options/jpgviewoptions/width/_index.md b/english/net/groupdocs.viewer.options/jpgviewoptions/width/_index.md index 75aebc62e..1acb8037b 100644 --- a/english/net/groupdocs.viewer.options/jpgviewoptions/width/_index.md +++ b/english/net/groupdocs.viewer.options/jpgviewoptions/width/_index.md @@ -1,19 +1,25 @@ --- title: Width second_title: GroupDocs.Viewer for .NET API Reference -description: The width of the output image in pixels. +description: Sets the width of the output image in pixels. type: docs weight: 70 url: /net/groupdocs.viewer.options/jpgviewoptions/width/ --- ## JpgViewOptions.Width property -The width of the output image in pixels. +Sets the width of the output image (in pixels). ```csharp public int Width { get; set; } ``` +### Remarks + +Use this property to set the output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/). + +If you set this property, the [`MaxWidth`](../maxwidth) property is ignored. + ### See Also * class [JpgViewOptions](../../jpgviewoptions) diff --git a/english/net/groupdocs.viewer.options/loadoptions/_index.md b/english/net/groupdocs.viewer.options/loadoptions/_index.md index ab3bd6822..31ef555e6 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/_index.md @@ -1,14 +1,14 @@ --- title: LoadOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options that used to open the file. +description: Contains options that used to open the file. For details see this pagehttps//docs.groupdocs.com/viewer/net/loading/ and its children. type: docs weight: 340 url: /net/groupdocs.viewer.options/loadoptions/ --- ## LoadOptions class -Provides options that used to open the file. +Contains options that used to open the file. For details, see this [page](https://docs.groupdocs.com/viewer/net/loading/) and its children. ```csharp public class LoadOptions @@ -18,19 +18,19 @@ public class LoadOptions | Name | Description | | --- | --- | -| [LoadOptions](loadoptions#constructor)() | Initializes new instance of [`LoadOptions`](../loadoptions) class. | -| [LoadOptions](loadoptions#constructor_1)(FileType) | Initializes new instance of [`LoadOptions`](../loadoptions) class. | +| [LoadOptions](loadoptions#constructor)() | Initializes an instance of the [`LoadOptions`](../loadoptions) class. | +| [LoadOptions](loadoptions#constructor_1)(FileType) | Initializes an instance of the [`LoadOptions`](../loadoptions) class. | ## Properties | Name | Description | | --- | --- | -| [DetectEncoding](../../groupdocs.viewer.options/loadoptions/detectencoding) { get; set; } | This option enables [`TXT`](../../groupdocs.viewer/filetype/txt), [`TSV`](../../groupdocs.viewer/filetype/tsv), and [`CSV`](../../groupdocs.viewer/filetype/csv) files encoding detection. In case the encoding can't be detected the default [`Encoding`](./encoding) is used. | -| [Encoding](../../groupdocs.viewer.options/loadoptions/encoding) { get; set; } | The encoding used when opening text-based files or email messages such as [`CSV`](../../groupdocs.viewer/filetype/csv), [`TXT`](../../groupdocs.viewer/filetype/txt), and [`MSG`](../../groupdocs.viewer/filetype/msg). Default value is UTF8. | -| [FileType](../../groupdocs.viewer.options/loadoptions/filetype) { get; set; } | The type of the file to open. | -| [Password](../../groupdocs.viewer.options/loadoptions/password) { get; set; } | The password for opening encrypted file. | -| [ResourceLoadingTimeout](../../groupdocs.viewer.options/loadoptions/resourceloadingtimeout) { get; set; } | The external resources loading timeout. The default value is 10 seconds. | -| [SkipExternalResources](../../groupdocs.viewer.options/loadoptions/skipexternalresources) { get; set; } | When set to `true` all external resource such as images will not be loaded except [`WhitelistedResources`](./whitelistedresources). | +| [DetectEncoding](../../groupdocs.viewer.options/loadoptions/detectencoding) { get; set; } | Enables the encoding detection for the [`TXT`](../../groupdocs.viewer/filetype/txt), [`CSV`](../../groupdocs.viewer/filetype/csv), and [`TSV`](../../groupdocs.viewer/filetype/tsv) files. | +| [Encoding](../../groupdocs.viewer.options/loadoptions/encoding) { get; set; } | Sets the encoding used when opening text-based files or email messages such as [`CSV`](../../groupdocs.viewer/filetype/csv), [`TXT`](../../groupdocs.viewer/filetype/txt), and [`MSG`](../../groupdocs.viewer/filetype/msg). Default value is UTF8. | +| [FileType](../../groupdocs.viewer.options/loadoptions/filetype) { get; set; } | Sets the type of the file to open. | +| [Password](../../groupdocs.viewer.options/loadoptions/password) { get; set; } | Sets the password to open encrypted file. | +| [ResourceLoadingTimeout](../../groupdocs.viewer.options/loadoptions/resourceloadingtimeout) { get; set; } | Sets the timeout to load external resources. | +| [SkipExternalResources](../../groupdocs.viewer.options/loadoptions/skipexternalresources) { get; set; } | Disables loading of all external resource such as images except [`WhitelistedResources`](./whitelistedresources). | | [WhitelistedResources](../../groupdocs.viewer.options/loadoptions/whitelistedresources) { get; set; } | The list of URL fragments corresponding to external resources that should be loaded when [`SkipExternalResources`](./skipexternalresources) is set to `true`. | ### See Also diff --git a/english/net/groupdocs.viewer.options/loadoptions/detectencoding/_index.md b/english/net/groupdocs.viewer.options/loadoptions/detectencoding/_index.md index e7654b973..afc51f567 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/detectencoding/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/detectencoding/_index.md @@ -1,14 +1,14 @@ --- title: DetectEncoding second_title: GroupDocs.Viewer for .NET API Reference -description: This option enables TXTgroupdocs.viewer/filetype/txt TSVgroupdocs.viewer/filetype/tsv and CSVgroupdocs.viewer/filetype/csv files encoding detection. In case the encoding cant be detected the default Encodinggroupdocs.viewer.options/loadoptions/encoding is used. +description: Enables the encoding detection for the TXTgroupdocs.viewer/filetype/txt CSVgroupdocs.viewer/filetype/csv and TSVgroupdocs.viewer/filetype/tsv files. type: docs weight: 20 url: /net/groupdocs.viewer.options/loadoptions/detectencoding/ --- ## LoadOptions.DetectEncoding property -This option enables [`TXT`](../../../groupdocs.viewer/filetype/txt), [`TSV`](../../../groupdocs.viewer/filetype/tsv), and [`CSV`](../../../groupdocs.viewer/filetype/csv) files encoding detection. In case the encoding can't be detected the default [`Encoding`](../encoding) is used. +Enables the encoding detection for the [`TXT`](../../../groupdocs.viewer/filetype/txt), [`CSV`](../../../groupdocs.viewer/filetype/csv), and [`TSV`](../../../groupdocs.viewer/filetype/tsv) files. ```csharp public bool DetectEncoding { get; set; } @@ -16,27 +16,7 @@ public bool DetectEncoding { get; set; } ### Remarks -Learn more about rendering text and tab/comma delimited files: - -* [Render text documents as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-text-files/) -* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -LoadOptions loadOptions = new LoadOptions(); -loadOptions.DetectEncoding = true; // Enable encoding detection - -using (Viewer viewer = new Viewer("employees.csv", loadOptions)) -{ - HtmlViewOptions viewOptions = - HtmlViewOptions.ForEmbeddedResources(); - - viewer.View(viewOptions); -} -``` +If the encoding cannot be detected, the default [`Encoding`](../encoding) is used. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/detect-encoding-when-loading-documents/). ### See Also diff --git a/english/net/groupdocs.viewer.options/loadoptions/encoding/_index.md b/english/net/groupdocs.viewer.options/loadoptions/encoding/_index.md index fe7181bed..f1dd2191f 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/encoding/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/encoding/_index.md @@ -1,14 +1,14 @@ --- title: Encoding second_title: GroupDocs.Viewer for .NET API Reference -description: The encoding used when opening textbased files or email messages such as CSVgroupdocs.viewer/filetype/csv TXTgroupdocs.viewer/filetype/txt and MSGgroupdocs.viewer/filetype/msg. Default value is UTF8. +description: Sets the encoding used when opening textbased files or email messages such as CSVgroupdocs.viewer/filetype/csv TXTgroupdocs.viewer/filetype/txt and MSGgroupdocs.viewer/filetype/msg. Default value is UTF8. type: docs weight: 30 url: /net/groupdocs.viewer.options/loadoptions/encoding/ --- ## LoadOptions.Encoding property -The encoding used when opening text-based files or email messages such as [`CSV`](../../../groupdocs.viewer/filetype/csv), [`TXT`](../../../groupdocs.viewer/filetype/txt), and [`MSG`](../../../groupdocs.viewer/filetype/msg). Default value is UTF8. +Sets the encoding used when opening text-based files or email messages such as [`CSV`](../../../groupdocs.viewer/filetype/csv), [`TXT`](../../../groupdocs.viewer/filetype/txt), and [`MSG`](../../../groupdocs.viewer/filetype/msg). Default value is UTF8. ```csharp public Encoding Encoding { get; set; } @@ -16,28 +16,7 @@ public Encoding Encoding { get; set; } ### Remarks -Learn more - -* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/) -* [Render text documents as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-text-files) -* [Render email messages as HTML, PDF, PNG, and JPEG files](https://docs.groupdocs.com/viewer/net/render-email-messages/) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -LoadOptions loadOptions = new LoadOptions(); -loadOptions.Encoding = Encoding.ASCII; // Set the encoding - -using (Viewer viewer = new Viewer("message.txt", loadOptions)) -{ - HtmlViewOptions viewOptions = - HtmlViewOptions.ForEmbeddedResources(); - - viewer.View(viewOptions); -} -``` +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-encoding-when-loading-documents/). ### See Also diff --git a/english/net/groupdocs.viewer.options/loadoptions/filetype/_index.md b/english/net/groupdocs.viewer.options/loadoptions/filetype/_index.md index 9d8662fb1..439f27c65 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/filetype/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/filetype/_index.md @@ -1,19 +1,23 @@ --- title: FileType second_title: GroupDocs.Viewer for .NET API Reference -description: The type of the file to open. +description: Sets the type of the file to open. type: docs weight: 40 url: /net/groupdocs.viewer.options/loadoptions/filetype/ --- ## LoadOptions.FileType property -The type of the file to open. +Sets the type of the file to open. ```csharp public FileType FileType { get; set; } ``` +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-file-type-when-loading-a-document/). + ### See Also * class [FileType](../../../groupdocs.viewer/filetype) diff --git a/english/net/groupdocs.viewer.options/loadoptions/loadoptions/_index.md b/english/net/groupdocs.viewer.options/loadoptions/loadoptions/_index.md index 9d4cec8ac..07168598e 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/loadoptions/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/loadoptions/_index.md @@ -1,14 +1,14 @@ --- title: LoadOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of LoadOptionsgroupdocs.viewer.options/loadoptions class. +description: Initializes an instance of the LoadOptionsgroupdocs.viewer.options/loadoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/loadoptions/loadoptions/ --- ## LoadOptions() {#constructor} -Initializes new instance of [`LoadOptions`](../../loadoptions) class. +Initializes an instance of the [`LoadOptions`](../../loadoptions) class. ```csharp public LoadOptions() @@ -24,7 +24,7 @@ public LoadOptions() ## LoadOptions(FileType) {#constructor_1} -Initializes new instance of [`LoadOptions`](../../loadoptions) class. +Initializes an instance of the [`LoadOptions`](../../loadoptions) class. ```csharp public LoadOptions(FileType fileType) @@ -40,6 +40,10 @@ public LoadOptions(FileType fileType) | --- | --- | | ArgumentNullException | Thrown when *fileType* is null. | +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-file-type-when-loading-a-document/). + ### See Also * class [FileType](../../../groupdocs.viewer/filetype) diff --git a/english/net/groupdocs.viewer.options/loadoptions/password/_index.md b/english/net/groupdocs.viewer.options/loadoptions/password/_index.md index 5cd6320d8..f29bcd1cb 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/password/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/password/_index.md @@ -1,19 +1,23 @@ --- title: Password second_title: GroupDocs.Viewer for .NET API Reference -description: The password for opening encrypted file. +description: Sets the password to open encrypted file. type: docs weight: 50 url: /net/groupdocs.viewer.options/loadoptions/password/ --- ## LoadOptions.Password property -The password for opening encrypted file. +Sets the password to open encrypted file. ```csharp public string Password { get; set; } ``` +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/load-password-protected-document/). + ### See Also * class [LoadOptions](../../loadoptions) diff --git a/english/net/groupdocs.viewer.options/loadoptions/resourceloadingtimeout/_index.md b/english/net/groupdocs.viewer.options/loadoptions/resourceloadingtimeout/_index.md index 88d81df6c..6b9426a7a 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/resourceloadingtimeout/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/resourceloadingtimeout/_index.md @@ -1,14 +1,14 @@ --- title: ResourceLoadingTimeout second_title: GroupDocs.Viewer for .NET API Reference -description: The external resources loading timeout. The default value is 10 seconds. +description: Sets the timeout to load external resources. type: docs weight: 60 url: /net/groupdocs.viewer.options/loadoptions/resourceloadingtimeout/ --- ## LoadOptions.ResourceLoadingTimeout property -The external resources loading timeout. The default value is 10 seconds. +Sets the timeout to load external resources. ```csharp public TimeSpan ResourceLoadingTimeout { get; set; } @@ -16,33 +16,7 @@ public TimeSpan ResourceLoadingTimeout { get; set; } ### Remarks -This option is supported when rendering the following file formats: - -* [Presentation file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#presentation-file-formats) -* [Spreadsheet file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#spreadsheet-file-formats) -* [Web file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#web-file-formats) -* [Word processing file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#word-processing-file-formats) - -Learn more about options to manage external resources: - -* [Set timeout for loading external resources](https://docs.groupdocs.com/viewer/net/set-timeout-for-loading-external-resources-contained-by-a-document/) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -LoadOptions loadOptions = new LoadOptions(); -loadOptions.ResourceLoadingTimeout = TimeSpan.FromSeconds(5); // Set resource loading timeout to 5 seconds - -using (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) -{ - HtmlViewOptions viewOptions = - HtmlViewOptions.ForEmbeddedResources(); - - viewer.View(viewOptions); -} -``` +The default value is 30 seconds. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/detect-encoding-when-loading-documents). ### See Also diff --git a/english/net/groupdocs.viewer.options/loadoptions/skipexternalresources/_index.md b/english/net/groupdocs.viewer.options/loadoptions/skipexternalresources/_index.md index 3ada7f30d..56a147c81 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/skipexternalresources/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/skipexternalresources/_index.md @@ -1,14 +1,14 @@ --- title: SkipExternalResources second_title: GroupDocs.Viewer for .NET API Reference -description: When set to true all external resource such as images will not be loaded except WhitelistedResourcesgroupdocs.viewer.options/loadoptions/whitelistedresources. +description: Disables loading of all external resource such as images except WhitelistedResourcesgroupdocs.viewer.options/loadoptions/whitelistedresources. type: docs weight: 70 url: /net/groupdocs.viewer.options/loadoptions/skipexternalresources/ --- ## LoadOptions.SkipExternalResources property -When set to `true` all external resource such as images will not be loaded except [`WhitelistedResources`](../whitelistedresources). +Disables loading of all external resource such as images except [`WhitelistedResources`](../whitelistedresources). ```csharp public bool SkipExternalResources { get; set; } @@ -16,33 +16,7 @@ public bool SkipExternalResources { get; set; } ### Remarks -This option is supported when rendering the following file formats: - -* [Presentation file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#presentation-file-formats) -* [Spreadsheet file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#spreadsheet-file-formats) -* [Web file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#web-file-formats) -* [Word processing file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#word-processing-file-formats) - -Learn more about options to manage external resources: - -* [Set timeout for loading external resources](https://docs.groupdocs.com/viewer/net/set-timeout-for-loading-external-resources-contained-by-a-document/) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -LoadOptions loadOptions = new LoadOptions(); -loadOptions.SkipExternalResources = true; // Skip loading of external resources - -using (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) -{ - HtmlViewOptions viewOptions = - HtmlViewOptions.ForEmbeddedResources(); - - viewer.View(viewOptions); -} -``` +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/loading-external-resources/#skip-loading-of-external-resources). ### See Also diff --git a/english/net/groupdocs.viewer.options/loadoptions/whitelistedresources/_index.md b/english/net/groupdocs.viewer.options/loadoptions/whitelistedresources/_index.md index c040b6d67..8bc2fb00b 100644 --- a/english/net/groupdocs.viewer.options/loadoptions/whitelistedresources/_index.md +++ b/english/net/groupdocs.viewer.options/loadoptions/whitelistedresources/_index.md @@ -16,33 +16,7 @@ public List WhitelistedResources { get; set; } ### Remarks -This option is supported when rendering the following file formats: - -* [Presentation file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#presentation-file-formats) -* [Spreadsheet file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#spreadsheet-file-formats) -* [Web file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#web-file-formats) -* [Word processing file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#word-processing-file-formats) - -Learn more about options to manage external resources: - -* [Set timeout for loading external resources](https://docs.groupdocs.com/viewer/net/set-timeout-for-loading-external-resources-contained-by-a-document/) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -LoadOptions loadOptions = new LoadOptions(); -loadOptions.SkipExternalResources = true; // Skip loading of external resources -loadOptions.WhitelistedResources.Add("avatars.githubusercontent.com"); //Enable loading of external resources that has 'avatars.githubusercontent.com' fragment in resource URL. -using (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) -{ - HtmlViewOptions viewOptions = - HtmlViewOptions.ForEmbeddedResources(); - - viewer.View(viewOptions); -} -``` +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/loading-external-resources/#manage-a-safelist-for-loading-external-resources). ### See Also diff --git a/english/net/groupdocs.viewer.options/mailstorageoptions/_index.md b/english/net/groupdocs.viewer.options/mailstorageoptions/_index.md index cba1cd29d..8374be6b6 100644 --- a/english/net/groupdocs.viewer.options/mailstorageoptions/_index.md +++ b/english/net/groupdocs.viewer.options/mailstorageoptions/_index.md @@ -1,14 +1,14 @@ --- title: MailStorageOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering Mail storage Lotus Notes MBox data files. +description: Contains options for rendering Mail storage Lotus Notes MBox data files. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderlotusnotesdatabasefiles/specifyrenderingoptions. type: docs weight: 350 url: /net/groupdocs.viewer.options/mailstorageoptions/ --- ## MailStorageOptions class -Provides options for rendering Mail storage (Lotus Notes, MBox) data files. +Contains options for rendering Mail storage (Lotus Notes, MBox) data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options). ```csharp public class MailStorageOptions @@ -24,9 +24,9 @@ public class MailStorageOptions | Name | Description | | --- | --- | -| [AddressFilter](../../groupdocs.viewer.options/mailstorageoptions/addressfilter) { get; set; } | The email-address used to filter messages by sender or recipient. | -| [MaxItems](../../groupdocs.viewer.options/mailstorageoptions/maxitems) { get; set; } | The maximum number of messages or items for render. | -| [TextFilter](../../groupdocs.viewer.options/mailstorageoptions/textfilter) { get; set; } | The keywords used to filter messages. | +| [AddressFilter](../../groupdocs.viewer.options/mailstorageoptions/addressfilter) { get; set; } | Sets the email-address used to filter messages by sender or recipient. | +| [MaxItems](../../groupdocs.viewer.options/mailstorageoptions/maxitems) { get; set; } | Sets the maximum number of messages or items to render. | +| [TextFilter](../../groupdocs.viewer.options/mailstorageoptions/textfilter) { get; set; } | Sets the keywords used to filter messages. | ### See Also diff --git a/english/net/groupdocs.viewer.options/mailstorageoptions/addressfilter/_index.md b/english/net/groupdocs.viewer.options/mailstorageoptions/addressfilter/_index.md index 658bcae05..6e161db77 100644 --- a/english/net/groupdocs.viewer.options/mailstorageoptions/addressfilter/_index.md +++ b/english/net/groupdocs.viewer.options/mailstorageoptions/addressfilter/_index.md @@ -1,19 +1,23 @@ --- title: AddressFilter second_title: GroupDocs.Viewer for .NET API Reference -description: The emailaddress used to filter messages by sender or recipient. +description: Sets the emailaddress used to filter messages by sender or recipient. type: docs weight: 20 url: /net/groupdocs.viewer.options/mailstorageoptions/addressfilter/ --- ## MailStorageOptions.AddressFilter property -The email-address used to filter messages by sender or recipient. +Sets the email-address used to filter messages by sender or recipient. ```csharp public string AddressFilter { get; set; } ``` +### Remarks + +Use this property to render all messages that contain specific text in the sender’s or recipient’s address. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#filter-messages). + ### See Also * class [MailStorageOptions](../../mailstorageoptions) diff --git a/english/net/groupdocs.viewer.options/mailstorageoptions/maxitems/_index.md b/english/net/groupdocs.viewer.options/mailstorageoptions/maxitems/_index.md index 47b8766d5..463ae9639 100644 --- a/english/net/groupdocs.viewer.options/mailstorageoptions/maxitems/_index.md +++ b/english/net/groupdocs.viewer.options/mailstorageoptions/maxitems/_index.md @@ -1,14 +1,14 @@ --- title: MaxItems second_title: GroupDocs.Viewer for .NET API Reference -description: The maximum number of messages or items for render. +description: Sets the maximum number of messages or items to render. type: docs weight: 30 url: /net/groupdocs.viewer.options/mailstorageoptions/maxitems/ --- ## MailStorageOptions.MaxItems property -The maximum number of messages or items for render. +Sets the maximum number of messages or items to render. ```csharp public int MaxItems { get; set; } @@ -16,7 +16,9 @@ public int MaxItems { get; set; } ### Remarks -Lotus notes data files can be large and retrieving all messages can take significant time. This setting limits maximum number of messages or items that are rendered. Default value is 0 - all messages will be rendered +Mail storage data files can be large and retrieving all messages can take significant time. This property limits the maximum number of messages or items that are rendered. Default value is 0 - all messages are rendered. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#limit-the-number-of-items-to-render). ### See Also diff --git a/english/net/groupdocs.viewer.options/mailstorageoptions/textfilter/_index.md b/english/net/groupdocs.viewer.options/mailstorageoptions/textfilter/_index.md index 1a39f6d72..2257e23b7 100644 --- a/english/net/groupdocs.viewer.options/mailstorageoptions/textfilter/_index.md +++ b/english/net/groupdocs.viewer.options/mailstorageoptions/textfilter/_index.md @@ -1,19 +1,23 @@ --- title: TextFilter second_title: GroupDocs.Viewer for .NET API Reference -description: The keywords used to filter messages. +description: Sets the keywords used to filter messages. type: docs weight: 40 url: /net/groupdocs.viewer.options/mailstorageoptions/textfilter/ --- ## MailStorageOptions.TextFilter property -The keywords used to filter messages. +Sets the keywords used to filter messages. ```csharp public string TextFilter { get; set; } ``` +### Remarks + +Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#filter-messages). + ### See Also * class [MailStorageOptions](../../mailstorageoptions) diff --git a/english/net/groupdocs.viewer.options/outlookoptions/_index.md b/english/net/groupdocs.viewer.options/outlookoptions/_index.md index e468c618a..92e3a7d2c 100644 --- a/english/net/groupdocs.viewer.options/outlookoptions/_index.md +++ b/english/net/groupdocs.viewer.options/outlookoptions/_index.md @@ -1,14 +1,14 @@ --- title: OutlookOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering Outlook data files. +description: Contains options for rendering Outlook data files. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderlotusnotesdatabasefiles/specifyrenderingoptions. type: docs weight: 360 url: /net/groupdocs.viewer.options/outlookoptions/ --- ## OutlookOptions class -Provides options for rendering Outlook data files. +Contains options for rendering Outlook data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options). ```csharp public class OutlookOptions @@ -24,10 +24,10 @@ public class OutlookOptions | Name | Description | | --- | --- | -| [AddressFilter](../../groupdocs.viewer.options/outlookoptions/addressfilter) { get; set; } | The email-address used to filter messages by sender or recipient. | -| [Folder](../../groupdocs.viewer.options/outlookoptions/folder) { get; set; } | The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. | +| [AddressFilter](../../groupdocs.viewer.options/outlookoptions/addressfilter) { get; set; } | Sets the email-address used to filter messages by sender or recipient. | +| [Folder](../../groupdocs.viewer.options/outlookoptions/folder) { get; set; } | Sets the name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. | | [MaxItemsInFolder](../../groupdocs.viewer.options/outlookoptions/maxitemsinfolder) { get; set; } | The maximum number of messages or items, that can be rendered from one folder. | -| [TextFilter](../../groupdocs.viewer.options/outlookoptions/textfilter) { get; set; } | The keywords used to filter messages. | +| [TextFilter](../../groupdocs.viewer.options/outlookoptions/textfilter) { get; set; } | Sets the keywords used to filter messages. | ### See Also diff --git a/english/net/groupdocs.viewer.options/outlookoptions/addressfilter/_index.md b/english/net/groupdocs.viewer.options/outlookoptions/addressfilter/_index.md index a6a1dc825..b5ba9f709 100644 --- a/english/net/groupdocs.viewer.options/outlookoptions/addressfilter/_index.md +++ b/english/net/groupdocs.viewer.options/outlookoptions/addressfilter/_index.md @@ -1,19 +1,23 @@ --- title: AddressFilter second_title: GroupDocs.Viewer for .NET API Reference -description: The emailaddress used to filter messages by sender or recipient. +description: Sets the emailaddress used to filter messages by sender or recipient. type: docs weight: 20 url: /net/groupdocs.viewer.options/outlookoptions/addressfilter/ --- ## OutlookOptions.AddressFilter property -The email-address used to filter messages by sender or recipient. +Sets the email-address used to filter messages by sender or recipient. ```csharp public string AddressFilter { get; set; } ``` +### Remarks + +Use this property to render all messages that contain specific text in the sender’s or recipient’s address. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#filter-messages). + ### See Also * class [OutlookOptions](../../outlookoptions) diff --git a/english/net/groupdocs.viewer.options/outlookoptions/folder/_index.md b/english/net/groupdocs.viewer.options/outlookoptions/folder/_index.md index 8cb99c7e7..7610aab5c 100644 --- a/english/net/groupdocs.viewer.options/outlookoptions/folder/_index.md +++ b/english/net/groupdocs.viewer.options/outlookoptions/folder/_index.md @@ -1,19 +1,25 @@ --- title: Folder second_title: GroupDocs.Viewer for .NET API Reference -description: The name of the folder e.g. Inbox Sent Item or Deleted Items to render. +description: Sets the name of the folder e.g. Inbox Sent Item or Deleted Items to render. type: docs weight: 30 url: /net/groupdocs.viewer.options/outlookoptions/folder/ --- ## OutlookOptions.Folder property -The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. +Sets the name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. ```csharp public string Folder { get; set; } ``` +### Remarks + +When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder. + +For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#render-a-specific-folder). + ### See Also * class [OutlookOptions](../../outlookoptions) diff --git a/english/net/groupdocs.viewer.options/outlookoptions/maxitemsinfolder/_index.md b/english/net/groupdocs.viewer.options/outlookoptions/maxitemsinfolder/_index.md index 3b3d3299f..513987d95 100644 --- a/english/net/groupdocs.viewer.options/outlookoptions/maxitemsinfolder/_index.md +++ b/english/net/groupdocs.viewer.options/outlookoptions/maxitemsinfolder/_index.md @@ -16,7 +16,9 @@ public int MaxItemsInFolder { get; set; } ### Remarks -Outlook data files can be large and retrieving all messages can take significant time. This setting limits maximum number of messages or items (like contacts and tasks) that are rendered. Default value is 50. In order to render all messages, set the value to 0. +Outlook data files can be large and retrieving all messages can take significant time. This property limits the maximum number of messages or items that are rendered. Default value is `50`. To render all messages, set the value to `0`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#limit-the-number-of-folder-items-to-render). ### See Also diff --git a/english/net/groupdocs.viewer.options/outlookoptions/textfilter/_index.md b/english/net/groupdocs.viewer.options/outlookoptions/textfilter/_index.md index fd45ae0f7..13fd9a636 100644 --- a/english/net/groupdocs.viewer.options/outlookoptions/textfilter/_index.md +++ b/english/net/groupdocs.viewer.options/outlookoptions/textfilter/_index.md @@ -1,19 +1,23 @@ --- title: TextFilter second_title: GroupDocs.Viewer for .NET API Reference -description: The keywords used to filter messages. +description: Sets the keywords used to filter messages. type: docs weight: 50 url: /net/groupdocs.viewer.options/outlookoptions/textfilter/ --- ## OutlookOptions.TextFilter property -The keywords used to filter messages. +Sets the keywords used to filter messages. ```csharp public string TextFilter { get; set; } ``` +### Remarks + +Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#filter-messages). + ### See Also * class [OutlookOptions](../../outlookoptions) diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/_index.md index 7bc40264f..469a06b69 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/_index.md @@ -1,14 +1,14 @@ --- title: PdfOptimizationOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Use this class to specify PDF optimization options to apply to the output PDF file. +description: Contains the PDF optimization options to apply to the output PDF file. For details and code samples see this pagehttps//docs.groupdocs.com/viewer/net/optimizationpdfoptions/ and its children. type: docs weight: 380 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/ --- ## PdfOptimizationOptions class -Use this class to specify PDF optimization options to apply to the output PDF file. +Contains the PDF optimization options to apply to the output PDF file. For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children. ```csharp public class PdfOptimizationOptions @@ -24,37 +24,16 @@ public class PdfOptimizationOptions | Name | Description | | --- | --- | -| [CompressImages](../../groupdocs.viewer.options/pdfoptimizationoptions/compressimages) { get; set; } | If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set this option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the ImageQuality property less than 100. | -| [ConvertToGrayScale](../../groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale) { get; set; } | PDF file is comprised of Text, Image, Attachment, Annotations, Graphs and other objects. You may come across a requirement to convert a PDF from RGB colorspace to grayscale so that it would be faster while printing those PDF files. Also when the file is converted to grayscale, the size of the document is also reduced but with this change, the quality of the document may drop. Currently, this feature is supported by the Pre-Flight feature of Adobe Acrobat. | -| [ImageQuality](../../groupdocs.viewer.options/pdfoptimizationoptions/imagequality) { get; set; } | If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set CompressImages option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the CompressImages option to true and ImageQuality property less than 100. | -| [Lineriaze](../../groupdocs.viewer.options/pdfoptimizationoptions/lineriaze) { get; set; } | Optimizes output PDF for online browsing with a web browser. | -| [MaxResolution](../../groupdocs.viewer.options/pdfoptimizationoptions/maxresolution) { get; set; } | Can be used with CompressImage option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value. | -| [OptimizeSpreadsheets](../../groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets) { get; set; } | Optimize Excel spreadsheets border lines and fonts for smaller output file size. | -| [RemoveAnnotations](../../groupdocs.viewer.options/pdfoptimizationoptions/removeannotations) { get; set; } | Annotations can be deleted when they are unnecessary. When they are needed but do not require additional editing, they can be flattened. It will reduce the file size. | -| [RemoveFormFields](../../groupdocs.viewer.options/pdfoptimizationoptions/removeformfields) { get; set; } | If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields. | -| [ResizeImages](../../groupdocs.viewer.options/pdfoptimizationoptions/resizeimages) { get; set; } | Can be used with CompressImage option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value. | -| [SubsetFonts](../../groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts) { get; set; } | Every font used to display text on the page contains set of glyphs for font characters. PDF specification supports "font subset" i.e. font with only those glyphs which are used. This may cause issues when text should be updated (since probably required glyphs are absent in the font), but for the document which is not planned to change this allows to decrease size. | - -### Remarks - -These optimization options are supported for any input file formats which are supported for export to PDF. - -* [Supported document formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/) - -### Examples - -The example demonstrates a default usage of this class. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions(); - viewOptions.PdfOptimizationOptions.Lineriaze = true; - - viewer.View(viewOptions); -} -``` +| [CompressImages](../../groupdocs.viewer.options/pdfoptimizationoptions/compressimages) { get; set; } | Enables compressing images in the output PDF file. | +| [ConvertToGrayScale](../../groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale) { get; set; } | Enables converting the output PDF file to a grayscale. | +| [ImageQuality](../../groupdocs.viewer.options/pdfoptimizationoptions/imagequality) { get; set; } | Sets the image quality in the output PDF file (in percent). | +| [Lineriaze](../../groupdocs.viewer.options/pdfoptimizationoptions/lineriaze) { get; set; } | Enables optimization the output PDF file for viewing online with a web browser. | +| [MaxResolution](../../groupdocs.viewer.options/pdfoptimizationoptions/maxresolution) { get; set; } | Sets the maximum resolution in the output PDF file. | +| [OptimizeSpreadsheets](../../groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets) { get; set; } | Enables optimization of spreadsheets in the PDF files. | +| [RemoveAnnotations](../../groupdocs.viewer.options/pdfoptimizationoptions/removeannotations) { get; set; } | Enables removing annotation from the output PDF file. | +| [RemoveFormFields](../../groupdocs.viewer.options/pdfoptimizationoptions/removeformfields) { get; set; } | Enables removing form fields from a PDF file. | +| [ResizeImages](../../groupdocs.viewer.options/pdfoptimizationoptions/resizeimages) { get; set; } | Enables setting the maximum resolution in the output PDF file. | +| [SubsetFonts](../../groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts) { get; set; } | Subsets fonts in the output PDF file. | ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/compressimages/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/compressimages/_index.md index 094134234..f7ffcac70 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/compressimages/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/compressimages/_index.md @@ -1,14 +1,14 @@ --- title: CompressImages second_title: GroupDocs.Viewer for .NET API Reference -description: If the source PDF file contains images consider compressing the images and setting their quality. In order to enable image compression set this option to true. All the images in a document will be recompressed. The compression is defined by the ImageQuality property which is the value of the quality in percent. 100 is unchanged quality. To decrease image quality set the ImageQuality property less than 100. +description: Enables compressing images in the output PDF file. type: docs weight: 20 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/compressimages/ --- ## PdfOptimizationOptions.CompressImages property -If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set this option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the ImageQuality property less than 100. +Enables compressing images in the output PDF file. ```csharp public bool CompressImages { get; set; } @@ -16,25 +16,7 @@ public bool CompressImages { get; set; } ### Remarks -The default value is `false`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - CompressImages = true, - ImageQuality = 50 - }; - - viewer.View(viewOptions); -} -``` +Use this option to allow other compressing options: [`ImageQuality`](../imagequality) and [`MaxResolution`](../maxresolution). For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-reduce-image-quality/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale/_index.md index bbceaf72e..0a231afa3 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale/_index.md @@ -1,14 +1,14 @@ --- title: ConvertToGrayScale second_title: GroupDocs.Viewer for .NET API Reference -description: PDF file is comprised of Text Image Attachment Annotations Graphs and other objects. You may come across a requirement to convert a PDF from RGB colorspace to grayscale so that it would be faster while printing those PDF files. Also when the file is converted to grayscale the size of the document is also reduced but with this change the quality of the document may drop. Currently this feature is supported by the PreFlight feature of Adobe Acrobat. +description: Enables converting the output PDF file to a grayscale. type: docs weight: 30 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale/ --- ## PdfOptimizationOptions.ConvertToGrayScale property -PDF file is comprised of Text, Image, Attachment, Annotations, Graphs and other objects. You may come across a requirement to convert a PDF from RGB colorspace to grayscale so that it would be faster while printing those PDF files. Also when the file is converted to grayscale, the size of the document is also reduced but with this change, the quality of the document may drop. Currently, this feature is supported by the Pre-Flight feature of Adobe Acrobat. +Enables converting the output PDF file to a grayscale. ```csharp public bool ConvertToGrayScale { get; set; } @@ -16,24 +16,7 @@ public bool ConvertToGrayScale { get; set; } ### Remarks -The default value is `false`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - ConvertToGrayScale = true - }; - - viewer.View(viewOptions); -} -``` +For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-convert-grayscale/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/imagequality/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/imagequality/_index.md index 2ac5f79a0..bb5d1c90e 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/imagequality/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/imagequality/_index.md @@ -1,14 +1,14 @@ --- title: ImageQuality second_title: GroupDocs.Viewer for .NET API Reference -description: If the source PDF file contains images consider compressing the images and setting their quality. In order to enable image compression set CompressImages option to true. All the images in a document will be recompressed. The compression is defined by the ImageQuality property which is the value of the quality in percent. 100 is unchanged quality. To decrease image quality set the CompressImages option to true and ImageQuality property less than 100. +description: Sets the image quality in the output PDF file in percent. type: docs weight: 40 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/imagequality/ --- ## PdfOptimizationOptions.ImageQuality property -If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set CompressImages option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the CompressImages option to true and ImageQuality property less than 100. +Sets the image quality in the output PDF file (in percent). ```csharp public int ImageQuality { get; set; } @@ -16,25 +16,7 @@ public int ImageQuality { get; set; } ### Remarks -The default value is `100`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - CompressImages = true, - ImageQuality = 50 - }; - - viewer.View(viewOptions); -} -``` +To change the image quality, first set the [`CompressImages`](../compressimages) property to `true`. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-reduce-image-quality/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/lineriaze/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/lineriaze/_index.md index edf0327f5..6013dfab7 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/lineriaze/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/lineriaze/_index.md @@ -1,35 +1,22 @@ --- title: Lineriaze second_title: GroupDocs.Viewer for .NET API Reference -description: Optimizes output PDF for online browsing with a web browser. +description: Enables optimization the output PDF file for viewing online with a web browser. type: docs weight: 50 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/lineriaze/ --- ## PdfOptimizationOptions.Lineriaze property -Optimizes output PDF for online browsing with a web browser. +Enables optimization the output PDF file for viewing online with a web browser. ```csharp public bool Lineriaze { get; set; } ``` -### Examples +### Remarks -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions() - { - Lineriaze = true - }; - - viewer.View(viewOptions); -} -``` +This optimization allows a browser to display the first pages of a PDF file when you open the document, instead of waiting for the entire file to download. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-for-web/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/maxresolution/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/maxresolution/_index.md index 42195a6b0..296c0708c 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/maxresolution/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/maxresolution/_index.md @@ -1,14 +1,14 @@ --- title: MaxResolution second_title: GroupDocs.Viewer for .NET API Reference -description: Can be used with CompressImage option to resize the images with a lower resolution. In this case we should set CompressImage to true ResizeImages to true and MaxResolution to the appropriate value. +description: Sets the maximum resolution in the output PDF file. type: docs weight: 60 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/maxresolution/ --- ## PdfOptimizationOptions.MaxResolution property -Can be used with CompressImage option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value. +Sets the maximum resolution in the output PDF file. ```csharp public int MaxResolution { get; set; } @@ -16,27 +16,11 @@ public int MaxResolution { get; set; } ### Remarks -The default value is `300`. - -### Examples +To allow this option, set the [`CompressImages`](../compressimages) and `MaxResolution` properties to `true`. -The example demonstrates a typical usage of this option. +The default value is `300`. -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - CompressImages = true, - ImageQuality = 50, - ResizeImages = true, - MaxResolution = 100 - }; - - viewer.View(viewOptions); -} -``` +For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-set-max-resolution/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets/_index.md index 813ce882d..099af96cf 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets/_index.md @@ -1,14 +1,14 @@ --- title: OptimizeSpreadsheets second_title: GroupDocs.Viewer for .NET API Reference -description: Optimize Excel spreadsheets border lines and fonts for smaller output file size. +description: Enables optimization of spreadsheets in the PDF files. type: docs weight: 70 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets/ --- ## PdfOptimizationOptions.OptimizeSpreadsheets property -Optimize Excel spreadsheets border lines and fonts for smaller output file size. +Enables optimization of spreadsheets in the PDF files. ```csharp public bool OptimizeSpreadsheets { get; set; } @@ -16,26 +16,9 @@ public bool OptimizeSpreadsheets { get; set; } ### Remarks -The output PDF will not include embedded Arial and Times New Roman fonts with characters 32-127. +This optimization allows to reduce the output file size by setting up border lines. Besides that, it removes the Arial and Times New Roman characters of 32-127 codes. -The default value is `false`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("invoice.xlsx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - OptimizeSpreadsheets = true - }; - - viewer.View(viewOptions); -} -``` +For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-spreadsheets/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/pdfoptimizationoptions/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/pdfoptimizationoptions/_index.md index 142012022..7740e94a5 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/pdfoptimizationoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/pdfoptimizationoptions/_index.md @@ -14,20 +14,9 @@ Sets up default values of MaxResolution option to 300 and ImageQuality option to public PdfOptimizationOptions() ``` -### Examples +### Remarks -The example demonstrates a default usage of this class. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions(); - viewOptions.PdfOptimizationOptions.Lineriaze = true; - - viewer.View(viewOptions); -} -``` +For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children. ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeannotations/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeannotations/_index.md index dc0d69f12..65fe92ddb 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeannotations/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeannotations/_index.md @@ -1,14 +1,14 @@ --- title: RemoveAnnotations second_title: GroupDocs.Viewer for .NET API Reference -description: Annotations can be deleted when they are unnecessary. When they are needed but do not require additional editing they can be flattened. It will reduce the file size. +description: Enables removing annotation from the output PDF file. type: docs weight: 80 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/removeannotations/ --- ## PdfOptimizationOptions.RemoveAnnotations property -Annotations can be deleted when they are unnecessary. When they are needed but do not require additional editing, they can be flattened. It will reduce the file size. +Enables removing annotation from the output PDF file. ```csharp public bool RemoveAnnotations { get; set; } @@ -16,24 +16,7 @@ public bool RemoveAnnotations { get; set; } ### Remarks -The default value is `false`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - RemoveAnnotations = true - }; - - viewer.View(viewOptions); -} -``` +For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-remove-annotations/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeformfields/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeformfields/_index.md index 627b9c660..bc0fe354a 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeformfields/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/removeformfields/_index.md @@ -1,14 +1,14 @@ --- title: RemoveFormFields second_title: GroupDocs.Viewer for .NET API Reference -description: If the PDF document contains AcroForms we can try to reduce the file size by flattening form fields. +description: Enables removing form fields from a PDF file. type: docs weight: 90 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/removeformfields/ --- ## PdfOptimizationOptions.RemoveFormFields property -If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields. +Enables removing form fields from a PDF file. ```csharp public bool RemoveFormFields { get; set; } @@ -16,24 +16,7 @@ public bool RemoveFormFields { get; set; } ### Remarks -The default value is `false`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - RemoveFormFields = true - }; - - viewer.View(viewOptions); -} -``` +For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-remove-fields/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/resizeimages/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/resizeimages/_index.md index c19c8c599..ae6e7c33d 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/resizeimages/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/resizeimages/_index.md @@ -1,14 +1,14 @@ --- title: ResizeImages second_title: GroupDocs.Viewer for .NET API Reference -description: Can be used with CompressImage option to resize the images with a lower resolution. In this case we should set CompressImage to true ResizeImages to true and MaxResolution to the appropriate value. +description: Enables setting the maximum resolution in the output PDF file. type: docs weight: 100 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/resizeimages/ --- ## PdfOptimizationOptions.ResizeImages property -Can be used with CompressImage option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value. +Enables setting the maximum resolution in the output PDF file. ```csharp public bool ResizeImages { get; set; } @@ -16,27 +16,7 @@ public bool ResizeImages { get; set; } ### Remarks -The default value is `false`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - CompressImages = true, - ImageQuality = 50, - ResizeImages = true, - MaxResolution = 100 - }; - - viewer.View(viewOptions); -} -``` +To allow this option, set the [`CompressImages`](../compressimages) property to `true`. This option allows setting the [`MaxResolution`](../maxresolution) property. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-set-max-resolution/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts/_index.md b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts/_index.md index 2dfcb1b86..f5a525415 100644 --- a/english/net/groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts/_index.md @@ -1,14 +1,14 @@ --- title: SubsetFonts second_title: GroupDocs.Viewer for .NET API Reference -description: Every font used to display text on the page contains set of glyphs for font characters. PDF specification supports font subset i.e. font with only those glyphs which are used. This may cause issues when text should be updated since probably required glyphs are absent in the font but for the document which is not planned to change this allows to decrease size. +description: Subsets fonts in the output PDF file. type: docs weight: 110 url: /net/groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts/ --- ## PdfOptimizationOptions.SubsetFonts property -Every font used to display text on the page contains set of glyphs for font characters. PDF specification supports "font subset" i.e. font with only those glyphs which are used. This may cause issues when text should be updated (since probably required glyphs are absent in the font), but for the document which is not planned to change this allows to decrease size. +Subsets fonts in the output PDF file. ```csharp public bool SubsetFonts { get; set; } @@ -16,24 +16,7 @@ public bool SubsetFonts { get; set; } ### Remarks -The default value is `false`. - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("sample.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions - { - SubsetFonts = true - }; - - viewer.View(viewOptions); -} -``` +If the file uses embedded fonts, it contains all font data. GroupDocs.Viewer can subset embedded fonts to reduce the file size. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-subset-fonts/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/_index.md index 09a28fa51..7a681cd88 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/_index.md @@ -1,14 +1,14 @@ --- title: PdfOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering PDF documents. +description: Contains options for rendering to PDF documents. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderpdfdocuments/. type: docs weight: 390 url: /net/groupdocs.viewer.options/pdfoptions/ --- ## PdfOptions class -Provides options for rendering PDF documents. +Contains options for rendering to PDF documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/). ```csharp public class PdfOptions @@ -18,21 +18,21 @@ public class PdfOptions | Name | Description | | --- | --- | -| [PdfOptions](pdfoptions)() | Initializes new instance of [`PdfOptions`](../pdfoptions) class. | +| [PdfOptions](pdfoptions)() | Initializes new instance of the [`PdfOptions`](../pdfoptions) class. | ## Properties | Name | Description | | --- | --- | -| [DisableCharsGrouping](../../groupdocs.viewer.options/pdfoptions/disablecharsgrouping) { get; set; } | Disables chars grouping to keep maximum precision during chars positioning when rendering the page. | -| [DisableFontLicenseVerifications](../../groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications) { get; set; } | Disable any license restrictions for all fonts in current XPS/OXPS document | -| [EnableFontHinting](../../groupdocs.viewer.options/pdfoptions/enablefonthinting) { get; set; } | Enables font hinting. The font hinting adjusts the display of an outline font. Supported only for TTF fonts when these fonts are used in source document. | -| [EnableLayeredRendering](../../groupdocs.viewer.options/pdfoptions/enablelayeredrendering) { get; set; } | Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML. | -| [FixedLayout](../../groupdocs.viewer.options/pdfoptions/fixedlayout) { get; set; } | PDF is a fixed format so all of the elements have a specific place on a page. To ensure that the output HTML looks the same as the source PDF the documents are rendered to HTML with a fixed layout by default. When rendering with fixed layout the output HTML has fixed size so the elements will stay on the same place regardless of window size. To render to HTML with fluid layout set this property to `false`. | -| [ImageQuality](../../groupdocs.viewer.options/pdfoptions/imagequality) { get; set; } | Specifies output image quality for image resources when rendering into HTML. The default value is Low. | -| [RenderOriginalPageSize](../../groupdocs.viewer.options/pdfoptions/renderoriginalpagesize) { get; set; } | When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. By default GroupDocs.Viewer calculates output image page size for better rendering quality. | -| [RenderTextAsImage](../../groupdocs.viewer.options/pdfoptions/rendertextasimage) { get; set; } | When this option is set to true, the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. | -| [WrapImagesInSvg](../../groupdocs.viewer.options/pdfoptions/wrapimagesinsvg) { get; set; } | Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality. | +| [DisableCharsGrouping](../../groupdocs.viewer.options/pdfoptions/disablecharsgrouping) { get; set; } | Disables symbol grouping for precise symbol positioning during page rendering. | +| [DisableFontLicenseVerifications](../../groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications) { get; set; } | Disables any license restrictions for all fonts in the current XPS/OXPS document. | +| [EnableFontHinting](../../groupdocs.viewer.options/pdfoptions/enablefonthinting) { get; set; } | Enables font hinting. | +| [EnableLayeredRendering](../../groupdocs.viewer.options/pdfoptions/enablelayeredrendering) { get; set; } | Enables rendering text and graphics in the original PDF document's z-order when rendering to HTML. | +| [FixedLayout](../../groupdocs.viewer.options/pdfoptions/fixedlayout) { get; set; } | Enables rendering the PDF and EPUB documents to HTML with a fixed layout. | +| [ImageQuality](../../groupdocs.viewer.options/pdfoptions/imagequality) { get; set; } | Sets the output image quality for image resources when rendering to HTML. The default quality is `Low`. | +| [RenderOriginalPageSize](../../groupdocs.viewer.options/pdfoptions/renderoriginalpagesize) { get; set; } | Sets the output page size the same as the source PDF document's page size. | +| [RenderTextAsImage](../../groupdocs.viewer.options/pdfoptions/rendertextasimage) { get; set; } | Enables rendering texts in the PDF files as an image in the HTML output. | +| [WrapImagesInSvg](../../groupdocs.viewer.options/pdfoptions/wrapimagesinsvg) { get; set; } | Enables wrapping each image in the output HTML document in SVG tag to improve the output quality. | ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/disablecharsgrouping/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/disablecharsgrouping/_index.md index dee976689..10ff97a78 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/disablecharsgrouping/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/disablecharsgrouping/_index.md @@ -1,19 +1,25 @@ --- title: DisableCharsGrouping second_title: GroupDocs.Viewer for .NET API Reference -description: Disables chars grouping to keep maximum precision during chars positioning when rendering the page. +description: Disables symbol grouping for precise symbol positioning during page rendering. type: docs weight: 20 url: /net/groupdocs.viewer.options/pdfoptions/disablecharsgrouping/ --- ## PdfOptions.DisableCharsGrouping property -Disables chars grouping to keep maximum precision during chars positioning when rendering the page. +Disables symbol grouping for precise symbol positioning during page rendering. ```csharp public bool DisableCharsGrouping { get; set; } ``` +### Remarks + +When converting PDF files, GroupDocs.Viewer groups individual characters into words for enhanced rendering performance. If your document includes hieroglyphics or special symbols, you might want to prohibit character grouping to ensure a more precise layout. The default value is `false`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#disable-character-grouping). + ### See Also * class [PdfOptions](../../pdfoptions) diff --git a/english/net/groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications/_index.md index 83592dad0..bd277839b 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications/_index.md @@ -1,14 +1,14 @@ --- title: DisableFontLicenseVerifications second_title: GroupDocs.Viewer for .NET API Reference -description: Disable any license restrictions for all fonts in current XPS/OXPS document +description: Disables any license restrictions for all fonts in the current XPS/OXPS document. type: docs weight: 30 url: /net/groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications/ --- ## PdfOptions.DisableFontLicenseVerifications property -Disable any license restrictions for all fonts in current XPS/OXPS document +Disables any license restrictions for all fonts in the current XPS/OXPS document. ```csharp public bool DisableFontLicenseVerifications { get; set; } @@ -16,20 +16,11 @@ public bool DisableFontLicenseVerifications { get; set; } ### Remarks -Many operations with font can’t be executed if these operations are prohibited by license of this font. For example some font can’t be embedded into PDF document if license rules disable embedding for this font. Be careful when using this flag. When it is set it means that person who sets this flag, takes all responsibility of possible license/law violations on himself. So He takes it on it’s own risk. It’s strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false. +Many operations with font cannot be executed if they are prohibited by license of this font. For example, some font cannot be embedded into PDF document if license rules disable embedding for this font. This option allows you to skip verification of these rules. -### Examples +Be careful when using this flag. When it is set, it means that person who sets this flag, takes all responsibility of possible license/law violations on himself. So he takes it on its own risk. It is strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. The default value is `false`. -The example demonstrates a typical usage of this option. - -```csharp -using (Viewer viewer = new Viewer("resume.oxps")) -{ - HtmlViewOptions options = HtmlViewOptions.ForEmbeddedResources("result.html"); - options.PdfOptions.DisableFontLicenseVerifications = true; - viewer.View(options); -} -``` +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#skip-font-license-verification-when-rendering-xps-and-oxps-files). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/enablefonthinting/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/enablefonthinting/_index.md index e9d30754d..215404c12 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/enablefonthinting/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/enablefonthinting/_index.md @@ -1,14 +1,14 @@ --- title: EnableFontHinting second_title: GroupDocs.Viewer for .NET API Reference -description: Enables font hinting. The font hinting adjusts the display of an outline font. Supported only for TTF fonts when these fonts are used in source document. +description: Enables font hinting. type: docs weight: 40 url: /net/groupdocs.viewer.options/pdfoptions/enablefonthinting/ --- ## PdfOptions.EnableFontHinting property -Enables font hinting. The font hinting adjusts the display of an outline font. Supported only for TTF fonts when these fonts are used in source document. +Enables font hinting. ```csharp public bool EnableFontHinting { get; set; } @@ -16,7 +16,9 @@ public bool EnableFontHinting { get; set; } ### Remarks -This option is supported when rendering into PNG or JPG formats. +Font hinting adjusts how an outline font is displayed. Only applicable to TTF fonts used in the source document. This option is available for rendering to PNG or JPG formats. The default value is `false`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#enable-font-hinting). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/enablelayeredrendering/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/enablelayeredrendering/_index.md index d2b8ccd00..ed65547ff 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/enablelayeredrendering/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/enablelayeredrendering/_index.md @@ -1,14 +1,14 @@ --- title: EnableLayeredRendering second_title: GroupDocs.Viewer for .NET API Reference -description: Enables rendering of text and graphics according to zorder in original PDF document when rendering into HTML. +description: Enables rendering text and graphics in the original PDF documents zorder when rendering to HTML. type: docs weight: 50 url: /net/groupdocs.viewer.options/pdfoptions/enablelayeredrendering/ --- ## PdfOptions.EnableLayeredRendering property -Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML. +Enables rendering text and graphics in the original PDF document's z-order when rendering to HTML. ```csharp public bool EnableLayeredRendering { get; set; } @@ -16,7 +16,9 @@ public bool EnableLayeredRendering { get; set; } ### Remarks -By default text and graphics are rendered into HTML as a single layer. +By default, GroupDocs.Veiewer renders text and graphics as a single layer in HTML. This option lets you arrange objects in the same order as in the source file. The default value is `false`. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#enable-multi-layer-rendering). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/fixedlayout/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/fixedlayout/_index.md index f864bece8..44724983e 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/fixedlayout/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/fixedlayout/_index.md @@ -1,14 +1,14 @@ --- title: FixedLayout second_title: GroupDocs.Viewer for .NET API Reference -description: PDF is a fixed format so all of the elements have a specific place on a page. To ensure that the output HTML looks the same as the source PDF the documents are rendered to HTML with a fixed layout by default. When rendering with fixed layout the output HTML has fixed size so the elements will stay on the same place regardless of window size. To render to HTML with fluid layout set this property to false. +description: Enables rendering the PDF and EPUB documents to HTML with a fixed layout. type: docs weight: 60 url: /net/groupdocs.viewer.options/pdfoptions/fixedlayout/ --- ## PdfOptions.FixedLayout property -PDF is a fixed format so all of the elements have a specific place on a page. To ensure that the output HTML looks the same as the source PDF the documents are rendered to HTML with a fixed layout by default. When rendering with fixed layout the output HTML has fixed size so the elements will stay on the same place regardless of window size. To render to HTML with fluid layout set this property to `false`. +Enables rendering the PDF and EPUB documents to HTML with a fixed layout. ```csharp public bool FixedLayout { get; set; } @@ -16,28 +16,13 @@ public bool FixedLayout { get; set; } ### Remarks -The default value is `true`. +PDF and EPUB documents are initially rendered to HTML with a fixed layout to maintain the appearance of the source document. This fixed layout means all HTML elements have precise positions within a container with a set size. Resizing the browser window is not affect the position and size of elements in the document. -This option is supported when rendering into HTML. +This option is only available when rendering to HTML. The default value is `true`. To render with a fluid layout, set this property to `false`. -When rendering to fluid layout images are skipped. Use fluid layout when rendering PDF documents with textual content. +When rendering to fluid layout, images are skipped. Use fluid layout when rendering PDF documents with text content. -### Examples - -This example shows how to render PDF document to HTML with fluid layout. - -```csharp -using GroupDocs.Viewer; -using GroupDocs.Viewer.Options; -//.. - -using (var viewer = new Viewer("resume.pdf")) -{ - var viewOptions = HtmlViewOptions.ForEmbeddedResources("page_{0}.html"); - viewOptions.FixedLayout = false; - viewer.View(viewOptions); -} -``` +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#create-html-with-fluid-layout). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/imagequality/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/imagequality/_index.md index 5a0ccddad..6b906c5dd 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/imagequality/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/imagequality/_index.md @@ -1,19 +1,23 @@ --- title: ImageQuality second_title: GroupDocs.Viewer for .NET API Reference -description: Specifies output image quality for image resources when rendering into HTML. The default value is Low. +description: Sets the output image quality for image resources when rendering to HTML. The default quality is Low. type: docs weight: 70 url: /net/groupdocs.viewer.options/pdfoptions/imagequality/ --- ## PdfOptions.ImageQuality property -Specifies output image quality for image resources when rendering into HTML. The default value is Low. +Sets the output image quality for image resources when rendering to HTML. The default quality is `Low`. ```csharp public ImageQuality ImageQuality { get; set; } ``` +### Remarks + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#adjust-image-quality-in-the-output-html-file). + ### See Also * enum [ImageQuality](../../imagequality) diff --git a/english/net/groupdocs.viewer.options/pdfoptions/pdfoptions/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/pdfoptions/_index.md index b98b1ab8e..44f06f284 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/pdfoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/pdfoptions/_index.md @@ -1,14 +1,14 @@ --- title: PdfOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of PdfOptionsgroupdocs.viewer.options/pdfoptions class. +description: Initializes new instance of the PdfOptionsgroupdocs.viewer.options/pdfoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/pdfoptions/pdfoptions/ --- ## PdfOptions constructor -Initializes new instance of [`PdfOptions`](../../pdfoptions) class. +Initializes new instance of the [`PdfOptions`](../../pdfoptions) class. ```csharp public PdfOptions() diff --git a/english/net/groupdocs.viewer.options/pdfoptions/renderoriginalpagesize/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/renderoriginalpagesize/_index.md index c317f5b7e..d4b44add4 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/renderoriginalpagesize/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/renderoriginalpagesize/_index.md @@ -1,14 +1,14 @@ --- title: RenderOriginalPageSize second_title: GroupDocs.Viewer for .NET API Reference -description: When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. By default GroupDocs.Viewer calculates output image page size for better rendering quality. +description: Sets the output page size the same as the source PDF documents page size. type: docs weight: 80 url: /net/groupdocs.viewer.options/pdfoptions/renderoriginalpagesize/ --- ## PdfOptions.RenderOriginalPageSize property -When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. By default GroupDocs.Viewer calculates output image page size for better rendering quality. +Sets the output page size the same as the source PDF document's page size. ```csharp public bool RenderOriginalPageSize { get; set; } @@ -16,7 +16,11 @@ public bool RenderOriginalPageSize { get; set; } ### Remarks -This option is supported when rendering into PNG or JPG formats. +By default, GroupDocs.Viewer calculates output image page size for better rendering quality. Enable this option to ensure the output pages have the same size as the source PDF document's page size (in pixels). The default value is `false`. + +This option is available for rendering to PNG or JPG formats. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#preserve-the-size-of-document-pages). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/rendertextasimage/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/rendertextasimage/_index.md index 836da8a06..237055664 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/rendertextasimage/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/rendertextasimage/_index.md @@ -1,14 +1,14 @@ --- title: RenderTextAsImage second_title: GroupDocs.Viewer for .NET API Reference -description: When this option is set to true the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. +description: Enables rendering texts in the PDF files as an image in the HTML output. type: docs weight: 90 url: /net/groupdocs.viewer.options/pdfoptions/rendertextasimage/ --- ## PdfOptions.RenderTextAsImage property -When this option is set to true, the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. +Enables rendering texts in the PDF files as an image in the HTML output. ```csharp public bool RenderTextAsImage { get; set; } @@ -16,7 +16,11 @@ public bool RenderTextAsImage { get; set; } ### Remarks -This option is supported when rendering into HTML. +When this option is set to `true`, GroupDocs.Viewer renders text as an image in the HTML output. This makes the text unselectable and enhances character rendering, ensuring a PDF-like appearance in HTML. The default value is `false`. + +This option is available for rendering to HTML. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#render-text-as-an-image). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfoptions/wrapimagesinsvg/_index.md b/english/net/groupdocs.viewer.options/pdfoptions/wrapimagesinsvg/_index.md index a1df5d15b..77bde4f31 100644 --- a/english/net/groupdocs.viewer.options/pdfoptions/wrapimagesinsvg/_index.md +++ b/english/net/groupdocs.viewer.options/pdfoptions/wrapimagesinsvg/_index.md @@ -1,14 +1,14 @@ --- title: WrapImagesInSvg second_title: GroupDocs.Viewer for .NET API Reference -description: Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality. +description: Enables wrapping each image in the output HTML document in SVG tag to improve the output quality. type: docs weight: 100 url: /net/groupdocs.viewer.options/pdfoptions/wrapimagesinsvg/ --- ## PdfOptions.WrapImagesInSvg property -Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality. +Enables wrapping each image in the output HTML document in SVG tag to improve the output quality. ```csharp public bool WrapImagesInSvg { get; set; } @@ -16,29 +16,11 @@ public bool WrapImagesInSvg { get; set; } ### Remarks -This option is supported when rendering [PDF and Page Layout file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#pdf-and-page-layout-file-formats) to HTML with embedded and external resources. +By default, when rendering PDF and Page Layout files to HTML, all images are rendered as one PNG image. The rendered PNG image is used as the background for the output HTML document. -By default, when rendering to PDF and Page Layout files, all the images are rendered as one PNG image. The rendered PNG image is used as the background for the output HTML document. +This option is available when rendering [PDF and Page Layout file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#pdf-and-page-layout-file-formats) to HTML with embedded and external resources. It enables wrapping each image in the output HTML document in SVG tag. The default value is `false`. -Learn more: - -* [Render PDF documents as HTML and image files](https://docs.groupdocs.com/viewer/net/render-pdf-documents/) -* [Render to HTML](https://docs.groupdocs.com/viewer/net/rendering-to-html/) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (Viewer viewer = new Viewer("resume.pdf")) -{ - HtmlViewOptions viewOptions = - HtmlViewOptions.ForEmbeddedResources(); - viewOptions.PdfOptions.WrapImagesInSvg = true; - - viewer.View(viewOptions); -} -``` +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#enclose-images-in-svg-when-rendering-pdf-and-page-layout-files). ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/_index.md index 6d17afbc8..878465f56 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: PdfViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering documents into PDF format. +description: Contains options for rendering documents into PDF format. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderingtopdf/. type: docs weight: 400 url: /net/groupdocs.viewer.options/pdfviewoptions/ --- ## PdfViewOptions class -Provides options for rendering documents into PDF format. +Contains options for rendering documents into PDF format. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). ```csharp public class PdfViewOptions : ViewOptions @@ -18,11 +18,11 @@ public class PdfViewOptions : ViewOptions | Name | Description | | --- | --- | -| [PdfViewOptions](pdfviewoptions#constructor)() | Initializes new instance of [`PdfViewOptions`](../pdfviewoptions) class. | -| [PdfViewOptions](pdfviewoptions#constructor_1)(CreateFileStream) | Initializes new instance of [`PdfViewOptions`](../pdfviewoptions) class. | -| [PdfViewOptions](pdfviewoptions#constructor_3)(IFileStreamFactory) | Initializes new instance of [`PdfViewOptions`](../pdfviewoptions) class. | -| [PdfViewOptions](pdfviewoptions#constructor_4)(string) | Initializes new instance of [`PdfViewOptions`](../pdfviewoptions) class. | -| [PdfViewOptions](pdfviewoptions#constructor_2)(CreateFileStream, ReleaseFileStream) | Initializes new instance of [`PdfViewOptions`](../pdfviewoptions) class. | +| [PdfViewOptions](pdfviewoptions#constructor)() | Initializes an instance of [`PdfViewOptions`](../pdfviewoptions) class. | +| [PdfViewOptions](pdfviewoptions#constructor_1)(CreateFileStream) | Initializes an instance of [`PdfViewOptions`](../pdfviewoptions) class. | +| [PdfViewOptions](pdfviewoptions#constructor_3)(IFileStreamFactory) | Initializes an instance of [`PdfViewOptions`](../pdfviewoptions) class. | +| [PdfViewOptions](pdfviewoptions#constructor_4)(string) | Initializes an instance of [`PdfViewOptions`](../pdfviewoptions) class. | +| [PdfViewOptions](pdfviewoptions#constructor_2)(CreateFileStream, ReleaseFileStream) | Initializes an instance of [`PdfViewOptions`](../pdfviewoptions) class. | ## Properties @@ -30,40 +30,40 @@ public class PdfViewOptions : ViewOptions | --- | --- | | [ArchiveOptions](../../groupdocs.viewer.options/baseviewoptions/archiveoptions) { get; set; } | The archive files view options. | | [CadOptions](../../groupdocs.viewer.options/baseviewoptions/cadoptions) { get; set; } | The CAD drawing view options. | -| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Default font to be used when particular font used in document can't be found. | +| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Sets the default font for a document. | | [EmailOptions](../../groupdocs.viewer.options/baseviewoptions/emailoptions) { get; set; } | The email messages view options. | -| [ImageHeight](../../groupdocs.viewer.options/pdfviewoptions/imageheight) { get; set; } | The height of an output image in pixels. (When converting single image to HTML only) | -| [ImageMaxHeight](../../groupdocs.viewer.options/pdfviewoptions/imagemaxheight) { get; set; } | Max height of an output image in pixels. (When converting single image to HTML only) | -| [ImageMaxWidth](../../groupdocs.viewer.options/pdfviewoptions/imagemaxwidth) { get; set; } | Max width of an output image in pixels. (When converting single image to HTML only) | -| [ImageWidth](../../groupdocs.viewer.options/pdfviewoptions/imagewidth) { get; set; } | The width of the output image in pixels. (When converting single image to HTML only) | +| [ImageHeight](../../groupdocs.viewer.options/pdfviewoptions/imageheight) { get; set; } | Sets the height of an output image (in pixels). | +| [ImageMaxHeight](../../groupdocs.viewer.options/pdfviewoptions/imagemaxheight) { get; set; } | Sets the maximum height of an output image (in pixels). | +| [ImageMaxWidth](../../groupdocs.viewer.options/pdfviewoptions/imagemaxwidth) { get; set; } | Sets the maximum width of an output image (in pixels). | +| [ImageWidth](../../groupdocs.viewer.options/pdfviewoptions/imagewidth) { get; set; } | Sets the width of an output image (in pixels). | | [MailStorageOptions](../../groupdocs.viewer.options/baseviewoptions/mailstorageoptions) { get; set; } | Mail storage data files view options. | -| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The MS Outlook data files view options. | -| [PdfOptimizationOptions](../../groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions) { get; set; } | Reduce output PDF file size applying optimization techniques with different options. | -| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF documents view options. | -| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation processing documents view options. | +| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The Microsoft Outlook data files view options. | +| [PdfOptimizationOptions](../../groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions) { get; set; } | Reduces output PDF file size by applying optimization techniques with different options. | +| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF document view options. | +| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation files view options. | | [ProjectManagementOptions](../../groupdocs.viewer.options/baseviewoptions/projectmanagementoptions) { get; set; } | The project management files view options. | | [RenderComments](../../groupdocs.viewer.options/baseviewoptions/rendercomments) { get; set; } | Enables rendering comments. | | [RenderHiddenPages](../../groupdocs.viewer.options/baseviewoptions/renderhiddenpages) { get; set; } | Enables rendering of hidden pages. | | [RenderNotes](../../groupdocs.viewer.options/baseviewoptions/rendernotes) { get; set; } | Enables rendering notes. | -| [Security](../../groupdocs.viewer.options/pdfviewoptions/security) { get; set; } | The output PDF document security options. | +| [Security](../../groupdocs.viewer.options/pdfviewoptions/security) { get; set; } | Sets the output PDF document security options. | | [SpreadsheetOptions](../../groupdocs.viewer.options/baseviewoptions/spreadsheetoptions) { get; set; } | The spreadsheet files view options. | -| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files splitting to pages options. | -| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files processing documents view options. | -| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark applied to each page. | -| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files view options. | +| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files view options. | +| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark to be applied to each page. | +| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | The Web files view options. | +| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | The Word processing files view options. | ## Methods | Name | Description | | --- | --- | -| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies clockwise rotation to the page. | +| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies the clockwise rotation to a page. | ## Fields | Name | Description | | --- | --- | -| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotations. | +| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotation. | ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/imageheight/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/imageheight/_index.md index 28cdebbd0..4d142f1f1 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/imageheight/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/imageheight/_index.md @@ -1,19 +1,25 @@ --- title: ImageHeight second_title: GroupDocs.Viewer for .NET API Reference -description: The height of an output image in pixels. When converting single image to HTML only +description: Sets the height of an output image in pixels. type: docs weight: 20 url: /net/groupdocs.viewer.options/pdfviewoptions/imageheight/ --- ## PdfViewOptions.ImageHeight property -The height of an output image in pixels. (When converting single image to HTML only) +Sets the height of an output image (in pixels). ```csharp public int ImageHeight { get; set; } ``` +### Remarks + +Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/). + +If you set this property, the [`ImageMaxHeight`](../imagemaxheight) property is ignored. + ### See Also * class [PdfViewOptions](../../pdfviewoptions) diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxheight/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxheight/_index.md index f6330f2a9..fcaf79cd0 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxheight/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxheight/_index.md @@ -1,19 +1,25 @@ --- title: ImageMaxHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Max height of an output image in pixels. When converting single image to HTML only +description: Sets the maximum height of an output image in pixels. type: docs weight: 30 url: /net/groupdocs.viewer.options/pdfviewoptions/imagemaxheight/ --- ## PdfViewOptions.ImageMaxHeight property -Max height of an output image in pixels. (When converting single image to HTML only) +Sets the maximum height of an output image (in pixels). ```csharp public int ImageMaxHeight { get; set; } ``` +### Remarks + +Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/). + +If you set the [`ImageHeight`](../imageheight) property, this property is ignored. + ### See Also * class [PdfViewOptions](../../pdfviewoptions) diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxwidth/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxwidth/_index.md index 7e8b6ba50..91400868f 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxwidth/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/imagemaxwidth/_index.md @@ -1,19 +1,25 @@ --- title: ImageMaxWidth second_title: GroupDocs.Viewer for .NET API Reference -description: Max width of an output image in pixels. When converting single image to HTML only +description: Sets the maximum width of an output image in pixels. type: docs weight: 40 url: /net/groupdocs.viewer.options/pdfviewoptions/imagemaxwidth/ --- ## PdfViewOptions.ImageMaxWidth property -Max width of an output image in pixels. (When converting single image to HTML only) +Sets the maximum width of an output image (in pixels). ```csharp public int ImageMaxWidth { get; set; } ``` +### Remarks + +Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/). + +If you set the [`ImageWidth`](../imagewidth) property, this property is ignored. + ### See Also * class [PdfViewOptions](../../pdfviewoptions) diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/imagewidth/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/imagewidth/_index.md index ced6aa05f..55a293e85 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/imagewidth/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/imagewidth/_index.md @@ -1,19 +1,25 @@ --- title: ImageWidth second_title: GroupDocs.Viewer for .NET API Reference -description: The width of the output image in pixels. When converting single image to HTML only +description: Sets the width of an output image in pixels. type: docs weight: 50 url: /net/groupdocs.viewer.options/pdfviewoptions/imagewidth/ --- ## PdfViewOptions.ImageWidth property -The width of the output image in pixels. (When converting single image to HTML only) +Sets the width of an output image (in pixels). ```csharp public int ImageWidth { get; set; } ``` +### Remarks + +Use this property to set the output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/). + +If you set this property, the [`ImageMaxWidth`](../imagemaxwidth) property is ignored. + ### See Also * class [PdfViewOptions](../../pdfviewoptions) diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions/_index.md index dbc2337f2..ba888f966 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions/_index.md @@ -1,14 +1,14 @@ --- title: PdfOptimizationOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Reduce output PDF file size applying optimization techniques with different options. +description: Reduces output PDF file size by applying optimization techniques with different options. type: docs weight: 60 url: /net/groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions/ --- ## PdfViewOptions.PdfOptimizationOptions property -Reduce output PDF file size applying optimization techniques with different options. +Reduces output PDF file size by applying optimization techniques with different options. ```csharp public PdfOptimizationOptions PdfOptimizationOptions { get; set; } @@ -16,24 +16,7 @@ public PdfOptimizationOptions PdfOptimizationOptions { get; set; } ### Remarks -This option is supported for any input file formats which are supported for conversion to PDF. - -* [Supported document formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/) - -### Examples - -The example demonstrates a typical usage of this option. - -```csharp -using (var viewer = new Viewer("cv.docx")) -{ - PdfViewOptions viewOptions = new PdfViewOptions(); - viewOptions.PdfOptimizationOptions = new PdfOptimizationOptions(); - viewOptions.PdfOptimizationOptions.Lineriaze = true; - - viewer.View(viewOptions); -} -``` +For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children. ### See Also diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/pdfviewoptions/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/pdfviewoptions/_index.md index f02ea0544..eb2776815 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/pdfviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/pdfviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: PdfViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of PdfViewOptionsgroupdocs.viewer.options/pdfviewoptions class. +description: Initializes an instance of PdfViewOptionsgroupdocs.viewer.options/pdfviewoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/pdfviewoptions/pdfviewoptions/ --- ## PdfViewOptions(CreateFileStream) {#constructor_1} -Initializes new instance of [`PdfViewOptions`](../../pdfviewoptions) class. +Initializes an instance of [`PdfViewOptions`](../../pdfviewoptions) class. ```csharp public PdfViewOptions(CreateFileStream createFileStream) @@ -24,6 +24,10 @@ public PdfViewOptions(CreateFileStream createFileStream) | --- | --- | | ArgumentNullException | Thrown when *createFileStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). + ### See Also * delegate [CreateFileStream](../../../groupdocs.viewer.interfaces/createfilestream) @@ -35,7 +39,7 @@ public PdfViewOptions(CreateFileStream createFileStream) ## PdfViewOptions(CreateFileStream, ReleaseFileStream) {#constructor_2} -Initializes new instance of [`PdfViewOptions`](../../pdfviewoptions) class. +Initializes an instance of [`PdfViewOptions`](../../pdfviewoptions) class. ```csharp public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream) @@ -53,6 +57,10 @@ public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream relea | ArgumentNullException | Thrown when *createFileStream* is null. | | ArgumentNullException | Thrown when *releaseFileStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). + ### See Also * delegate [CreateFileStream](../../../groupdocs.viewer.interfaces/createfilestream) @@ -65,7 +73,7 @@ public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream relea ## PdfViewOptions(IFileStreamFactory) {#constructor_3} -Initializes new instance of [`PdfViewOptions`](../../pdfviewoptions) class. +Initializes an instance of [`PdfViewOptions`](../../pdfviewoptions) class. ```csharp public PdfViewOptions(IFileStreamFactory fileStreamFactory) @@ -81,6 +89,10 @@ public PdfViewOptions(IFileStreamFactory fileStreamFactory) | --- | --- | | ArgumentNullException | Thrown when *fileStreamFactory* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). + ### See Also * interface [IFileStreamFactory](../../../groupdocs.viewer.interfaces/ifilestreamfactory) @@ -92,7 +104,7 @@ public PdfViewOptions(IFileStreamFactory fileStreamFactory) ## PdfViewOptions() {#constructor} -Initializes new instance of [`PdfViewOptions`](../../pdfviewoptions) class. +Initializes an instance of [`PdfViewOptions`](../../pdfviewoptions) class. ```csharp public PdfViewOptions() @@ -100,7 +112,9 @@ public PdfViewOptions() ### Remarks -This constructor initializes new instance of [`PdfViewOptions`](../../pdfviewoptions) with "output.pdf" as file path format for the output file. The output file will be placed into current working directory of the application. +This constructor Initializes an instance of [`PdfViewOptions`](../../pdfviewoptions) with "output.pdf" as file path format for the output file. The output file will be placed into current working directory of the application. + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). ### See Also @@ -112,7 +126,7 @@ This constructor initializes new instance of [`PdfViewOptions`](../../pdfviewopt ## PdfViewOptions(string) {#constructor_4} -Initializes new instance of [`PdfViewOptions`](../../pdfviewoptions) class. +Initializes an instance of [`PdfViewOptions`](../../pdfviewoptions) class. ```csharp public PdfViewOptions(string outputFilePath) @@ -128,6 +142,10 @@ public PdfViewOptions(string outputFilePath) | --- | --- | | ArgumentException | Thrown when *outputFilePath* is null or empty. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). + ### See Also * class [PdfViewOptions](../../pdfviewoptions) diff --git a/english/net/groupdocs.viewer.options/pdfviewoptions/security/_index.md b/english/net/groupdocs.viewer.options/pdfviewoptions/security/_index.md index 10c17a901..44feaf8fd 100644 --- a/english/net/groupdocs.viewer.options/pdfviewoptions/security/_index.md +++ b/english/net/groupdocs.viewer.options/pdfviewoptions/security/_index.md @@ -1,19 +1,23 @@ --- title: Security second_title: GroupDocs.Viewer for .NET API Reference -description: The output PDF document security options. +description: Sets the output PDF document security options. type: docs weight: 70 url: /net/groupdocs.viewer.options/pdfviewoptions/security/ --- ## PdfViewOptions.Security property -The output PDF document security options. +Sets the output PDF document security options. ```csharp public Security Security { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/). + ### See Also * class [Security](../../security) diff --git a/english/net/groupdocs.viewer.options/permissions/_index.md b/english/net/groupdocs.viewer.options/permissions/_index.md index 00dd3ca85..bc14e1674 100644 --- a/english/net/groupdocs.viewer.options/permissions/_index.md +++ b/english/net/groupdocs.viewer.options/permissions/_index.md @@ -20,10 +20,10 @@ public enum Permissions | Name | Value | Description | | --- | --- | --- | | AllowAll | `0` | Allow printing, modification and data extraction. | -| DenyPrinting | `1` | Deny printing | -| DenyModification | `2` | Deny to modify content, fill in forms, add or modify annotations. | +| DenyPrinting | `1` | Deny printing. | +| DenyModification | `2` | Deny content modification, filling in forms, adding or modifying annotations. | | DenyDataExtraction | `4` | Deny text and graphics extraction. | -| DenyAll | `7` | Deny printing, modification and data extraction. | +| DenyAll | `7` | Deny printing, content modification and data extraction. | ### See Also diff --git a/english/net/groupdocs.viewer.options/pngviewoptions/_index.md b/english/net/groupdocs.viewer.options/pngviewoptions/_index.md index 27a4df950..3e5c1da92 100644 --- a/english/net/groupdocs.viewer.options/pngviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pngviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: PngViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering documents into PNG format. +description: Contains options for rendering documents into PNG format. For details see this pagehttps//docs.groupdocs.com/viewer/net/renderingtopngorjpeg/ and its children. type: docs weight: 420 url: /net/groupdocs.viewer.options/pngviewoptions/ --- ## PngViewOptions class -Provides options for rendering documents into PNG format. +Contains options for rendering documents into PNG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children. ```csharp public class PngViewOptions : ViewOptions, IMaxSizeOptions @@ -18,11 +18,11 @@ public class PngViewOptions : ViewOptions, IMaxSizeOptions | Name | Description | | --- | --- | -| [PngViewOptions](pngviewoptions#constructor)() | Initializes new instance of [`PngViewOptions`](../pngviewoptions) class. | -| [PngViewOptions](pngviewoptions#constructor_1)(CreatePageStream) | Initializes new instance of [`PngViewOptions`](../pngviewoptions) class. | -| [PngViewOptions](pngviewoptions#constructor_3)(IPageStreamFactory) | Initializes new instance of [`PngViewOptions`](../pngviewoptions) class. | -| [PngViewOptions](pngviewoptions#constructor_4)(string) | Initializes new instance of [`PngViewOptions`](../pngviewoptions) class. | -| [PngViewOptions](pngviewoptions#constructor_2)(CreatePageStream, ReleasePageStream) | Initializes new instance of [`PngViewOptions`](../pngviewoptions) class. | +| [PngViewOptions](pngviewoptions#constructor)() | Initializes an instance of the [`PngViewOptions`](../pngviewoptions) class. | +| [PngViewOptions](pngviewoptions#constructor_1)(CreatePageStream) | Initializes an instance of the [`PngViewOptions`](../pngviewoptions) class. | +| [PngViewOptions](pngviewoptions#constructor_3)(IPageStreamFactory) | Initializes an instance of the [`PngViewOptions`](../pngviewoptions) class. | +| [PngViewOptions](pngviewoptions#constructor_4)(string) | Initializes an instance of the [`PngViewOptions`](../pngviewoptions) class. | +| [PngViewOptions](pngviewoptions#constructor_2)(CreatePageStream, ReleasePageStream) | Initializes an instance of the [`PngViewOptions`](../pngviewoptions) class. | ## Properties @@ -30,39 +30,39 @@ public class PngViewOptions : ViewOptions, IMaxSizeOptions | --- | --- | | [ArchiveOptions](../../groupdocs.viewer.options/baseviewoptions/archiveoptions) { get; set; } | The archive files view options. | | [CadOptions](../../groupdocs.viewer.options/baseviewoptions/cadoptions) { get; set; } | The CAD drawing view options. | -| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Default font to be used when particular font used in document can't be found. | +| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Sets the default font for a document. | | [EmailOptions](../../groupdocs.viewer.options/baseviewoptions/emailoptions) { get; set; } | The email messages view options. | | [ExtractText](../../groupdocs.viewer.options/pngviewoptions/extracttext) { get; set; } | Enables text extraction. | -| [Height](../../groupdocs.viewer.options/pngviewoptions/height) { get; set; } | The height of an output image in pixels. | +| [Height](../../groupdocs.viewer.options/pngviewoptions/height) { get; set; } | Sets the height of an output image (in pixels). | | [MailStorageOptions](../../groupdocs.viewer.options/baseviewoptions/mailstorageoptions) { get; set; } | Mail storage data files view options. | -| [MaxHeight](../../groupdocs.viewer.options/pngviewoptions/maxheight) { get; set; } | Max height of an output image in pixels. | -| [MaxWidth](../../groupdocs.viewer.options/pngviewoptions/maxwidth) { get; set; } | Max width of an output image in pixels. | -| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The MS Outlook data files view options. | -| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF documents view options. | -| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation processing documents view options. | +| [MaxHeight](../../groupdocs.viewer.options/pngviewoptions/maxheight) { get; set; } | Sets the maximum height of an output image (in pixels). | +| [MaxWidth](../../groupdocs.viewer.options/pngviewoptions/maxwidth) { get; set; } | Sets the maximum width of an output image (in pixels). | +| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The Microsoft Outlook data files view options. | +| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF document view options. | +| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation files view options. | | [ProjectManagementOptions](../../groupdocs.viewer.options/baseviewoptions/projectmanagementoptions) { get; set; } | The project management files view options. | | [RenderComments](../../groupdocs.viewer.options/baseviewoptions/rendercomments) { get; set; } | Enables rendering comments. | | [RenderHiddenPages](../../groupdocs.viewer.options/baseviewoptions/renderhiddenpages) { get; set; } | Enables rendering of hidden pages. | | [RenderNotes](../../groupdocs.viewer.options/baseviewoptions/rendernotes) { get; set; } | Enables rendering notes. | | [SpreadsheetOptions](../../groupdocs.viewer.options/baseviewoptions/spreadsheetoptions) { get; set; } | The spreadsheet files view options. | -| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files splitting to pages options. | -| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files processing documents view options. | -| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark applied to each page. | -| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [Width](../../groupdocs.viewer.options/pngviewoptions/width) { get; set; } | The width of the output image in pixels. | -| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files view options. | +| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files view options. | +| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark to be applied to each page. | +| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | The Web files view options. | +| [Width](../../groupdocs.viewer.options/pngviewoptions/width) { get; set; } | The width of the output image (in pixels). | +| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | The Word processing files view options. | ## Methods | Name | Description | | --- | --- | -| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies clockwise rotation to the page. | +| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies the clockwise rotation to a page. | ## Fields | Name | Description | | --- | --- | -| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotations. | +| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotation. | ### See Also diff --git a/english/net/groupdocs.viewer.options/pngviewoptions/extracttext/_index.md b/english/net/groupdocs.viewer.options/pngviewoptions/extracttext/_index.md index 526e5dcbd..76492f370 100644 --- a/english/net/groupdocs.viewer.options/pngviewoptions/extracttext/_index.md +++ b/english/net/groupdocs.viewer.options/pngviewoptions/extracttext/_index.md @@ -16,7 +16,9 @@ public bool ExtractText { get; set; } ### Remarks -This option might be useful when you want to add selectable text layer over the image. +Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/). ### See Also diff --git a/english/net/groupdocs.viewer.options/pngviewoptions/height/_index.md b/english/net/groupdocs.viewer.options/pngviewoptions/height/_index.md index d52b41f57..ea766eef9 100644 --- a/english/net/groupdocs.viewer.options/pngviewoptions/height/_index.md +++ b/english/net/groupdocs.viewer.options/pngviewoptions/height/_index.md @@ -1,19 +1,25 @@ --- title: Height second_title: GroupDocs.Viewer for .NET API Reference -description: The height of an output image in pixels. +description: Sets the height of an output image in pixels. type: docs weight: 30 url: /net/groupdocs.viewer.options/pngviewoptions/height/ --- ## PngViewOptions.Height property -The height of an output image in pixels. +Sets the height of an output image (in pixels). ```csharp public int Height { get; set; } ``` +### Remarks + +Use this property to set the output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/). + +If you set this property, the [`MaxHeight`](../maxheight) property is ignored. + ### See Also * class [PngViewOptions](../../pngviewoptions) diff --git a/english/net/groupdocs.viewer.options/pngviewoptions/maxheight/_index.md b/english/net/groupdocs.viewer.options/pngviewoptions/maxheight/_index.md index 9cc7924c0..8f7b36855 100644 --- a/english/net/groupdocs.viewer.options/pngviewoptions/maxheight/_index.md +++ b/english/net/groupdocs.viewer.options/pngviewoptions/maxheight/_index.md @@ -1,19 +1,25 @@ --- title: MaxHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Max height of an output image in pixels. +description: Sets the maximum height of an output image in pixels. type: docs weight: 40 url: /net/groupdocs.viewer.options/pngviewoptions/maxheight/ --- ## PngViewOptions.MaxHeight property -Max height of an output image in pixels. +Sets the maximum height of an output image (in pixels). ```csharp public int MaxHeight { get; set; } ``` +### Remarks + +Use this property to set the maximum output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/). + +If you set the [`Height`](../height) property, this property is ignored. + ### See Also * class [PngViewOptions](../../pngviewoptions) diff --git a/english/net/groupdocs.viewer.options/pngviewoptions/maxwidth/_index.md b/english/net/groupdocs.viewer.options/pngviewoptions/maxwidth/_index.md index 4c05c8720..4a1ed70b6 100644 --- a/english/net/groupdocs.viewer.options/pngviewoptions/maxwidth/_index.md +++ b/english/net/groupdocs.viewer.options/pngviewoptions/maxwidth/_index.md @@ -1,19 +1,25 @@ --- title: MaxWidth second_title: GroupDocs.Viewer for .NET API Reference -description: Max width of an output image in pixels. +description: Sets the maximum width of an output image in pixels. type: docs weight: 50 url: /net/groupdocs.viewer.options/pngviewoptions/maxwidth/ --- ## PngViewOptions.MaxWidth property -Max width of an output image in pixels. +Sets the maximum width of an output image (in pixels). ```csharp public int MaxWidth { get; set; } ``` +### Remarks + +Use this property to set the maximum output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/). + +If you set the [`Width`](../width) property, this property is ignored. + ### See Also * class [PngViewOptions](../../pngviewoptions) diff --git a/english/net/groupdocs.viewer.options/pngviewoptions/pngviewoptions/_index.md b/english/net/groupdocs.viewer.options/pngviewoptions/pngviewoptions/_index.md index e21243289..235addbb1 100644 --- a/english/net/groupdocs.viewer.options/pngviewoptions/pngviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/pngviewoptions/pngviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: PngViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of PngViewOptionsgroupdocs.viewer.options/pngviewoptions class. +description: Initializes an instance of the PngViewOptionsgroupdocs.viewer.options/pngviewoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/pngviewoptions/pngviewoptions/ --- ## PngViewOptions(CreatePageStream) {#constructor_1} -Initializes new instance of [`PngViewOptions`](../../pngviewoptions) class. +Initializes an instance of the [`PngViewOptions`](../../pngviewoptions) class. ```csharp public PngViewOptions(CreatePageStream createPageStream) @@ -16,7 +16,7 @@ public PngViewOptions(CreatePageStream createPageStream) | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. | +| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. | ### Exceptions @@ -24,6 +24,10 @@ public PngViewOptions(CreatePageStream createPageStream) | --- | --- | | ArgumentNullException | Thrown when *createPageStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -35,7 +39,7 @@ public PngViewOptions(CreatePageStream createPageStream) ## PngViewOptions(CreatePageStream, ReleasePageStream) {#constructor_2} -Initializes new instance of [`PngViewOptions`](../../pngviewoptions) class. +Initializes an instance of the [`PngViewOptions`](../../pngviewoptions) class. ```csharp public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) @@ -43,8 +47,8 @@ public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream relea | Parameter | Type | Description | | --- | --- | --- | -| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. | -| releasePageStream | ReleasePageStream | The method that releases stream created by method assigned to delegate that passed to *createPageStream* parameter. | +| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. | +| releasePageStream | ReleasePageStream | The method that releases a stream created by method assigned to delegate that passed to *createPageStream* parameter. | ### Exceptions @@ -53,6 +57,10 @@ public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream relea | ArgumentNullException | Thrown when *createPageStream* is null. | | ArgumentNullException | Thrown when *releasePageStream* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png). + ### See Also * delegate [CreatePageStream](../../../groupdocs.viewer.interfaces/createpagestream) @@ -65,7 +73,7 @@ public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream relea ## PngViewOptions(IPageStreamFactory) {#constructor_3} -Initializes new instance of [`PngViewOptions`](../../pngviewoptions) class. +Initializes an instance of the [`PngViewOptions`](../../pngviewoptions) class. ```csharp public PngViewOptions(IPageStreamFactory pageStreamFactory) @@ -81,6 +89,10 @@ public PngViewOptions(IPageStreamFactory pageStreamFactory) | --- | --- | | ArgumentNullException | Thrown when *pageStreamFactory* is null. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png). + ### See Also * interface [IPageStreamFactory](../../../groupdocs.viewer.interfaces/ipagestreamfactory) @@ -92,7 +104,7 @@ public PngViewOptions(IPageStreamFactory pageStreamFactory) ## PngViewOptions() {#constructor} -Initializes new instance of [`PngViewOptions`](../../pngviewoptions) class. +Initializes an instance of the [`PngViewOptions`](../../pngviewoptions) class. ```csharp public PngViewOptions() @@ -100,7 +112,9 @@ public PngViewOptions() ### Remarks -This constructor initializes new instance of [`PngViewOptions`](../../pngviewoptions) with "p_{0}.png" as file path format for the output files. The output files will be placed into current working directory of the application. +This constructor initializes an instance of the [`PngViewOptions`](../../pngviewoptions) with "p_{0}.png" as file path format for the output files. The output files are placed into current working directory of the application. + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png). ### See Also @@ -112,7 +126,7 @@ This constructor initializes new instance of [`PngViewOptions`](../../pngviewopt ## PngViewOptions(string) {#constructor_4} -Initializes new instance of [`PngViewOptions`](../../pngviewoptions) class. +Initializes an instance of the [`PngViewOptions`](../../pngviewoptions) class. ```csharp public PngViewOptions(string filePathFormat) @@ -128,6 +142,10 @@ public PngViewOptions(string filePathFormat) | --- | --- | | ArgumentException | Thrown when *filePathFormat* is null or empty. | +### Remarks + +For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png). + ### See Also * class [PngViewOptions](../../pngviewoptions) diff --git a/english/net/groupdocs.viewer.options/pngviewoptions/width/_index.md b/english/net/groupdocs.viewer.options/pngviewoptions/width/_index.md index fcd1ac7f5..bc89cdda4 100644 --- a/english/net/groupdocs.viewer.options/pngviewoptions/width/_index.md +++ b/english/net/groupdocs.viewer.options/pngviewoptions/width/_index.md @@ -8,12 +8,18 @@ url: /net/groupdocs.viewer.options/pngviewoptions/width/ --- ## PngViewOptions.Width property -The width of the output image in pixels. +The width of the output image (in pixels). ```csharp public int Width { get; set; } ``` +### Remarks + +Use this property to set the output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/). + +If you set this property, the [`MaxWidth`](../maxwidth) property is ignored. + ### See Also * class [PngViewOptions](../../pngviewoptions) diff --git a/english/net/groupdocs.viewer.options/position/_index.md b/english/net/groupdocs.viewer.options/position/_index.md index 63f2f972c..a7801f477 100644 --- a/english/net/groupdocs.viewer.options/position/_index.md +++ b/english/net/groupdocs.viewer.options/position/_index.md @@ -1,14 +1,14 @@ --- title: Position second_title: GroupDocs.Viewer for .NET API Reference -description: Defines watermark position. +description: Defines the watermark position. type: docs weight: 430 url: /net/groupdocs.viewer.options/position/ --- ## Position enumeration -Defines watermark position. +Defines the watermark position. ```csharp public enum Position diff --git a/english/net/groupdocs.viewer.options/presentationoptions/_index.md b/english/net/groupdocs.viewer.options/presentationoptions/_index.md index a451b9233..589f0e015 100644 --- a/english/net/groupdocs.viewer.options/presentationoptions/_index.md +++ b/english/net/groupdocs.viewer.options/presentationoptions/_index.md @@ -1,14 +1,14 @@ --- title: PresentationOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering presentations options. +description: Contains options for rendering presentations. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderpresentations/. type: docs weight: 440 url: /net/groupdocs.viewer.options/presentationoptions/ --- ## PresentationOptions class -Provides options for rendering presentations options. +Contains options for rendering presentations. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/). ```csharp public class PresentationOptions @@ -24,7 +24,7 @@ public class PresentationOptions | Name | Description | | --- | --- | -| [Resolution](../../groupdocs.viewer.options/presentationoptions/resolution) { get; set; } | Resolution for images inside presentation (for to HTML/PDF rendering only). | +| [Resolution](../../groupdocs.viewer.options/presentationoptions/resolution) { get; set; } | Resolution of the presentation images (for rendering to HTML/PDF only). | ### See Also diff --git a/english/net/groupdocs.viewer.options/presentationoptions/resolution/_index.md b/english/net/groupdocs.viewer.options/presentationoptions/resolution/_index.md index f79880977..2d4b5351c 100644 --- a/english/net/groupdocs.viewer.options/presentationoptions/resolution/_index.md +++ b/english/net/groupdocs.viewer.options/presentationoptions/resolution/_index.md @@ -1,19 +1,23 @@ --- title: Resolution second_title: GroupDocs.Viewer for .NET API Reference -description: Resolution for images inside presentation for to HTML/PDF rendering only. +description: Resolution of the presentation images for rendering to HTML/PDF only. type: docs weight: 20 url: /net/groupdocs.viewer.options/presentationoptions/resolution/ --- ## PresentationOptions.Resolution property -Resolution for images inside presentation (for to HTML/PDF rendering only). +Resolution of the presentation images (for rendering to HTML/PDF only). ```csharp public Resolution Resolution { get; set; } ``` +### Remarks + +For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/#specify-image-resolution). + ### See Also * class [Resolution](../../resolution) diff --git a/english/net/groupdocs.viewer.options/projectmanagementoptions/_index.md b/english/net/groupdocs.viewer.options/projectmanagementoptions/_index.md index 6bfae2200..0915e8aa2 100644 --- a/english/net/groupdocs.viewer.options/projectmanagementoptions/_index.md +++ b/english/net/groupdocs.viewer.options/projectmanagementoptions/_index.md @@ -1,14 +1,14 @@ --- title: ProjectManagementOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering project management files. +description: Contains options for rendering project management files. For details see the documentationhttps//docs.groupdocs.com/viewer/net/rendermsprojectfiles/. type: docs weight: 450 url: /net/groupdocs.viewer.options/projectmanagementoptions/ --- ## ProjectManagementOptions class -Provides options for rendering project management files. +Contains options for rendering project management files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/). ```csharp public class ProjectManagementOptions @@ -18,7 +18,7 @@ public class ProjectManagementOptions | Name | Description | | --- | --- | -| [ProjectManagementOptions](projectmanagementoptions)() | Creates new instance of [`ProjectManagementOptions`](../projectmanagementoptions) class. | +| [ProjectManagementOptions](projectmanagementoptions)() | Creates an instance of the [`ProjectManagementOptions`](../projectmanagementoptions) class. | ## Properties diff --git a/english/net/groupdocs.viewer.options/projectmanagementoptions/pagesize/_index.md b/english/net/groupdocs.viewer.options/projectmanagementoptions/pagesize/_index.md index abbe96c08..3ffb000eb 100644 --- a/english/net/groupdocs.viewer.options/projectmanagementoptions/pagesize/_index.md +++ b/english/net/groupdocs.viewer.options/projectmanagementoptions/pagesize/_index.md @@ -14,6 +14,10 @@ The output page size. public PageSize PageSize { get; set; } ``` +### Remarks + +For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/#specify-the-output-page-size). + ### See Also * enum [PageSize](../../pagesize) diff --git a/english/net/groupdocs.viewer.options/projectmanagementoptions/projectmanagementoptions/_index.md b/english/net/groupdocs.viewer.options/projectmanagementoptions/projectmanagementoptions/_index.md index 0a0c60119..555cee07b 100644 --- a/english/net/groupdocs.viewer.options/projectmanagementoptions/projectmanagementoptions/_index.md +++ b/english/net/groupdocs.viewer.options/projectmanagementoptions/projectmanagementoptions/_index.md @@ -1,14 +1,14 @@ --- title: ProjectManagementOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Creates new instance of ProjectManagementOptionsgroupdocs.viewer.options/projectmanagementoptions class. +description: Creates an instance of the ProjectManagementOptionsgroupdocs.viewer.options/projectmanagementoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/projectmanagementoptions/projectmanagementoptions/ --- ## ProjectManagementOptions constructor -Creates new instance of [`ProjectManagementOptions`](../../projectmanagementoptions) class. +Creates an instance of the [`ProjectManagementOptions`](../../projectmanagementoptions) class. ```csharp public ProjectManagementOptions() diff --git a/english/net/groupdocs.viewer.options/projectmanagementoptions/timeunit/_index.md b/english/net/groupdocs.viewer.options/projectmanagementoptions/timeunit/_index.md index c6b70b50f..3807dd206 100644 --- a/english/net/groupdocs.viewer.options/projectmanagementoptions/timeunit/_index.md +++ b/english/net/groupdocs.viewer.options/projectmanagementoptions/timeunit/_index.md @@ -14,6 +14,10 @@ The time unit. public TimeUnit TimeUnit { get; set; } ``` +### Remarks + +For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/#adjust-the-time-unit). + ### See Also * enum [TimeUnit](../../timeunit) diff --git a/english/net/groupdocs.viewer.options/resolution/_index.md b/english/net/groupdocs.viewer.options/resolution/_index.md index 0532a8503..430378664 100644 --- a/english/net/groupdocs.viewer.options/resolution/_index.md +++ b/english/net/groupdocs.viewer.options/resolution/_index.md @@ -1,14 +1,14 @@ --- title: Resolution second_title: GroupDocs.Viewer for .NET API Reference -description: Provides option to set resolution for images in output document. +description: Contains option to set resolution for images in output document. type: docs weight: 460 url: /net/groupdocs.viewer.options/resolution/ --- ## Resolution class -Provides option to set resolution for images in output document. +Contains option to set resolution for images in output document. ```csharp public class Resolution @@ -18,7 +18,7 @@ public class Resolution | Name | Description | | --- | --- | -| [Resolution](resolution)(int) | Create resolution in DPI. | +| [Resolution](resolution)(int) | Sets resolution in DPI. | ## Properties diff --git a/english/net/groupdocs.viewer.options/resolution/resolution/_index.md b/english/net/groupdocs.viewer.options/resolution/resolution/_index.md index e06e89fd3..a5db2988c 100644 --- a/english/net/groupdocs.viewer.options/resolution/resolution/_index.md +++ b/english/net/groupdocs.viewer.options/resolution/resolution/_index.md @@ -1,14 +1,14 @@ --- title: Resolution second_title: GroupDocs.Viewer for .NET API Reference -description: Create resolution in DPI. +description: Sets resolution in DPI. type: docs weight: 10 url: /net/groupdocs.viewer.options/resolution/resolution/ --- ## Resolution constructor -Create resolution in DPI. +Sets resolution in DPI. ```csharp public Resolution(int value) diff --git a/english/net/groupdocs.viewer.options/rotation/_index.md b/english/net/groupdocs.viewer.options/rotation/_index.md index 38697fc38..692710370 100644 --- a/english/net/groupdocs.viewer.options/rotation/_index.md +++ b/english/net/groupdocs.viewer.options/rotation/_index.md @@ -1,14 +1,14 @@ --- title: Rotation second_title: GroupDocs.Viewer for .NET API Reference -description: Defines page rotation in degrees. +description: Contains page rotation in degrees clockwise. type: docs weight: 470 url: /net/groupdocs.viewer.options/rotation/ --- ## Rotation enumeration -Defines page rotation in degrees. +Contains page rotation in degrees (clockwise). ```csharp public enum Rotation diff --git a/english/net/groupdocs.viewer.options/security/_index.md b/english/net/groupdocs.viewer.options/security/_index.md index a637e3df6..44e358961 100644 --- a/english/net/groupdocs.viewer.options/security/_index.md +++ b/english/net/groupdocs.viewer.options/security/_index.md @@ -1,14 +1,14 @@ --- title: Security second_title: GroupDocs.Viewer for .NET API Reference -description: Provides PDF document security options. +description: Contains the PDF document security options. For details see the documentationhttps//docs.groupdocs.com/viewer/net/protectpdfdocuments/. type: docs weight: 480 url: /net/groupdocs.viewer.options/security/ --- ## Security class -Provides PDF document security options. +Contains the PDF document security options. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/). ```csharp public class Security @@ -18,7 +18,7 @@ public class Security | Name | Description | | --- | --- | -| [Security](security)() | Initializes new instance of [`Security`](../security) class. | +| [Security](security)() | Initializes an instance of the [`Security`](../security) class. | ## Properties @@ -26,7 +26,7 @@ public class Security | --- | --- | | [DocumentOpenPassword](../../groupdocs.viewer.options/security/documentopenpassword) { get; set; } | The password required to open the PDF document. | | [Permissions](../../groupdocs.viewer.options/security/permissions) { get; set; } | The PDF document permissions such as printing, modification and data extraction. | -| [PermissionsPassword](../../groupdocs.viewer.options/security/permissionspassword) { get; set; } | The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction. | +| [PermissionsPassword](../../groupdocs.viewer.options/security/permissionspassword) { get; set; } | The password required to change permission settings. Using a permissions password you can restrict printing, modification and data extraction. | ### See Also diff --git a/english/net/groupdocs.viewer.options/security/documentopenpassword/_index.md b/english/net/groupdocs.viewer.options/security/documentopenpassword/_index.md index 717c033a0..b4a17eade 100644 --- a/english/net/groupdocs.viewer.options/security/documentopenpassword/_index.md +++ b/english/net/groupdocs.viewer.options/security/documentopenpassword/_index.md @@ -14,6 +14,10 @@ The password required to open the PDF document. public string DocumentOpenPassword { get; set; } ``` +### Remarks + +For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/). + ### See Also * class [Security](../../security) diff --git a/english/net/groupdocs.viewer.options/security/permissions/_index.md b/english/net/groupdocs.viewer.options/security/permissions/_index.md index 17ceb66c9..c26863ed9 100644 --- a/english/net/groupdocs.viewer.options/security/permissions/_index.md +++ b/english/net/groupdocs.viewer.options/security/permissions/_index.md @@ -14,6 +14,10 @@ The PDF document permissions such as printing, modification and data extraction. public Permissions Permissions { get; set; } ``` +### Remarks + +For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/). + ### See Also * enum [Permissions](../../permissions) diff --git a/english/net/groupdocs.viewer.options/security/permissionspassword/_index.md b/english/net/groupdocs.viewer.options/security/permissionspassword/_index.md index f88aae1c4..8058a12af 100644 --- a/english/net/groupdocs.viewer.options/security/permissionspassword/_index.md +++ b/english/net/groupdocs.viewer.options/security/permissionspassword/_index.md @@ -1,19 +1,23 @@ --- title: PermissionsPassword second_title: GroupDocs.Viewer for .NET API Reference -description: The password required to change permission settings Using a permissions password you can restrict printing modification and data extraction. +description: The password required to change permission settings. Using a permissions password you can restrict printing modification and data extraction. type: docs weight: 40 url: /net/groupdocs.viewer.options/security/permissionspassword/ --- ## Security.PermissionsPassword property -The password required to change permission settings; Using a permissions password you can restrict printing, modification and data extraction. +The password required to change permission settings. Using a permissions password you can restrict printing, modification and data extraction. ```csharp public string PermissionsPassword { get; set; } ``` +### Remarks + +Use a permissions password to restrict printing, modification and data extraction. For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/). + ### See Also * class [Security](../../security) diff --git a/english/net/groupdocs.viewer.options/security/security/_index.md b/english/net/groupdocs.viewer.options/security/security/_index.md index 5940be1ea..db8fd75f7 100644 --- a/english/net/groupdocs.viewer.options/security/security/_index.md +++ b/english/net/groupdocs.viewer.options/security/security/_index.md @@ -1,14 +1,14 @@ --- title: Security second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of Securitygroupdocs.viewer.options/security class. +description: Initializes an instance of the Securitygroupdocs.viewer.options/security class. type: docs weight: 10 url: /net/groupdocs.viewer.options/security/security/ --- ## Security constructor -Initializes new instance of [`Security`](../../security) class. +Initializes an instance of the [`Security`](../../security) class. ```csharp public Security() diff --git a/english/net/groupdocs.viewer.options/size/_index.md b/english/net/groupdocs.viewer.options/size/_index.md index 0d0e242fb..a2534756f 100644 --- a/english/net/groupdocs.viewer.options/size/_index.md +++ b/english/net/groupdocs.viewer.options/size/_index.md @@ -1,14 +1,14 @@ --- title: Size second_title: GroupDocs.Viewer for .NET API Reference -description: Watermark size. +description: Contains the watermark size. type: docs weight: 490 url: /net/groupdocs.viewer.options/size/ --- ## Size class -Watermark size. +Contains the watermark size. ```csharp public class Size @@ -18,7 +18,7 @@ public class Size | Name | Description | | --- | --- | -| [Size](size)(byte) | Initializes new instance of [`Size`](../size) class. | +| [Size](size)(byte) | Initializes an instance of the [`Size`](../size) class. | ## Properties diff --git a/english/net/groupdocs.viewer.options/size/size/_index.md b/english/net/groupdocs.viewer.options/size/size/_index.md index d0289a033..c9a81170e 100644 --- a/english/net/groupdocs.viewer.options/size/size/_index.md +++ b/english/net/groupdocs.viewer.options/size/size/_index.md @@ -1,14 +1,14 @@ --- title: Size second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of Sizegroupdocs.viewer.options/size class. +description: Initializes an instance of the Sizegroupdocs.viewer.options/size class. type: docs weight: 10 url: /net/groupdocs.viewer.options/size/size/ --- ## Size constructor -Initializes new instance of [`Size`](../../size) class. +Initializes an instance of the [`Size`](../../size) class. ```csharp public Size(byte relativeSize) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/_index.md index 34903f011..65594afc6 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/_index.md @@ -1,14 +1,14 @@ --- title: SpreadsheetOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering spreadsheets. +description: Contains options for rendering spreadsheets. For details see children of the Render spreadsheet fileshttps//docs.groupdocs.com/viewer/net/renderspreadsheets/ topic. type: docs weight: 500 url: /net/groupdocs.viewer.options/spreadsheetoptions/ --- ## SpreadsheetOptions class -Provides options for rendering spreadsheets. +Contains options for rendering spreadsheets. For details, see children of the [Render spreadsheet files](https://docs.groupdocs.com/viewer/net/render-spreadsheets/) topic. ```csharp public class SpreadsheetOptions @@ -18,31 +18,31 @@ public class SpreadsheetOptions | Name | Description | | --- | --- | -| [BottomMargin](../../groupdocs.viewer.options/spreadsheetoptions/bottommargin) { get; set; } | To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used | -| [CountColumnsPerPage](../../groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage) { get; } | The columns count to include into each page when splitting worksheet into pages. | -| [CountRowsPerPage](../../groupdocs.viewer.options/spreadsheetoptions/countrowsperpage) { get; } | The rows count to include into each page when splitting worksheet into pages. | -| [DetectSeparator](../../groupdocs.viewer.options/spreadsheetoptions/detectseparator) { get; set; } | Detect separator (for CSV/TSV files). | -| [LeftMargin](../../groupdocs.viewer.options/spreadsheetoptions/leftmargin) { get; set; } | To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used | +| [BottomMargin](../../groupdocs.viewer.options/spreadsheetoptions/bottommargin) { get; set; } | Sets the bottom margin of a page when converting to PDF. | +| [CountColumnsPerPage](../../groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage) { get; } | The columns count to include on each page when splitting the worksheet into pages. | +| [CountRowsPerPage](../../groupdocs.viewer.options/spreadsheetoptions/countrowsperpage) { get; } | The rows count to include on each page when splitting the worksheet into pages. | +| [DetectSeparator](../../groupdocs.viewer.options/spreadsheetoptions/detectseparator) { get; set; } | Detect a separator (for CSV/TSV files). | +| [LeftMargin](../../groupdocs.viewer.options/spreadsheetoptions/leftmargin) { get; set; } | Sets the left margin of a page when converting to PDF. | | [RenderGridLines](../../groupdocs.viewer.options/spreadsheetoptions/rendergridlines) { get; set; } | Enables grid lines rendering. | | [RenderHeadings](../../groupdocs.viewer.options/spreadsheetoptions/renderheadings) { get; set; } | Enables headings rendering. | | [RenderHiddenColumns](../../groupdocs.viewer.options/spreadsheetoptions/renderhiddencolumns) { get; set; } | Enables hidden columns rendering. | | [RenderHiddenRows](../../groupdocs.viewer.options/spreadsheetoptions/renderhiddenrows) { get; set; } | Enables hidden rows rendering. | -| [RightMargin](../../groupdocs.viewer.options/spreadsheetoptions/rightmargin) { get; set; } | To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used | +| [RightMargin](../../groupdocs.viewer.options/spreadsheetoptions/rightmargin) { get; set; } | Sets the right margin of a page when converting to PDF. | | [SkipEmptyColumns](../../groupdocs.viewer.options/spreadsheetoptions/skipemptycolumns) { get; set; } | Disables empty columns rendering. | | [SkipEmptyRows](../../groupdocs.viewer.options/spreadsheetoptions/skipemptyrows) { get; set; } | Disables empty rows rendering. | -| [TextOverflowMode](../../groupdocs.viewer.options/spreadsheetoptions/textoverflowmode) { get; set; } | The text overflow mode for rendering spreadsheet documents into HTML. | -| [TopMargin](../../groupdocs.viewer.options/spreadsheetoptions/topmargin) { get; set; } | To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used | +| [TextOverflowMode](../../groupdocs.viewer.options/spreadsheetoptions/textoverflowmode) { get; set; } | Sets the text overflow mode for rendering spreadsheet documents into HTML. | +| [TopMargin](../../groupdocs.viewer.options/spreadsheetoptions/topmargin) { get; set; } | Sets the top margin of a page when converting to PDF. | ## Methods | Name | Description | | --- | --- | -| static [ForOnePagePerSheet](../../groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet)() | Initializes new instance of [`SpreadsheetOptions`](../spreadsheetoptions) class for rendering whole sheet into page. | -| static [ForRenderingByPageBreaks](../../groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks)() | Initializes new instance of [`SpreadsheetOptions`](../spreadsheetoptions) for rendering print areas only. | -| static [ForRenderingPrintArea](../../groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea)() | Initializes new instance of [`SpreadsheetOptions`](../spreadsheetoptions) for rendering print areas only. | -| static [ForRenderingPrintAreaAndPageBreaks](../../groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks)() | Initializes new instance of [`SpreadsheetOptions`](../spreadsheetoptions) for rendering print areas and page breaks. | -| static [ForSplitSheetIntoPages](../../groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages#forsplitsheetintopages)(int) | Initializes new instance of [`SpreadsheetOptions`](../spreadsheetoptions) for rendering sheet into pages. | -| static [ForSplitSheetIntoPages](../../groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages#forsplitsheetintopages_1)(int, int) | Initializes new instance of [`SpreadsheetOptions`](../spreadsheetoptions) for rendering sheet into pages. | +| static [ForOnePagePerSheet](../../groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet)() | Initializes an instance of the [`SpreadsheetOptions`](../spreadsheetoptions) class for rendering the whole sheet into one page. | +| static [ForRenderingByPageBreaks](../../groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks)() | Initializes an instance of the [`SpreadsheetOptions`](../spreadsheetoptions) class for splitting to pages by page breaks. | +| static [ForRenderingPrintArea](../../groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea)() | Initializes an instance of the [`SpreadsheetOptions`](../spreadsheetoptions) class for rendering the print areas only. | +| static [ForRenderingPrintAreaAndPageBreaks](../../groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks)() | Initializes an instance of the [`SpreadsheetOptions`](../spreadsheetoptions) class for rendering print areas and page breaks. | +| static [ForSplitSheetIntoPages](../../groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages#forsplitsheetintopages)(int) | Initializes an instance of the [`SpreadsheetOptions`](../spreadsheetoptions) class for rendering sheet into pages. | +| static [ForSplitSheetIntoPages](../../groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages#forsplitsheetintopages_1)(int, int) | Initializes an instance of the [`SpreadsheetOptions`](../spreadsheetoptions) class for rendering sheet into pages. | ### See Also diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/bottommargin/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/bottommargin/_index.md index 3933fe966..280e4f31c 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/bottommargin/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/bottommargin/_index.md @@ -1,19 +1,23 @@ --- title: BottomMargin second_title: GroupDocs.Viewer for .NET API Reference -description: To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used +description: Sets the bottom margin of a page when converting to PDF. type: docs weight: 60 url: /net/groupdocs.viewer.options/spreadsheetoptions/bottommargin/ --- ## SpreadsheetOptions.BottomMargin property -To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used +Sets the bottom margin of a page when converting to PDF. ```csharp public double BottomMargin { get; set; } ``` +### Remarks + +If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage/_index.md index d33148edd..50e3d96a8 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage/_index.md @@ -1,19 +1,23 @@ --- title: CountColumnsPerPage second_title: GroupDocs.Viewer for .NET API Reference -description: The columns count to include into each page when splitting worksheet into pages. +description: The columns count to include on each page when splitting the worksheet into pages. type: docs weight: 70 url: /net/groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage/ --- ## SpreadsheetOptions.CountColumnsPerPage property -The columns count to include into each page when splitting worksheet into pages. +The columns count to include on each page when splitting the worksheet into pages. ```csharp public int CountColumnsPerPage { get; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/countrowsperpage/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/countrowsperpage/_index.md index b9fa1a512..79fca200b 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/countrowsperpage/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/countrowsperpage/_index.md @@ -1,19 +1,23 @@ --- title: CountRowsPerPage second_title: GroupDocs.Viewer for .NET API Reference -description: The rows count to include into each page when splitting worksheet into pages. +description: The rows count to include on each page when splitting the worksheet into pages. type: docs weight: 80 url: /net/groupdocs.viewer.options/spreadsheetoptions/countrowsperpage/ --- ## SpreadsheetOptions.CountRowsPerPage property -The rows count to include into each page when splitting worksheet into pages. +The rows count to include on each page when splitting the worksheet into pages. ```csharp public int CountRowsPerPage { get; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/detectseparator/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/detectseparator/_index.md index 0b492146c..633525bd2 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/detectseparator/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/detectseparator/_index.md @@ -1,19 +1,23 @@ --- title: DetectSeparator second_title: GroupDocs.Viewer for .NET API Reference -description: Detect separator for CSV/TSV files. +description: Detect a separator for CSV/TSV files. type: docs weight: 90 url: /net/groupdocs.viewer.options/spreadsheetoptions/detectseparator/ --- ## SpreadsheetOptions.DetectSeparator property -Detect separator (for CSV/TSV files). +Detect a separator (for CSV/TSV files). ```csharp public bool DetectSeparator { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/#detect-a-csvtsv-separator). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet/_index.md index 0c9298f0a..ed38859c1 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet/_index.md @@ -1,14 +1,14 @@ --- title: ForOnePagePerSheet second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions class for rendering whole sheet into page. +description: Initializes an instance of the SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions class for rendering the whole sheet into one page. type: docs weight: 10 url: /net/groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet/ --- ## SpreadsheetOptions.ForOnePagePerSheet method -Initializes new instance of [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering whole sheet into page. +Initializes an instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering the whole sheet into one page. ```csharp public static SpreadsheetOptions ForOnePagePerSheet() @@ -16,7 +16,11 @@ public static SpreadsheetOptions ForOnePagePerSheet() ### Return Value -New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering one sheet into one page. +New instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering the whole sheet into one page. + +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#render-a-worksheet-on-one-page). ### See Also diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks/_index.md index b71f68127..2b788ce5f 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks/_index.md @@ -1,14 +1,14 @@ --- title: ForRenderingByPageBreaks second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions for rendering print areas only. +description: Initializes an instance of the SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions class for splitting to pages by page breaks. type: docs weight: 20 url: /net/groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks/ --- ## SpreadsheetOptions.ForRenderingByPageBreaks method -Initializes new instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering print areas only. +Initializes an instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for splitting to pages by page breaks. ```csharp public static SpreadsheetOptions ForRenderingByPageBreaks() @@ -16,7 +16,11 @@ public static SpreadsheetOptions ForRenderingByPageBreaks() ### Return Value -New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering by page breaks. The behaviour similar to printing in Excel. +New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for splitting to pages by page breaks. The behavior is similar to printing in Excel. + +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/). ### See Also diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea/_index.md index 5dd9d3770..403d62c03 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea/_index.md @@ -1,14 +1,14 @@ --- title: ForRenderingPrintArea second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions for rendering print areas only. +description: Initializes an instance of the SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions class for rendering the print areas only. type: docs weight: 30 url: /net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea/ --- ## SpreadsheetOptions.ForRenderingPrintArea method -Initializes new instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering print areas only. +Initializes an instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering the print areas only. ```csharp public static SpreadsheetOptions ForRenderingPrintArea() @@ -16,7 +16,11 @@ public static SpreadsheetOptions ForRenderingPrintArea() ### Return Value -New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering print areas only. +New instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering print areas only. + +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#render-a-print-area). ### See Also diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks/_index.md index 2cba264ad..33be39619 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks/_index.md @@ -1,14 +1,14 @@ --- title: ForRenderingPrintAreaAndPageBreaks second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions for rendering print areas and page breaks. +description: Initializes an instance of the SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions class for rendering print areas and page breaks. type: docs weight: 40 url: /net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks/ --- ## SpreadsheetOptions.ForRenderingPrintAreaAndPageBreaks method -Initializes new instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering print areas and page breaks. +Initializes an instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering print areas and page breaks. ```csharp public static SpreadsheetOptions ForRenderingPrintAreaAndPageBreaks() @@ -16,13 +16,11 @@ public static SpreadsheetOptions ForRenderingPrintAreaAndPageBreaks() ### Return Value -New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering pages basing on page brakes that are included into print area. The behaviour similar to printing in Excel. +New instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering pages basing on page brakes that are included into print area. The behavior is similar to printing in Excel. ### Remarks -**Learn more** - -* Learn more about spliting a worksheet into pages in C#: [How to split pages basing on page brakes that are included into print area using GroupDocs.Viewer](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/) +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#render-worksheet-by-page-breaks-and-print-area). ### See Also diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages/_index.md index 489ab065f..1c982cadd 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages/_index.md @@ -1,14 +1,14 @@ --- title: ForSplitSheetIntoPages second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions for rendering sheet into pages. +description: Initializes an instance of the SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions class for rendering sheet into pages. type: docs weight: 50 url: /net/groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages/ --- ## ForSplitSheetIntoPages(int) {#forsplitsheetintopages} -Initializes new instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering sheet into pages. +Initializes an instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering sheet into pages. ```csharp public static SpreadsheetOptions ForSplitSheetIntoPages(int countRowsPerPage) @@ -16,11 +16,11 @@ public static SpreadsheetOptions ForSplitSheetIntoPages(int countRowsPerPage) | Parameter | Type | Description | | --- | --- | --- | -| countRowsPerPage | Int32 | Rows count to include into each page. | +| countRowsPerPage | Int32 | Count of rows to include into each page. | ### Return Value -New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering sheet into pages. +New instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering sheet into pages. ### Exceptions @@ -28,6 +28,10 @@ New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering s | --- | --- | | ArgumentException | Thrown when *countRowsPerPage* is equals or less than zero. | +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) @@ -38,7 +42,7 @@ New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering s ## ForSplitSheetIntoPages(int, int) {#forsplitsheetintopages_1} -Initializes new instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering sheet into pages. +Initializes an instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering sheet into pages. ```csharp public static SpreadsheetOptions ForSplitSheetIntoPages(int countRowsPerPage, @@ -47,12 +51,12 @@ public static SpreadsheetOptions ForSplitSheetIntoPages(int countRowsPerPage, | Parameter | Type | Description | | --- | --- | --- | -| countRowsPerPage | Int32 | Rows count to include into each page. | -| countColumnsPerPage | Int32 | Columns count to include into each page. | +| countRowsPerPage | Int32 | Count of rows to include into each page. | +| countColumnsPerPage | Int32 | Count of columns to include into each page. | ### Return Value -New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering sheet into pages. +New instance of the [`SpreadsheetOptions`](../../spreadsheetoptions) class for rendering sheet into pages. ### Exceptions @@ -61,6 +65,10 @@ New instance of [`SpreadsheetOptions`](../../spreadsheetoptions) for rendering s | ArgumentException | Thrown when *countRowsPerPage* is equals or less than zero. | | ArgumentException | Thrown when *countColumnsPerPage* is equals or less than zero. | +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/leftmargin/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/leftmargin/_index.md index 9adf4f43f..739ed7a51 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/leftmargin/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/leftmargin/_index.md @@ -1,19 +1,23 @@ --- title: LeftMargin second_title: GroupDocs.Viewer for .NET API Reference -description: To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used +description: Sets the left margin of a page when converting to PDF. type: docs weight: 100 url: /net/groupdocs.viewer.options/spreadsheetoptions/leftmargin/ --- ## SpreadsheetOptions.LeftMargin property -To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used +Sets the left margin of a page when converting to PDF. ```csharp public double LeftMargin { get; set; } ``` +### Remarks + +If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/rendergridlines/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/rendergridlines/_index.md index dd2d979c4..8bd627821 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/rendergridlines/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/rendergridlines/_index.md @@ -14,6 +14,10 @@ Enables grid lines rendering. public bool RenderGridLines { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-worksheet-gridlines). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/renderheadings/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/renderheadings/_index.md index 1c59e4306..a2798072c 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/renderheadings/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/renderheadings/_index.md @@ -14,6 +14,10 @@ Enables headings rendering. public bool RenderHeadings { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-row-and-column-headings). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddencolumns/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddencolumns/_index.md index 69ba89336..f7c792998 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddencolumns/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddencolumns/_index.md @@ -14,6 +14,10 @@ Enables hidden columns rendering. public bool RenderHiddenColumns { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-hidden-rows-and-columns). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddenrows/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddenrows/_index.md index 72eb53e2d..71432fb9d 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddenrows/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddenrows/_index.md @@ -14,6 +14,10 @@ Enables hidden rows rendering. public bool RenderHiddenRows { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-hidden-rows-and-columns). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/rightmargin/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/rightmargin/_index.md index b1fb9d06d..d4237353e 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/rightmargin/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/rightmargin/_index.md @@ -1,19 +1,23 @@ --- title: RightMargin second_title: GroupDocs.Viewer for .NET API Reference -description: To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used +description: Sets the right margin of a page when converting to PDF. type: docs weight: 150 url: /net/groupdocs.viewer.options/spreadsheetoptions/rightmargin/ --- ## SpreadsheetOptions.RightMargin property -To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used +Sets the right margin of a page when converting to PDF. ```csharp public double RightMargin { get; set; } ``` +### Remarks + +If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptycolumns/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptycolumns/_index.md index 32ca3ca74..4b21b7f00 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptycolumns/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptycolumns/_index.md @@ -14,6 +14,10 @@ Disables empty columns rendering. public bool SkipEmptyColumns { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#skip-empty-rows-and-columns). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptyrows/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptyrows/_index.md index 605fdb9d1..1712a12b3 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptyrows/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/skipemptyrows/_index.md @@ -14,6 +14,10 @@ Disables empty rows rendering. public bool SkipEmptyRows { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#skip-empty-rows-and-columns). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/textoverflowmode/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/textoverflowmode/_index.md index efcb40578..db9351b01 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/textoverflowmode/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/textoverflowmode/_index.md @@ -1,19 +1,23 @@ --- title: TextOverflowMode second_title: GroupDocs.Viewer for .NET API Reference -description: The text overflow mode for rendering spreadsheet documents into HTML. +description: Sets the text overflow mode for rendering spreadsheet documents into HTML. type: docs weight: 180 url: /net/groupdocs.viewer.options/spreadsheetoptions/textoverflowmode/ --- ## SpreadsheetOptions.TextOverflowMode property -The text overflow mode for rendering spreadsheet documents into HTML. +Sets the text overflow mode for rendering spreadsheet documents into HTML. ```csharp public TextOverflowMode TextOverflowMode { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#control-cell-text-overflow). + ### See Also * enum [TextOverflowMode](../../textoverflowmode) diff --git a/english/net/groupdocs.viewer.options/spreadsheetoptions/topmargin/_index.md b/english/net/groupdocs.viewer.options/spreadsheetoptions/topmargin/_index.md index e87918626..8546db323 100644 --- a/english/net/groupdocs.viewer.options/spreadsheetoptions/topmargin/_index.md +++ b/english/net/groupdocs.viewer.options/spreadsheetoptions/topmargin/_index.md @@ -1,19 +1,23 @@ --- title: TopMargin second_title: GroupDocs.Viewer for .NET API Reference -description: To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used +description: Sets the top margin of a page when converting to PDF. type: docs weight: 190 url: /net/groupdocs.viewer.options/spreadsheetoptions/topmargin/ --- ## SpreadsheetOptions.TopMargin property -To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used +Sets the top margin of a page when converting to PDF. ```csharp public double TopMargin { get; set; } ``` +### Remarks + +If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages). + ### See Also * class [SpreadsheetOptions](../../spreadsheetoptions) diff --git a/english/net/groupdocs.viewer.options/textoptions/_index.md b/english/net/groupdocs.viewer.options/textoptions/_index.md index c2f7960ab..2e0c58e0c 100644 --- a/english/net/groupdocs.viewer.options/textoptions/_index.md +++ b/english/net/groupdocs.viewer.options/textoptions/_index.md @@ -18,14 +18,14 @@ public class TextOptions | Name | Description | | --- | --- | -| [TextOptions](textoptions)() | Initializes new instance of [`TextOptions`](../textoptions) class. | +| [TextOptions](textoptions)() | Initializes an instance of the [`TextOptions`](../textoptions) class. | ## Properties | Name | Description | | --- | --- | -| [MaxCharsPerRow](../../groupdocs.viewer.options/textoptions/maxcharsperrow) { get; set; } | Max chars per row on page. Default value is 85. | -| [MaxRowsPerPage](../../groupdocs.viewer.options/textoptions/maxrowsperpage) { get; set; } | Max rows per page. Default value is 55. | +| [MaxCharsPerRow](../../groupdocs.viewer.options/textoptions/maxcharsperrow) { get; set; } | The maximum number of characters per row on a page. | +| [MaxRowsPerPage](../../groupdocs.viewer.options/textoptions/maxrowsperpage) { get; set; } | The maximum number of rows per page. | ### See Also diff --git a/english/net/groupdocs.viewer.options/textoptions/maxcharsperrow/_index.md b/english/net/groupdocs.viewer.options/textoptions/maxcharsperrow/_index.md index 4abbb3c91..f54b8bbc5 100644 --- a/english/net/groupdocs.viewer.options/textoptions/maxcharsperrow/_index.md +++ b/english/net/groupdocs.viewer.options/textoptions/maxcharsperrow/_index.md @@ -1,19 +1,23 @@ --- title: MaxCharsPerRow second_title: GroupDocs.Viewer for .NET API Reference -description: Max chars per row on page. Default value is 85. +description: The maximum number of characters per row on a page. type: docs weight: 20 url: /net/groupdocs.viewer.options/textoptions/maxcharsperrow/ --- ## TextOptions.MaxCharsPerRow property -Max chars per row on page. Default value is 85. +The maximum number of characters per row on a page. ```csharp public int MaxCharsPerRow { get; set; } ``` +### Remarks + +The default value is 85. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/#specify-rendering-options). + ### See Also * class [TextOptions](../../textoptions) diff --git a/english/net/groupdocs.viewer.options/textoptions/maxrowsperpage/_index.md b/english/net/groupdocs.viewer.options/textoptions/maxrowsperpage/_index.md index 423d7621e..b23466512 100644 --- a/english/net/groupdocs.viewer.options/textoptions/maxrowsperpage/_index.md +++ b/english/net/groupdocs.viewer.options/textoptions/maxrowsperpage/_index.md @@ -1,19 +1,23 @@ --- title: MaxRowsPerPage second_title: GroupDocs.Viewer for .NET API Reference -description: Max rows per page. Default value is 55. +description: The maximum number of rows per page. type: docs weight: 30 url: /net/groupdocs.viewer.options/textoptions/maxrowsperpage/ --- ## TextOptions.MaxRowsPerPage property -Max rows per page. Default value is 55. +The maximum number of rows per page. ```csharp public int MaxRowsPerPage { get; set; } ``` +### Remarks + +The default value is 55. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/#specify-rendering-options). + ### See Also * class [TextOptions](../../textoptions) diff --git a/english/net/groupdocs.viewer.options/textoptions/textoptions/_index.md b/english/net/groupdocs.viewer.options/textoptions/textoptions/_index.md index f657d6bbb..148a6cc3b 100644 --- a/english/net/groupdocs.viewer.options/textoptions/textoptions/_index.md +++ b/english/net/groupdocs.viewer.options/textoptions/textoptions/_index.md @@ -1,19 +1,23 @@ --- title: TextOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of TextOptionsgroupdocs.viewer.options/textoptions class. +description: Initializes an instance of the TextOptionsgroupdocs.viewer.options/textoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/textoptions/textoptions/ --- ## TextOptions constructor -Initializes new instance of [`TextOptions`](../../textoptions) class. +Initializes an instance of the [`TextOptions`](../../textoptions) class. ```csharp public TextOptions() ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/#specify-rendering-options). + ### See Also * class [TextOptions](../../textoptions) diff --git a/english/net/groupdocs.viewer.options/textoverflowmode/_index.md b/english/net/groupdocs.viewer.options/textoverflowmode/_index.md index 0da7b4a77..dafe63f33 100644 --- a/english/net/groupdocs.viewer.options/textoverflowmode/_index.md +++ b/english/net/groupdocs.viewer.options/textoverflowmode/_index.md @@ -1,14 +1,14 @@ --- title: TextOverflowMode second_title: GroupDocs.Viewer for .NET API Reference -description: Defines text overflow mode for rendering spreadsheet documents into HTML. +description: Sets the text overflow mode for rendering spreadsheet documents into HTML. type: docs weight: 520 url: /net/groupdocs.viewer.options/textoverflowmode/ --- ## TextOverflowMode enumeration -Defines text overflow mode for rendering spreadsheet documents into HTML. +Sets the text overflow mode for rendering spreadsheet documents into HTML. ```csharp public enum TextOverflowMode @@ -23,6 +23,10 @@ public enum TextOverflowMode | AutoFitColumn | `2` | Expand columns to fit the text. | | HideText | `3` | Hide overflow text. | +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#control-cell-text-overflow). + ### See Also * namespace [GroupDocs.Viewer.Options](../../groupdocs.viewer.options) diff --git a/english/net/groupdocs.viewer.options/tile/_index.md b/english/net/groupdocs.viewer.options/tile/_index.md index d16528557..5a69c0c2c 100644 --- a/english/net/groupdocs.viewer.options/tile/_index.md +++ b/english/net/groupdocs.viewer.options/tile/_index.md @@ -1,14 +1,14 @@ --- title: Tile second_title: GroupDocs.Viewer for .NET API Reference -description: Represents drawing region. +description: Represents the drawing region. type: docs weight: 530 url: /net/groupdocs.viewer.options/tile/ --- ## Tile class -Represents drawing region. +Represents the drawing region. ```csharp public class Tile @@ -18,7 +18,7 @@ public class Tile | Name | Description | | --- | --- | -| [Tile](tile)(int, int, int, int) | Initializes a new instance of the [`Tile`](../tile) class. | +| [Tile](tile)(int, int, int, int) | Initializes an instance of the [`Tile`](../tile) class. | ## Properties @@ -36,6 +36,10 @@ public class Tile | [GetEndPointX](../../groupdocs.viewer.options/tile/getendpointx)() | Returns the X coordinate of the highest right point on the drawing where the tile ends. | | [GetEndPointY](../../groupdocs.viewer.options/tile/getendpointy)() | Returns the Y coordinate of the highest right point on the drawing where the tile ends. | +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles). + ### See Also * namespace [GroupDocs.Viewer.Options](../../groupdocs.viewer.options) diff --git a/english/net/groupdocs.viewer.options/tile/height/_index.md b/english/net/groupdocs.viewer.options/tile/height/_index.md index b77aa0ef8..962480861 100644 --- a/english/net/groupdocs.viewer.options/tile/height/_index.md +++ b/english/net/groupdocs.viewer.options/tile/height/_index.md @@ -14,6 +14,10 @@ The height of the tile in pixels. public int Height { get; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles). + ### See Also * class [Tile](../../tile) diff --git a/english/net/groupdocs.viewer.options/tile/startpointx/_index.md b/english/net/groupdocs.viewer.options/tile/startpointx/_index.md index 7b88fda85..77c435cb2 100644 --- a/english/net/groupdocs.viewer.options/tile/startpointx/_index.md +++ b/english/net/groupdocs.viewer.options/tile/startpointx/_index.md @@ -14,6 +14,10 @@ The X coordinate of the lowest left point on the drawing where the tile begins. public int StartPointX { get; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles). + ### See Also * class [Tile](../../tile) diff --git a/english/net/groupdocs.viewer.options/tile/startpointy/_index.md b/english/net/groupdocs.viewer.options/tile/startpointy/_index.md index d59b46de9..5a397123c 100644 --- a/english/net/groupdocs.viewer.options/tile/startpointy/_index.md +++ b/english/net/groupdocs.viewer.options/tile/startpointy/_index.md @@ -14,6 +14,10 @@ The Y coordinate of the lowest left point on the drawing where the tile begins. public int StartPointY { get; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles). + ### See Also * class [Tile](../../tile) diff --git a/english/net/groupdocs.viewer.options/tile/tile/_index.md b/english/net/groupdocs.viewer.options/tile/tile/_index.md index fcbb6236b..2822b093c 100644 --- a/english/net/groupdocs.viewer.options/tile/tile/_index.md +++ b/english/net/groupdocs.viewer.options/tile/tile/_index.md @@ -1,14 +1,14 @@ --- title: Tile second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes a new instance of the Tilegroupdocs.viewer.options/tile class. +description: Initializes an instance of the Tilegroupdocs.viewer.options/tile class. type: docs weight: 10 url: /net/groupdocs.viewer.options/tile/tile/ --- ## Tile constructor -Initializes a new instance of the [`Tile`](../../tile) class. +Initializes an instance of the [`Tile`](../../tile) class. ```csharp public Tile(int startPointX, int startPointY, int width, int height) @@ -21,6 +21,10 @@ public Tile(int startPointX, int startPointY, int width, int height) | width | Int32 | The width of the tile in pixels. | | height | Int32 | The height of the tile in pixels. | +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles). + ### See Also * class [Tile](../../tile) diff --git a/english/net/groupdocs.viewer.options/tile/width/_index.md b/english/net/groupdocs.viewer.options/tile/width/_index.md index 86cd01afc..f1a9e73cf 100644 --- a/english/net/groupdocs.viewer.options/tile/width/_index.md +++ b/english/net/groupdocs.viewer.options/tile/width/_index.md @@ -14,6 +14,10 @@ The width of the tile in pixels. public int Width { get; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles). + ### See Also * class [Tile](../../tile) diff --git a/english/net/groupdocs.viewer.options/timeunit/_index.md b/english/net/groupdocs.viewer.options/timeunit/_index.md index 0cd5acc22..ede4e0017 100644 --- a/english/net/groupdocs.viewer.options/timeunit/_index.md +++ b/english/net/groupdocs.viewer.options/timeunit/_index.md @@ -23,6 +23,10 @@ public enum TimeUnit | ThirdsOfMonths | `10` | The one third of the month. | | Months | `30` | The one month interval. | +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/#adjust-the-time-unit). + ### See Also * namespace [GroupDocs.Viewer.Options](../../groupdocs.viewer.options) diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/_index.md index b4312a44b..326a6c9ca 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/_index.md @@ -1,14 +1,14 @@ --- title: ViewInfoOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options used for retrieving information about view. +description: Contains options for retrieving information about view. type: docs weight: 550 url: /net/groupdocs.viewer.options/viewinfooptions/ --- ## ViewInfoOptions class -Provides options used for retrieving information about view. +Contains options for retrieving information about view. ```csharp public class ViewInfoOptions : BaseViewOptions, IMaxSizeOptions @@ -20,42 +20,42 @@ public class ViewInfoOptions : BaseViewOptions, IMaxSizeOptions | --- | --- | | [ArchiveOptions](../../groupdocs.viewer.options/baseviewoptions/archiveoptions) { get; set; } | The archive files view options. | | [CadOptions](../../groupdocs.viewer.options/baseviewoptions/cadoptions) { get; set; } | The CAD drawing view options. | -| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Default font to be used when particular font used in document can't be found. | +| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Sets the default font for a document. | | [EmailOptions](../../groupdocs.viewer.options/baseviewoptions/emailoptions) { get; set; } | The email messages view options. | -| [ExtractText](../../groupdocs.viewer.options/viewinfooptions/extracttext) { get; set; } | Indicates that text extraction is enabled. | -| [Height](../../groupdocs.viewer.options/viewinfooptions/height) { get; set; } | Image height (for rendering to PNG/JPG only) | +| [ExtractText](../../groupdocs.viewer.options/viewinfooptions/extracttext) { get; set; } | Enables text extraction. | +| [Height](../../groupdocs.viewer.options/viewinfooptions/height) { get; set; } | The height of the output image (in pixels, for rendering to PNG/JPG only). | | [MailStorageOptions](../../groupdocs.viewer.options/baseviewoptions/mailstorageoptions) { get; set; } | Mail storage data files view options. | -| [MaxHeight](../../groupdocs.viewer.options/viewinfooptions/maxheight) { get; set; } | Max height of the output image (for rendering to PNG/JPG only) | -| [MaxWidth](../../groupdocs.viewer.options/viewinfooptions/maxwidth) { get; set; } | Max width of the output image (for rendering to PNG/JPG only) | -| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The MS Outlook data files view options. | -| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF documents view options. | -| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation processing documents view options. | +| [MaxHeight](../../groupdocs.viewer.options/viewinfooptions/maxheight) { get; set; } | Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only). | +| [MaxWidth](../../groupdocs.viewer.options/viewinfooptions/maxwidth) { get; set; } | Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only). | +| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The Microsoft Outlook data files view options. | +| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF document view options. | +| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation files view options. | | [ProjectManagementOptions](../../groupdocs.viewer.options/baseviewoptions/projectmanagementoptions) { get; set; } | The project management files view options. | | [RenderComments](../../groupdocs.viewer.options/baseviewoptions/rendercomments) { get; set; } | Enables rendering comments. | | [RenderHiddenPages](../../groupdocs.viewer.options/baseviewoptions/renderhiddenpages) { get; set; } | Enables rendering of hidden pages. | | [RenderNotes](../../groupdocs.viewer.options/baseviewoptions/rendernotes) { get; set; } | Enables rendering notes. | | [SpreadsheetOptions](../../groupdocs.viewer.options/baseviewoptions/spreadsheetoptions) { get; set; } | The spreadsheet files view options. | -| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files splitting to pages options. | -| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files processing documents view options. | -| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [Width](../../groupdocs.viewer.options/viewinfooptions/width) { get; set; } | Image width (for rendering to PNG/JPG only) | -| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files view options. | +| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files view options. | +| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | The Web files view options. | +| [Width](../../groupdocs.viewer.options/viewinfooptions/width) { get; set; } | The width of the output image (in pixels, for rendering to PNG/JPG only). | +| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | The Word processing files view options. | ## Methods | Name | Description | | --- | --- | -| static [ForHtmlView](../../groupdocs.viewer.options/viewinfooptions/forhtmlview#forhtmlview)() | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into HTML. | -| static [ForHtmlView](../../groupdocs.viewer.options/viewinfooptions/forhtmlview#forhtmlview_1)(bool) | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into HTML. | -| static [ForJpgView](../../groupdocs.viewer.options/viewinfooptions/forjpgview#forjpgview)() | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into JPG. | -| static [ForJpgView](../../groupdocs.viewer.options/viewinfooptions/forjpgview#forjpgview_1)(bool) | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into JPG. | -| static [ForPdfView](../../groupdocs.viewer.options/viewinfooptions/forpdfview)() | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into PDF. | -| static [ForPngView](../../groupdocs.viewer.options/viewinfooptions/forpngview#forpngview)() | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into PNG. | -| static [ForPngView](../../groupdocs.viewer.options/viewinfooptions/forpngview#forpngview_1)(bool) | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into PNG. | -| static [FromHtmlViewOptions](../../groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions)(HtmlViewOptions) | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class based on [`HtmlViewOptions`](../htmlviewoptions) object. | -| static [FromJpgViewOptions](../../groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions)(JpgViewOptions) | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class based on [`JpgViewOptions`](../jpgviewoptions) object. | -| static [FromPdfViewOptions](../../groupdocs.viewer.options/viewinfooptions/frompdfviewoptions)(PdfViewOptions) | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class based on [`PdfViewOptions`](../pdfviewoptions) object. | -| static [FromPngViewOptions](../../groupdocs.viewer.options/viewinfooptions/frompngviewoptions)(PngViewOptions) | Initializes new instance of [`ViewInfoOptions`](../viewinfooptions) class based on [`PngViewOptions`](../pngviewoptions) object. | +| static [ForHtmlView](../../groupdocs.viewer.options/viewinfooptions/forhtmlview#forhtmlview)() | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into HTML. | +| static [ForHtmlView](../../groupdocs.viewer.options/viewinfooptions/forhtmlview#forhtmlview_1)(bool) | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into HTML. | +| static [ForJpgView](../../groupdocs.viewer.options/viewinfooptions/forjpgview#forjpgview)() | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into JPG. | +| static [ForJpgView](../../groupdocs.viewer.options/viewinfooptions/forjpgview#forjpgview_1)(bool) | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into JPG. | +| static [ForPdfView](../../groupdocs.viewer.options/viewinfooptions/forpdfview)() | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into PDF. | +| static [ForPngView](../../groupdocs.viewer.options/viewinfooptions/forpngview#forpngview)() | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into PNG. | +| static [ForPngView](../../groupdocs.viewer.options/viewinfooptions/forpngview#forpngview_1)(bool) | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class to retrieve information about view when rendering into PNG. | +| static [FromHtmlViewOptions](../../groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions)(HtmlViewOptions) | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class based on the [`HtmlViewOptions`](../htmlviewoptions) object. | +| static [FromJpgViewOptions](../../groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions)(JpgViewOptions) | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class based on the [`JpgViewOptions`](../jpgviewoptions) object. | +| static [FromPdfViewOptions](../../groupdocs.viewer.options/viewinfooptions/frompdfviewoptions)(PdfViewOptions) | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class based on the [`PdfViewOptions`](../pdfviewoptions) object. | +| static [FromPngViewOptions](../../groupdocs.viewer.options/viewinfooptions/frompngviewoptions)(PngViewOptions) | Initializes an instance of the [`ViewInfoOptions`](../viewinfooptions) class based on the [`PngViewOptions`](../pngviewoptions) object. | ### See Also diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/extracttext/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/extracttext/_index.md index ea42e15b8..f2c329e83 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/extracttext/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/extracttext/_index.md @@ -1,19 +1,25 @@ --- title: ExtractText second_title: GroupDocs.Viewer for .NET API Reference -description: Indicates that text extraction is enabled. +description: Enables text extraction. type: docs weight: 90 url: /net/groupdocs.viewer.options/viewinfooptions/extracttext/ --- ## ViewInfoOptions.ExtractText property -Indicates that text extraction is enabled. +Enables text extraction. ```csharp public bool ExtractText { get; set; } ``` +### Remarks + +Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. + +For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/). + ### See Also * class [ViewInfoOptions](../../viewinfooptions) diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/forhtmlview/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/forhtmlview/_index.md index b25dda280..08baa343c 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/forhtmlview/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/forhtmlview/_index.md @@ -1,14 +1,14 @@ --- title: ForHtmlView second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into HTML. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into HTML. type: docs weight: 10 url: /net/groupdocs.viewer.options/viewinfooptions/forhtmlview/ --- ## ForHtmlView() {#forhtmlview} -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into HTML. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into HTML. ```csharp public static ViewInfoOptions ForHtmlView() @@ -16,7 +16,7 @@ public static ViewInfoOptions ForHtmlView() ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### See Also @@ -28,7 +28,7 @@ New instance of [`ViewInfoOptions`](../../viewinfooptions) class. ## ForHtmlView(bool) {#forhtmlview_1} -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into HTML. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into HTML. ```csharp public static ViewInfoOptions ForHtmlView(bool renderSinglePage) @@ -36,11 +36,11 @@ public static ViewInfoOptions ForHtmlView(bool renderSinglePage) | Parameter | Type | Description | | --- | --- | --- | -| renderSinglePage | Boolean | Enables HTML content will be rendered to single page. | +| renderSinglePage | Boolean | Enables HTML content rendering to a single page. | ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### See Also diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/forjpgview/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/forjpgview/_index.md index 3de624e78..cad386b42 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/forjpgview/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/forjpgview/_index.md @@ -1,14 +1,14 @@ --- title: ForJpgView second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into JPG. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into JPG. type: docs weight: 20 url: /net/groupdocs.viewer.options/viewinfooptions/forjpgview/ --- ## ForJpgView() {#forjpgview} -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into JPG. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into JPG. ```csharp public static ViewInfoOptions ForJpgView() @@ -16,7 +16,7 @@ public static ViewInfoOptions ForJpgView() ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### See Also @@ -28,7 +28,7 @@ New instance of [`ViewInfoOptions`](../../viewinfooptions) class. ## ForJpgView(bool) {#forjpgview_1} -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into JPG. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into JPG. ```csharp public static ViewInfoOptions ForJpgView(bool extractText) @@ -40,7 +40,7 @@ public static ViewInfoOptions ForJpgView(bool extractText) ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### See Also diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/forpdfview/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/forpdfview/_index.md index 27bf72da4..dcd1da588 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/forpdfview/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/forpdfview/_index.md @@ -1,14 +1,14 @@ --- title: ForPdfView second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into PDF. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into PDF. type: docs weight: 30 url: /net/groupdocs.viewer.options/viewinfooptions/forpdfview/ --- ## ViewInfoOptions.ForPdfView method -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into PDF. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into PDF. ```csharp public static ViewInfoOptions ForPdfView() @@ -16,7 +16,7 @@ public static ViewInfoOptions ForPdfView() ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### See Also diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/forpngview/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/forpngview/_index.md index 89ab13e2a..de232fa43 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/forpngview/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/forpngview/_index.md @@ -1,14 +1,14 @@ --- title: ForPngView second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into PNG. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class to retrieve information about view when rendering into PNG. type: docs weight: 40 url: /net/groupdocs.viewer.options/viewinfooptions/forpngview/ --- ## ForPngView() {#forpngview} -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into PNG. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into PNG. ```csharp public static ViewInfoOptions ForPngView() @@ -16,7 +16,7 @@ public static ViewInfoOptions ForPngView() ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### See Also @@ -28,7 +28,7 @@ New instance of [`ViewInfoOptions`](../../viewinfooptions) class. ## ForPngView(bool) {#forpngview_1} -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into PNG. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class to retrieve information about view when rendering into PNG. ```csharp public static ViewInfoOptions ForPngView(bool extractText) @@ -40,7 +40,7 @@ public static ViewInfoOptions ForPngView(bool extractText) ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### See Also diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions/_index.md index 164dec1be..8c9f9917f 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: FromHtmlViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on HtmlViewOptionsgroupdocs.viewer.options/htmlviewoptions object. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on the HtmlViewOptionsgroupdocs.viewer.options/htmlviewoptions object. type: docs weight: 50 url: /net/groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions/ --- ## ViewInfoOptions.FromHtmlViewOptions method -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class based on [`HtmlViewOptions`](../../htmlviewoptions) object. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class based on the [`HtmlViewOptions`](../../htmlviewoptions) object. ```csharp public static ViewInfoOptions FromHtmlViewOptions(HtmlViewOptions options) @@ -20,7 +20,7 @@ public static ViewInfoOptions FromHtmlViewOptions(HtmlViewOptions options) ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### Exceptions diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions/_index.md index fac94ad66..9b88a0e90 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: FromJpgViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on JpgViewOptionsgroupdocs.viewer.options/jpgviewoptions object. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on the JpgViewOptionsgroupdocs.viewer.options/jpgviewoptions object. type: docs weight: 60 url: /net/groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions/ --- ## ViewInfoOptions.FromJpgViewOptions method -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class based on [`JpgViewOptions`](../../jpgviewoptions) object. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class based on the [`JpgViewOptions`](../../jpgviewoptions) object. ```csharp public static ViewInfoOptions FromJpgViewOptions(JpgViewOptions options) @@ -20,7 +20,7 @@ public static ViewInfoOptions FromJpgViewOptions(JpgViewOptions options) ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### Exceptions diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/frompdfviewoptions/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/frompdfviewoptions/_index.md index bff1e7841..5f959b63f 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/frompdfviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/frompdfviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: FromPdfViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on PdfViewOptionsgroupdocs.viewer.options/pdfviewoptions object. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on the PdfViewOptionsgroupdocs.viewer.options/pdfviewoptions object. type: docs weight: 70 url: /net/groupdocs.viewer.options/viewinfooptions/frompdfviewoptions/ --- ## ViewInfoOptions.FromPdfViewOptions method -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class based on [`PdfViewOptions`](../../pdfviewoptions) object. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class based on the [`PdfViewOptions`](../../pdfviewoptions) object. ```csharp public static ViewInfoOptions FromPdfViewOptions(PdfViewOptions options) @@ -20,7 +20,7 @@ public static ViewInfoOptions FromPdfViewOptions(PdfViewOptions options) ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### Exceptions diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/frompngviewoptions/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/frompngviewoptions/_index.md index 634ae9570..a259fd1cd 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/frompngviewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/frompngviewoptions/_index.md @@ -1,14 +1,14 @@ --- title: FromPngViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on PngViewOptionsgroupdocs.viewer.options/pngviewoptions object. +description: Initializes an instance of the ViewInfoOptionsgroupdocs.viewer.options/viewinfooptions class based on the PngViewOptionsgroupdocs.viewer.options/pngviewoptions object. type: docs weight: 80 url: /net/groupdocs.viewer.options/viewinfooptions/frompngviewoptions/ --- ## ViewInfoOptions.FromPngViewOptions method -Initializes new instance of [`ViewInfoOptions`](../../viewinfooptions) class based on [`PngViewOptions`](../../pngviewoptions) object. +Initializes an instance of the [`ViewInfoOptions`](../../viewinfooptions) class based on the [`PngViewOptions`](../../pngviewoptions) object. ```csharp public static ViewInfoOptions FromPngViewOptions(PngViewOptions options) @@ -20,7 +20,7 @@ public static ViewInfoOptions FromPngViewOptions(PngViewOptions options) ### Return Value -New instance of [`ViewInfoOptions`](../../viewinfooptions) class. +New instance of the [`ViewInfoOptions`](../../viewinfooptions) class. ### Exceptions diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/height/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/height/_index.md index 99449a6fc..a8c028a02 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/height/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/height/_index.md @@ -1,19 +1,25 @@ --- title: Height second_title: GroupDocs.Viewer for .NET API Reference -description: Image height for rendering to PNG/JPG only +description: The height of the output image in pixels for rendering to PNG/JPG only. type: docs weight: 100 url: /net/groupdocs.viewer.options/viewinfooptions/height/ --- ## ViewInfoOptions.Height property -Image height (for rendering to PNG/JPG only) +The height of the output image (in pixels, for rendering to PNG/JPG only). ```csharp public int Height { get; set; } ``` +### Remarks + +Use this property to set the output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/). + +If you set this property, the [`MaxHeight`](../maxheight) property is ignored. + ### See Also * class [ViewInfoOptions](../../viewinfooptions) diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/maxheight/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/maxheight/_index.md index 6a7fc16cc..507720528 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/maxheight/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/maxheight/_index.md @@ -1,19 +1,25 @@ --- title: MaxHeight second_title: GroupDocs.Viewer for .NET API Reference -description: Max height of the output image for rendering to PNG/JPG only +description: Sets the maximum height of an output image in pixels for rendering to PNG/JPG only. type: docs weight: 110 url: /net/groupdocs.viewer.options/viewinfooptions/maxheight/ --- ## ViewInfoOptions.MaxHeight property -Max height of the output image (for rendering to PNG/JPG only) +Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only). ```csharp public int MaxHeight { get; set; } ``` +### Remarks + +Use this property to set the maximum output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/). + +If you set the [`Height`](../height) property, this property is ignored. + ### See Also * class [ViewInfoOptions](../../viewinfooptions) diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/maxwidth/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/maxwidth/_index.md index 7deab70c1..f447737a8 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/maxwidth/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/maxwidth/_index.md @@ -1,19 +1,25 @@ --- title: MaxWidth second_title: GroupDocs.Viewer for .NET API Reference -description: Max width of the output image for rendering to PNG/JPG only +description: Sets the maximum width of an output image in pixels for rendering to PNG/JPG only. type: docs weight: 120 url: /net/groupdocs.viewer.options/viewinfooptions/maxwidth/ --- ## ViewInfoOptions.MaxWidth property -Max width of the output image (for rendering to PNG/JPG only) +Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only). ```csharp public int MaxWidth { get; set; } ``` +### Remarks + +Use this property to set the maximum output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/). + +If you set the [`Width`](../width) property, this property is ignored. + ### See Also * class [ViewInfoOptions](../../viewinfooptions) diff --git a/english/net/groupdocs.viewer.options/viewinfooptions/width/_index.md b/english/net/groupdocs.viewer.options/viewinfooptions/width/_index.md index fd22e03f4..e236242cb 100644 --- a/english/net/groupdocs.viewer.options/viewinfooptions/width/_index.md +++ b/english/net/groupdocs.viewer.options/viewinfooptions/width/_index.md @@ -1,19 +1,25 @@ --- title: Width second_title: GroupDocs.Viewer for .NET API Reference -description: Image width for rendering to PNG/JPG only +description: The width of the output image in pixels for rendering to PNG/JPG only. type: docs weight: 130 url: /net/groupdocs.viewer.options/viewinfooptions/width/ --- ## ViewInfoOptions.Width property -Image width (for rendering to PNG/JPG only) +The width of the output image (in pixels, for rendering to PNG/JPG only). ```csharp public int Width { get; set; } ``` +### Remarks + +Use this property to set the output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/). + +If you set this property, the [`MaxWidth`](../maxwidth) property is ignored. + ### See Also * class [ViewInfoOptions](../../viewinfooptions) diff --git a/english/net/groupdocs.viewer.options/viewoptions/_index.md b/english/net/groupdocs.viewer.options/viewoptions/_index.md index d258b5611..b74a5ed59 100644 --- a/english/net/groupdocs.viewer.options/viewoptions/_index.md +++ b/english/net/groupdocs.viewer.options/viewoptions/_index.md @@ -1,14 +1,14 @@ --- title: ViewOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides rendering options. +description: Contains the rendering options. type: docs weight: 560 url: /net/groupdocs.viewer.options/viewoptions/ --- ## ViewOptions class -Provides rendering options. +Contains the rendering options. ```csharp public abstract class ViewOptions : BaseViewOptions @@ -20,34 +20,34 @@ public abstract class ViewOptions : BaseViewOptions | --- | --- | | [ArchiveOptions](../../groupdocs.viewer.options/baseviewoptions/archiveoptions) { get; set; } | The archive files view options. | | [CadOptions](../../groupdocs.viewer.options/baseviewoptions/cadoptions) { get; set; } | The CAD drawing view options. | -| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Default font to be used when particular font used in document can't be found. | +| [DefaultFontName](../../groupdocs.viewer.options/baseviewoptions/defaultfontname) { get; set; } | Sets the default font for a document. | | [EmailOptions](../../groupdocs.viewer.options/baseviewoptions/emailoptions) { get; set; } | The email messages view options. | | [MailStorageOptions](../../groupdocs.viewer.options/baseviewoptions/mailstorageoptions) { get; set; } | Mail storage data files view options. | -| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The MS Outlook data files view options. | -| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF documents view options. | -| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation processing documents view options. | +| [OutlookOptions](../../groupdocs.viewer.options/baseviewoptions/outlookoptions) { get; set; } | The Microsoft Outlook data files view options. | +| [PdfOptions](../../groupdocs.viewer.options/baseviewoptions/pdfoptions) { get; set; } | The PDF document view options. | +| [PresentationOptions](../../groupdocs.viewer.options/baseviewoptions/presentationoptions) { get; set; } | The presentation files view options. | | [ProjectManagementOptions](../../groupdocs.viewer.options/baseviewoptions/projectmanagementoptions) { get; set; } | The project management files view options. | | [RenderComments](../../groupdocs.viewer.options/baseviewoptions/rendercomments) { get; set; } | Enables rendering comments. | | [RenderHiddenPages](../../groupdocs.viewer.options/baseviewoptions/renderhiddenpages) { get; set; } | Enables rendering of hidden pages. | | [RenderNotes](../../groupdocs.viewer.options/baseviewoptions/rendernotes) { get; set; } | Enables rendering notes. | | [SpreadsheetOptions](../../groupdocs.viewer.options/baseviewoptions/spreadsheetoptions) { get; set; } | The spreadsheet files view options. | -| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files splitting to pages options. | -| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files processing documents view options. | -| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark applied to each page. | -| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. | -| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. | +| [TextOptions](../../groupdocs.viewer.options/baseviewoptions/textoptions) { get; set; } | Text files view options. | +| [VisioRenderingOptions](../../groupdocs.viewer.options/baseviewoptions/visiorenderingoptions) { get; set; } | The Visio files view options. | +| [Watermark](../../groupdocs.viewer.options/viewoptions/watermark) { get; set; } | The text watermark to be applied to each page. | +| [WebDocumentOptions](../../groupdocs.viewer.options/baseviewoptions/webdocumentoptions) { get; set; } | The Web files view options. | +| [WordProcessingOptions](../../groupdocs.viewer.options/baseviewoptions/wordprocessingoptions) { get; set; } | The Word processing files view options. | ## Methods | Name | Description | | --- | --- | -| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies clockwise rotation to the page. | +| [RotatePage](../../groupdocs.viewer.options/viewoptions/rotatepage)(int, Rotation) | Applies the clockwise rotation to a page. | ## Fields | Name | Description | | --- | --- | -| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotations. | +| readonly [PageRotations](../../groupdocs.viewer.options/viewoptions/pagerotations) | The page rotation. | ### See Also diff --git a/english/net/groupdocs.viewer.options/viewoptions/pagerotations/_index.md b/english/net/groupdocs.viewer.options/viewoptions/pagerotations/_index.md index 4a22d8985..3018a56ce 100644 --- a/english/net/groupdocs.viewer.options/viewoptions/pagerotations/_index.md +++ b/english/net/groupdocs.viewer.options/viewoptions/pagerotations/_index.md @@ -1,14 +1,14 @@ --- title: PageRotations second_title: GroupDocs.Viewer for .NET API Reference -description: The page rotations. +description: The page rotation. type: docs weight: 20 url: /net/groupdocs.viewer.options/viewoptions/pagerotations/ --- ## ViewOptions.PageRotations field -The page rotations. +The page rotation. ```csharp public readonly Dictionary PageRotations; @@ -16,7 +16,9 @@ public readonly Dictionary PageRotations; ### Remarks -In case both [`Watermark`](../watermark) and `PageRotations` are specified than watermark will be applied to the rotated pages. +If both [`Watermark`](../watermark) and `PageRotations` are specified, the watermark is applied to the rotated pages. + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/flip-or-rotate-pages/). ### See Also diff --git a/english/net/groupdocs.viewer.options/viewoptions/rotatepage/_index.md b/english/net/groupdocs.viewer.options/viewoptions/rotatepage/_index.md index 9bfa8e09c..f87b95c5f 100644 --- a/english/net/groupdocs.viewer.options/viewoptions/rotatepage/_index.md +++ b/english/net/groupdocs.viewer.options/viewoptions/rotatepage/_index.md @@ -1,14 +1,14 @@ --- title: RotatePage second_title: GroupDocs.Viewer for .NET API Reference -description: Applies clockwise rotation to the page. +description: Applies the clockwise rotation to a page. type: docs weight: 30 url: /net/groupdocs.viewer.options/viewoptions/rotatepage/ --- ## ViewOptions.RotatePage method -Applies clockwise rotation to the page. +Applies the clockwise rotation to a page. ```csharp public void RotatePage(int pageNumber, Rotation rotation) @@ -26,6 +26,10 @@ public void RotatePage(int pageNumber, Rotation rotation) | ArgumentException | Thrown when *pageNumber* is less or equal to zero. | | ArgumentException | Thrown when rotation for the page with number *pageNumber* was already added. | +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/flip-or-rotate-pages/). + ### See Also * enum [Rotation](../../rotation) diff --git a/english/net/groupdocs.viewer.options/viewoptions/watermark/_index.md b/english/net/groupdocs.viewer.options/viewoptions/watermark/_index.md index 0c891ebc9..acf07698c 100644 --- a/english/net/groupdocs.viewer.options/viewoptions/watermark/_index.md +++ b/english/net/groupdocs.viewer.options/viewoptions/watermark/_index.md @@ -1,14 +1,14 @@ --- title: Watermark second_title: GroupDocs.Viewer for .NET API Reference -description: The text watermark applied to each page. +description: The text watermark to be applied to each page. type: docs weight: 10 url: /net/groupdocs.viewer.options/viewoptions/watermark/ --- ## ViewOptions.Watermark property -The text watermark applied to each page. +The text watermark to be applied to each page. ```csharp public Watermark Watermark { get; set; } @@ -16,7 +16,9 @@ public Watermark Watermark { get; set; } ### Remarks -In case both `Watermark` and [`PageRotations`](../pagerotations) are specified than watermark will be applied to the rotated pages. +If both `Watermark` and [`PageRotations`](../pagerotations) are specified, the watermark is applied to the rotated pages. + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/add-text-watermark/). ### See Also diff --git a/english/net/groupdocs.viewer.options/visiorenderingoptions/_index.md b/english/net/groupdocs.viewer.options/visiorenderingoptions/_index.md index 3b99ceb74..aacdaee37 100644 --- a/english/net/groupdocs.viewer.options/visiorenderingoptions/_index.md +++ b/english/net/groupdocs.viewer.options/visiorenderingoptions/_index.md @@ -1,14 +1,14 @@ --- title: VisioRenderingOptions second_title: GroupDocs.Viewer for .NET API Reference -description: The Visio files processing documents view options. +description: Contains options for rendering Visio documents. For details see the documentationhttps//docs.groupdocs.com/viewer/net/rendervisiodocuments/. type: docs weight: 570 url: /net/groupdocs.viewer.options/visiorenderingoptions/ --- ## VisioRenderingOptions class -The Visio files processing documents view options. +Contains options for rendering Visio documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/). ```csharp public class VisioRenderingOptions @@ -18,7 +18,7 @@ public class VisioRenderingOptions | Name | Description | | --- | --- | -| [VisioRenderingOptions](visiorenderingoptions)() | Initializes new instance of [`VisioRenderingOptions`](../visiorenderingoptions) class. | +| [VisioRenderingOptions](visiorenderingoptions)() | Initializes an instance of the [`VisioRenderingOptions`](../visiorenderingoptions) class. | ## Properties diff --git a/english/net/groupdocs.viewer.options/visiorenderingoptions/renderfiguresonly/_index.md b/english/net/groupdocs.viewer.options/visiorenderingoptions/renderfiguresonly/_index.md index 6ce72a71e..09b28a5f1 100644 --- a/english/net/groupdocs.viewer.options/visiorenderingoptions/renderfiguresonly/_index.md +++ b/english/net/groupdocs.viewer.options/visiorenderingoptions/renderfiguresonly/_index.md @@ -14,6 +14,10 @@ Render only Visio figures, not a diagram. public bool RenderFiguresOnly { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/#render-only-diagram-shapes). + ### See Also * class [VisioRenderingOptions](../../visiorenderingoptions) diff --git a/english/net/groupdocs.viewer.options/visiorenderingoptions/visiorenderingoptions/_index.md b/english/net/groupdocs.viewer.options/visiorenderingoptions/visiorenderingoptions/_index.md index ec8c76357..0e1a8f630 100644 --- a/english/net/groupdocs.viewer.options/visiorenderingoptions/visiorenderingoptions/_index.md +++ b/english/net/groupdocs.viewer.options/visiorenderingoptions/visiorenderingoptions/_index.md @@ -1,14 +1,14 @@ --- title: VisioRenderingOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of VisioRenderingOptionsgroupdocs.viewer.options/visiorenderingoptions class. +description: Initializes an instance of the VisioRenderingOptionsgroupdocs.viewer.options/visiorenderingoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/visiorenderingoptions/visiorenderingoptions/ --- ## VisioRenderingOptions constructor -Initializes new instance of [`VisioRenderingOptions`](../../visiorenderingoptions) class. +Initializes an instance of the [`VisioRenderingOptions`](../../visiorenderingoptions) class. ```csharp public VisioRenderingOptions() diff --git a/english/net/groupdocs.viewer.options/watermark/_index.md b/english/net/groupdocs.viewer.options/watermark/_index.md index 699ffc323..9d78e1000 100644 --- a/english/net/groupdocs.viewer.options/watermark/_index.md +++ b/english/net/groupdocs.viewer.options/watermark/_index.md @@ -1,14 +1,14 @@ --- title: Watermark second_title: GroupDocs.Viewer for .NET API Reference -description: Represents text watermark. +description: Represents a text watermark. For details see the documentationhttps//docs.groupdocs.com/viewer/net/addtextwatermark/. type: docs weight: 580 url: /net/groupdocs.viewer.options/watermark/ --- ## Watermark class -Represents text watermark. +Represents a text watermark. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/add-text-watermark/). ```csharp public class Watermark @@ -18,7 +18,7 @@ public class Watermark | Name | Description | | --- | --- | -| [Watermark](watermark)(string) | Initializes new instance of [`Watermark`](../watermark) class. | +| [Watermark](watermark)(string) | Initializes an instance of the [`Watermark`](../watermark) class. | ## Properties diff --git a/english/net/groupdocs.viewer.options/watermark/watermark/_index.md b/english/net/groupdocs.viewer.options/watermark/watermark/_index.md index 618f86d67..60f5f37f5 100644 --- a/english/net/groupdocs.viewer.options/watermark/watermark/_index.md +++ b/english/net/groupdocs.viewer.options/watermark/watermark/_index.md @@ -1,14 +1,14 @@ --- title: Watermark second_title: GroupDocs.Viewer for .NET API Reference -description: Initializes new instance of Watermarkgroupdocs.viewer.options/watermark class. +description: Initializes an instance of the Watermarkgroupdocs.viewer.options/watermark class. type: docs weight: 10 url: /net/groupdocs.viewer.options/watermark/watermark/ --- ## Watermark constructor -Initializes new instance of [`Watermark`](../../watermark) class. +Initializes an instance of the [`Watermark`](../../watermark) class. ```csharp public Watermark(string text) diff --git a/english/net/groupdocs.viewer.options/webdocumentoptions/_index.md b/english/net/groupdocs.viewer.options/webdocumentoptions/_index.md index 8b3281845..66730efd5 100644 --- a/english/net/groupdocs.viewer.options/webdocumentoptions/_index.md +++ b/english/net/groupdocs.viewer.options/webdocumentoptions/_index.md @@ -1,14 +1,14 @@ --- title: WebDocumentOptions second_title: GroupDocs.Viewer for .NET API Reference -description: This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. +description: Contains options for rendering web documents. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderwebdocuments/. type: docs weight: 590 url: /net/groupdocs.viewer.options/webdocumentoptions/ --- ## WebDocumentOptions class -This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. +Contains options for rendering web documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/). ```csharp public class WebDocumentOptions @@ -18,17 +18,17 @@ public class WebDocumentOptions | Name | Description | | --- | --- | -| [WebDocumentOptions](webdocumentoptions)() | Provides options for rendering word processing documents. | +| [WebDocumentOptions](webdocumentoptions)() | Initializes an instance of the [`WebDocumentOptions`](../webdocumentoptions) class. | ## Properties | Name | Description | | --- | --- | -| [BottomMargin](../../groupdocs.viewer.options/webdocumentoptions/bottommargin) { get; set; } | The distance (in points) between the bottom edge of the page and the bottom boundary of the body text. The default value is 72 points. | -| [LeftMargin](../../groupdocs.viewer.options/webdocumentoptions/leftmargin) { get; set; } | The distance (in points) between the left edge of the page and the left boundary of the body text. The default value is 5 points. | -| [PageSize](../../groupdocs.viewer.options/webdocumentoptions/pagesize) { get; set; } | The size of the output page. The default value is Letter 792 x 612 points. When contents does not fit set a larger page size e.g. A3. | -| [RightMargin](../../groupdocs.viewer.options/webdocumentoptions/rightmargin) { get; set; } | The distance (in points) between the right edge of the page and the right boundary of the body text. The default value is 5 points. | -| [TopMargin](../../groupdocs.viewer.options/webdocumentoptions/topmargin) { get; set; } | The distance (in points) between the top edge of the page and the top boundary of the body text. The default value is 72 points. | +| [BottomMargin](../../groupdocs.viewer.options/webdocumentoptions/bottommargin) { get; set; } | Sets the bottom margin of a page. The default value is 72 points. | +| [LeftMargin](../../groupdocs.viewer.options/webdocumentoptions/leftmargin) { get; set; } | Sets the left margin of a page. The default value is 5 points. | +| [PageSize](../../groupdocs.viewer.options/webdocumentoptions/pagesize) { get; set; } | Sets the size of the output page. | +| [RightMargin](../../groupdocs.viewer.options/webdocumentoptions/rightmargin) { get; set; } | Sets the right margin of a page. The default value is 5 points. | +| [TopMargin](../../groupdocs.viewer.options/webdocumentoptions/topmargin) { get; set; } | Sets the top margin of a page. The default value is 72 points. | ### See Also diff --git a/english/net/groupdocs.viewer.options/webdocumentoptions/bottommargin/_index.md b/english/net/groupdocs.viewer.options/webdocumentoptions/bottommargin/_index.md index f203c502d..472a4dad1 100644 --- a/english/net/groupdocs.viewer.options/webdocumentoptions/bottommargin/_index.md +++ b/english/net/groupdocs.viewer.options/webdocumentoptions/bottommargin/_index.md @@ -1,19 +1,23 @@ --- title: BottomMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the bottom edge of the page and the bottom boundary of the body text. The default value is 72 points. +description: Sets the bottom margin of a page. The default value is 72 points. type: docs weight: 20 url: /net/groupdocs.viewer.options/webdocumentoptions/bottommargin/ --- ## WebDocumentOptions.BottomMargin property -The distance (in points) between the bottom edge of the page and the bottom boundary of the body text. The default value is 72 points. +Sets the bottom margin of a page. The default value is 72 points. ```csharp public float BottomMargin { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins). + ### See Also * class [WebDocumentOptions](../../webdocumentoptions) diff --git a/english/net/groupdocs.viewer.options/webdocumentoptions/leftmargin/_index.md b/english/net/groupdocs.viewer.options/webdocumentoptions/leftmargin/_index.md index d58370543..591aa2e82 100644 --- a/english/net/groupdocs.viewer.options/webdocumentoptions/leftmargin/_index.md +++ b/english/net/groupdocs.viewer.options/webdocumentoptions/leftmargin/_index.md @@ -1,19 +1,23 @@ --- title: LeftMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the left edge of the page and the left boundary of the body text. The default value is 5 points. +description: Sets the left margin of a page. The default value is 5 points. type: docs weight: 30 url: /net/groupdocs.viewer.options/webdocumentoptions/leftmargin/ --- ## WebDocumentOptions.LeftMargin property -The distance (in points) between the left edge of the page and the left boundary of the body text. The default value is 5 points. +Sets the left margin of a page. The default value is 5 points. ```csharp public float LeftMargin { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins). + ### See Also * class [WebDocumentOptions](../../webdocumentoptions) diff --git a/english/net/groupdocs.viewer.options/webdocumentoptions/pagesize/_index.md b/english/net/groupdocs.viewer.options/webdocumentoptions/pagesize/_index.md index ebb8aff4d..defb1a27b 100644 --- a/english/net/groupdocs.viewer.options/webdocumentoptions/pagesize/_index.md +++ b/english/net/groupdocs.viewer.options/webdocumentoptions/pagesize/_index.md @@ -1,19 +1,23 @@ --- title: PageSize second_title: GroupDocs.Viewer for .NET API Reference -description: The size of the output page. The default value is Letter 792 x 612 points. When contents does not fit set a larger page size e.g. A3. +description: Sets the size of the output page. type: docs weight: 40 url: /net/groupdocs.viewer.options/webdocumentoptions/pagesize/ --- ## WebDocumentOptions.PageSize property -The size of the output page. The default value is Letter 792 x 612 points. When contents does not fit set a larger page size e.g. A3. +Sets the size of the output page. ```csharp public PageSize PageSize { get; set; } ``` +### Remarks + +The default value is Letter, 792 x 612 points. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#set-the-output-page-size). + ### See Also * enum [PageSize](../../pagesize) diff --git a/english/net/groupdocs.viewer.options/webdocumentoptions/rightmargin/_index.md b/english/net/groupdocs.viewer.options/webdocumentoptions/rightmargin/_index.md index 2fda25505..5f92e1627 100644 --- a/english/net/groupdocs.viewer.options/webdocumentoptions/rightmargin/_index.md +++ b/english/net/groupdocs.viewer.options/webdocumentoptions/rightmargin/_index.md @@ -1,19 +1,23 @@ --- title: RightMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the right edge of the page and the right boundary of the body text. The default value is 5 points. +description: Sets the right margin of a page. The default value is 5 points. type: docs weight: 50 url: /net/groupdocs.viewer.options/webdocumentoptions/rightmargin/ --- ## WebDocumentOptions.RightMargin property -The distance (in points) between the right edge of the page and the right boundary of the body text. The default value is 5 points. +Sets the right margin of a page. The default value is 5 points. ```csharp public float RightMargin { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins). + ### See Also * class [WebDocumentOptions](../../webdocumentoptions) diff --git a/english/net/groupdocs.viewer.options/webdocumentoptions/topmargin/_index.md b/english/net/groupdocs.viewer.options/webdocumentoptions/topmargin/_index.md index 49aed2c90..eae153a80 100644 --- a/english/net/groupdocs.viewer.options/webdocumentoptions/topmargin/_index.md +++ b/english/net/groupdocs.viewer.options/webdocumentoptions/topmargin/_index.md @@ -1,19 +1,23 @@ --- title: TopMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the top edge of the page and the top boundary of the body text. The default value is 72 points. +description: Sets the top margin of a page. The default value is 72 points. type: docs weight: 60 url: /net/groupdocs.viewer.options/webdocumentoptions/topmargin/ --- ## WebDocumentOptions.TopMargin property -The distance (in points) between the top edge of the page and the top boundary of the body text. The default value is 72 points. +Sets the top margin of a page. The default value is 72 points. ```csharp public float TopMargin { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins). + ### See Also * class [WebDocumentOptions](../../webdocumentoptions) diff --git a/english/net/groupdocs.viewer.options/webdocumentoptions/webdocumentoptions/_index.md b/english/net/groupdocs.viewer.options/webdocumentoptions/webdocumentoptions/_index.md index d11bb6356..b18e27a90 100644 --- a/english/net/groupdocs.viewer.options/webdocumentoptions/webdocumentoptions/_index.md +++ b/english/net/groupdocs.viewer.options/webdocumentoptions/webdocumentoptions/_index.md @@ -1,19 +1,23 @@ --- title: WebDocumentOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering word processing documents. +description: Initializes an instance of the WebDocumentOptionsgroupdocs.viewer.options/webdocumentoptions class. type: docs weight: 10 url: /net/groupdocs.viewer.options/webdocumentoptions/webdocumentoptions/ --- ## WebDocumentOptions constructor -Provides options for rendering word processing documents. +Initializes an instance of the [`WebDocumentOptions`](../../webdocumentoptions) class. ```csharp public WebDocumentOptions() ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/). + ### See Also * class [WebDocumentOptions](../../webdocumentoptions) diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/_index.md index 336230737..e7997e938 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/_index.md @@ -1,14 +1,14 @@ --- title: WordProcessingOptions second_title: GroupDocs.Viewer for .NET API Reference -description: This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. +description: Contains options for rendering Word documents. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderworddocuments/. type: docs weight: 600 url: /net/groupdocs.viewer.options/wordprocessingoptions/ --- ## WordProcessingOptions class -This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents. +Contains options for rendering Word documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/). ```csharp public class WordProcessingOptions @@ -18,23 +18,19 @@ public class WordProcessingOptions | Name | Description | | --- | --- | -| [WordProcessingOptions](wordprocessingoptions)() | Provides options for rendering word processing documents. | +| [WordProcessingOptions](wordprocessingoptions)() | Contains options for rendering word processing documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes). | ## Properties | Name | Description | | --- | --- | -| [BottomMargin](../../groupdocs.viewer.options/wordprocessingoptions/bottommargin) { get; set; } | The distance (in points) between the bottom edge of the page and the bottom boundary of the body text. | -| [EnableOpenTypeFeatures](../../groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures) { get; set; } | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. | -| [LeftMargin](../../groupdocs.viewer.options/wordprocessingoptions/leftmargin) { get; set; } | The distance (in points) between the left edge of the page and the left boundary of the body text. | +| [BottomMargin](../../groupdocs.viewer.options/wordprocessingoptions/bottommargin) { get; set; } | Sets the bottom margin of a page. | +| [EnableOpenTypeFeatures](../../groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures) { get; set; } | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian Latin-based, or Cyrillic-based scripts. | +| [LeftMargin](../../groupdocs.viewer.options/wordprocessingoptions/leftmargin) { get; set; } | Sets the left margin of a page. | | [PageSize](../../groupdocs.viewer.options/wordprocessingoptions/pagesize) { get; set; } | The size of the output page. The default value is Unspecified which means that a page size is set in a page settings (Page Setup) is used. When rendering HTM and HTML files the default page size is set to Letter 792 x 612 points. As a result, some of the content may not fit into the page frame. Set a larger page size e.g. A3 to fit the contents. | | [RenderTrackedChanges](../../groupdocs.viewer.options/wordprocessingoptions/rendertrackedchanges) { get; set; } | Enables tracked changes (revisions) rendering. | -| [RightMargin](../../groupdocs.viewer.options/wordprocessingoptions/rightmargin) { get; set; } | The distance (in points) between the right edge of the page and the right boundary of the body text. | -| [TopMargin](../../groupdocs.viewer.options/wordprocessingoptions/topmargin) { get; set; } | The distance (in points) between the top edge of the page and the top boundary of the body text. | - -### Remarks - -See also Render Word documents as HTML, PDF, or image files for more details and code snippets. +| [RightMargin](../../groupdocs.viewer.options/wordprocessingoptions/rightmargin) { get; set; } | Sets the right margin of a page. | +| [TopMargin](../../groupdocs.viewer.options/wordprocessingoptions/topmargin) { get; set; } | Sets the top margin of a page. | ### See Also diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/bottommargin/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/bottommargin/_index.md index 8fe8800e8..0a3c0809a 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/bottommargin/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/bottommargin/_index.md @@ -1,14 +1,14 @@ --- title: BottomMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the bottom edge of the page and the bottom boundary of the body text. +description: Sets the bottom margin of a page. type: docs weight: 20 url: /net/groupdocs.viewer.options/wordprocessingoptions/bottommargin/ --- ## WordProcessingOptions.BottomMargin property -The distance (in points) between the bottom edge of the page and the bottom boundary of the body text. +Sets the bottom margin of a page. ```csharp public float? BottomMargin { get; set; } @@ -16,7 +16,7 @@ public float? BottomMargin { get; set; } ### Remarks -By default, the Bottom Margin value that is set in the Page Setup of the source document will be used. +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins). ### See Also diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures/_index.md index 32d179a63..3ec8e162f 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures/_index.md @@ -1,14 +1,14 @@ --- title: EnableOpenTypeFeatures second_title: GroupDocs.Viewer for .NET API Reference -description: This option enables kerning and other OpenType Features when rendering Arabic Hebrew Indian scripts Latinbased or Cyrillicbased scripts. +description: This option enables kerning and other OpenType Features when rendering Arabic Hebrew Indian Latinbased or Cyrillicbased scripts. type: docs weight: 30 url: /net/groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures/ --- ## WordProcessingOptions.EnableOpenTypeFeatures property -This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. +This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian Latin-based, or Cyrillic-based scripts. ```csharp public bool EnableOpenTypeFeatures { get; set; } diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/leftmargin/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/leftmargin/_index.md index 882fddb1c..b022b3174 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/leftmargin/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/leftmargin/_index.md @@ -1,14 +1,14 @@ --- title: LeftMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the left edge of the page and the left boundary of the body text. +description: Sets the left margin of a page. type: docs weight: 40 url: /net/groupdocs.viewer.options/wordprocessingoptions/leftmargin/ --- ## WordProcessingOptions.LeftMargin property -The distance (in points) between the left edge of the page and the left boundary of the body text. +Sets the left margin of a page. ```csharp public float? LeftMargin { get; set; } @@ -16,7 +16,7 @@ public float? LeftMargin { get; set; } ### Remarks -By default, the Left Margin value that is set in the Page Setup of the source document will be used. +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins). ### See Also diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/rendertrackedchanges/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/rendertrackedchanges/_index.md index bfcd933fc..0b9c6f541 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/rendertrackedchanges/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/rendertrackedchanges/_index.md @@ -14,6 +14,10 @@ Enables tracked changes (revisions) rendering. public bool RenderTrackedChanges { get; set; } ``` +### Remarks + +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes). + ### See Also * class [WordProcessingOptions](../../wordprocessingoptions) diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/rightmargin/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/rightmargin/_index.md index 1b9bad145..689a6c4e9 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/rightmargin/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/rightmargin/_index.md @@ -1,14 +1,14 @@ --- title: RightMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the right edge of the page and the right boundary of the body text. +description: Sets the right margin of a page. type: docs weight: 70 url: /net/groupdocs.viewer.options/wordprocessingoptions/rightmargin/ --- ## WordProcessingOptions.RightMargin property -The distance (in points) between the right edge of the page and the right boundary of the body text. +Sets the right margin of a page. ```csharp public float? RightMargin { get; set; } @@ -16,7 +16,7 @@ public float? RightMargin { get; set; } ### Remarks -By default, the Right Margin value that is set in the Page Setup of the source document will be used. +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins). ### See Also diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/topmargin/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/topmargin/_index.md index d799a46e5..beb36b8fe 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/topmargin/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/topmargin/_index.md @@ -1,14 +1,14 @@ --- title: TopMargin second_title: GroupDocs.Viewer for .NET API Reference -description: The distance in points between the top edge of the page and the top boundary of the body text. +description: Sets the top margin of a page. type: docs weight: 80 url: /net/groupdocs.viewer.options/wordprocessingoptions/topmargin/ --- ## WordProcessingOptions.TopMargin property -The distance (in points) between the top edge of the page and the top boundary of the body text. +Sets the top margin of a page. ```csharp public float? TopMargin { get; set; } @@ -16,7 +16,7 @@ public float? TopMargin { get; set; } ### Remarks -By default, the Top Margin value that is set in the Page Setup of the source document will be used. +For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins). ### See Also diff --git a/english/net/groupdocs.viewer.options/wordprocessingoptions/wordprocessingoptions/_index.md b/english/net/groupdocs.viewer.options/wordprocessingoptions/wordprocessingoptions/_index.md index e1b84d950..4095269cd 100644 --- a/english/net/groupdocs.viewer.options/wordprocessingoptions/wordprocessingoptions/_index.md +++ b/english/net/groupdocs.viewer.options/wordprocessingoptions/wordprocessingoptions/_index.md @@ -1,14 +1,14 @@ --- title: WordProcessingOptions second_title: GroupDocs.Viewer for .NET API Reference -description: Provides options for rendering word processing documents. +description: Contains options for rendering word processing documents. For details see the documentationhttps//docs.groupdocs.com/viewer/net/renderworddocuments/rendertrackedchanges. type: docs weight: 10 url: /net/groupdocs.viewer.options/wordprocessingoptions/wordprocessingoptions/ --- ## WordProcessingOptions constructor -Provides options for rendering word processing documents. +Contains options for rendering word processing documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes). ```csharp public WordProcessingOptions()