Skip to content

Commit

Permalink
Update content 2023-06-23 11:11:50
Browse files Browse the repository at this point in the history
  • Loading branch information
yevgen-nykytenko committed Jun 23, 2023
1 parent 473fa92 commit 6d1d5e8
Show file tree
Hide file tree
Showing 73 changed files with 717 additions and 125 deletions.
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.caching/cachekeys/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CacheKeys
second_title: GroupDocs.Viewer for .NET API Reference
description: Provides methods to retrieve unique identifier for the cache entry.
type: docs
weight: 800
weight: 810
url: /net/groupdocs.viewer.caching/cachekeys/
---
## CacheKeys class
Expand Down
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.caching/filecache/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: FileCache
second_title: GroupDocs.Viewer for .NET API Reference
description: Represents a local ondisk cache.
type: docs
weight: 810
weight: 820
url: /net/groupdocs.viewer.caching/filecache/
---
## FileCache class
Expand Down
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.caching/icache/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ICache
second_title: GroupDocs.Viewer for .NET API Reference
description: Defines methods required for storing rendered document and document resources сache.
type: docs
weight: 820
weight: 830
url: /net/groupdocs.viewer.caching/icache/
---
## ICache interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: GroupDocsViewerException
second_title: GroupDocs.Viewer for .NET API Reference
description: Represents the generic errors that occur during document processing.
type: docs
weight: 770
weight: 780
url: /net/groupdocs.viewer.exceptions/groupdocsviewerexception/
---
## GroupDocsViewerException class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IncorrectPasswordException
second_title: GroupDocs.Viewer for .NET API Reference
description: The exception that is thrown when specified password is incorrect.
type: docs
weight: 780
weight: 790
url: /net/groupdocs.viewer.exceptions/incorrectpasswordexception/
---
## IncorrectPasswordException class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: PasswordRequiredException
second_title: GroupDocs.Viewer for .NET API Reference
description: The exception that is thrown when password is required to load the document.
type: docs
weight: 790
weight: 800
url: /net/groupdocs.viewer.exceptions/passwordrequiredexception/
---
## PasswordRequiredException class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: FolderFontSource
second_title: GroupDocs.Viewer for .NET API Reference
description: Represents the folder that contains TrueType fonts.
type: docs
weight: 730
weight: 740
url: /net/groupdocs.viewer.fonts/folderfontsource/
---
## FolderFontSource class
Expand Down
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.fonts/fontsettings/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: FontSettings
second_title: GroupDocs.Viewer for .NET API Reference
description: Provides methods for working with sources to look for TrueType fonts.
type: docs
weight: 740
weight: 750
url: /net/groupdocs.viewer.fonts/fontsettings/
---
## FontSettings class
Expand Down
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.fonts/ifontsource/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IFontSource
second_title: GroupDocs.Viewer for .NET API Reference
description: Marker interface for the font sources.
type: docs
weight: 750
weight: 760
url: /net/groupdocs.viewer.fonts/ifontsource/
---
## IFontSource interface
Expand Down
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.fonts/searchoption/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: SearchOption
second_title: GroupDocs.Viewer for .NET API Reference
description: Specifies whether to search the current folder or the current folder and all subfolders.
type: docs
weight: 760
weight: 770
url: /net/groupdocs.viewer.fonts/searchoption/
---
## SearchOption enumeration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CreateFileStream
second_title: GroupDocs.Viewer for .NET API Reference
description: Represents the method that instantiates stream used to write output file data.
type: docs
weight: 630
weight: 640
url: /net/groupdocs.viewer.interfaces/createfilestream/
---
## CreateFileStream delegate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CreatePageStream
second_title: GroupDocs.Viewer for .NET API Reference
description: Represents the method that instantiates stream used to write output page data.
type: docs
weight: 650
weight: 660
url: /net/groupdocs.viewer.interfaces/createpagestream/
---
## CreatePageStream delegate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CreateResourceStream
second_title: GroupDocs.Viewer for .NET API Reference
description: Represents the method that instantiates stream used to write output HTML resource data.
type: docs
weight: 670
weight: 680
url: /net/groupdocs.viewer.interfaces/createresourcestream/
---
## CreateResourceStream delegate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CreateResourceUrl
second_title: GroupDocs.Viewer for .NET API Reference
description: Represents the method that creates URL for HTML resource.
type: docs
weight: 690
weight: 700
url: /net/groupdocs.viewer.interfaces/createresourceurl/
---
## CreateResourceUrl delegate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IFileStreamFactory
second_title: GroupDocs.Viewer for .NET API Reference
description: Defines the methods that are required for instantiating and releasing output file stream.
type: docs
weight: 700
weight: 710
url: /net/groupdocs.viewer.interfaces/ifilestreamfactory/
---
## IFileStreamFactory interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IPageStreamFactory
second_title: GroupDocs.Viewer for .NET API Reference
description: Defines the methods that are required for instantiating and releasing output page stream.
type: docs
weight: 710
weight: 720
url: /net/groupdocs.viewer.interfaces/ipagestreamfactory/
---
## IPageStreamFactory interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IResourceStreamFactory
second_title: GroupDocs.Viewer for .NET API Reference
description: Defines the methods that are required for creating resource URL instantiating and releasing output HTML resource stream.
type: docs
weight: 720
weight: 730
url: /net/groupdocs.viewer.interfaces/iresourcestreamfactory/
---
## IResourceStreamFactory interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ReleaseFileStream
second_title: GroupDocs.Viewer for .NET API Reference
description: Releases stream which was instantiated by the method associated with CreateFileStream./createfilestream delegate.
type: docs
weight: 640
weight: 650
url: /net/groupdocs.viewer.interfaces/releasefilestream/
---
## ReleaseFileStream delegate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ReleasePageStream
second_title: GroupDocs.Viewer for .NET API Reference
description: Releases stream which was instantiated by the method associated with CreatePageStream./createpagestream delegate.
type: docs
weight: 660
weight: 670
url: /net/groupdocs.viewer.interfaces/releasepagestream/
---
## ReleasePageStream delegate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ReleaseResourceStream
second_title: GroupDocs.Viewer for .NET API Reference
description: Releases stream which was instantiated by the method associated with CreateResourceStream./createresourcestream delegate.
type: docs
weight: 680
weight: 690
url: /net/groupdocs.viewer.interfaces/releaseresourcestream/
---
## ReleaseResourceStream delegate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ConsoleLogger
second_title: GroupDocs.Viewer for .NET API Reference
description: Writes log messages to the console.
type: docs
weight: 600
weight: 610
url: /net/groupdocs.viewer.logging/consolelogger/
---
## ConsoleLogger class
Expand Down
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.logging/filelogger/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: FileLogger
second_title: GroupDocs.Viewer for .NET API Reference
description: Writes log messages to the file.
type: docs
weight: 610
weight: 620
url: /net/groupdocs.viewer.logging/filelogger/
---
## FileLogger class
Expand Down
2 changes: 1 addition & 1 deletion english/net/groupdocs.viewer.logging/ilogger/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ILogger
second_title: GroupDocs.Viewer for .NET API Reference
description: Defines the methods that are used to perform logging.
type: docs
weight: 620
weight: 630
url: /net/groupdocs.viewer.logging/ilogger/
---
## ILogger interface
Expand Down
1 change: 1 addition & 0 deletions english/net/groupdocs.viewer.options/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The namespace provides classes to specify additional options when rendering docu
| [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. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
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.
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.

```csharp
public class PdfOptimizationOptions
```

## Constructors

| Name | Description |
| --- | --- |
| [PdfOptimizationOptions](pdfoptimizationoptions)() | Sets up default values of MaxResolution option to 300 and ImageQuality option to 100 |

## Properties

| 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) { getset; } | 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) { getset; } | 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) { getset; } | Optimizes output PDF for online browsing with a web browser. |
| [MaxResolution](../../groupdocs.viewer.options/pdfoptimizationoptions/maxresolution) { getset; } | 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) { getset; } | Optimize Excel spreadsheets border lines and fonts for smaller output file size. |
| [RemoveAnnotations](../../groupdocs.viewer.options/pdfoptimizationoptions/removeannotations) { getset; } | 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) { getset; } | If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields. |
| [ResizeImages](../../groupdocs.viewer.options/pdfoptimizationoptions/resizeimages) { getset; } | 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) { getset; } | 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);
}
```

### See Also

* namespace [GroupDocs.Viewer.Options](../../groupdocs.viewer.options)
* assembly [GroupDocs.Viewer](../../)

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Viewer.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
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.
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.

```csharp
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);
}
```

### See Also

* class [PdfOptimizationOptions](../../pdfoptimizationoptions)
* namespace [GroupDocs.Viewer.Options](../../pdfoptimizationoptions)
* assembly [GroupDocs.Viewer](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Viewer.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
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.
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.

```csharp
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);
}
```

### See Also

* class [PdfOptimizationOptions](../../pdfoptimizationoptions)
* namespace [GroupDocs.Viewer.Options](../../pdfoptimizationoptions)
* assembly [GroupDocs.Viewer](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Viewer.dll -->
Loading

0 comments on commit 6d1d5e8

Please sign in to comment.