Skip to content

Commit

Permalink
Update content 2023-10-05 08:36:56
Browse files Browse the repository at this point in the history
  • Loading branch information
yevgen-nykytenko committed Oct 5, 2023
1 parent 0cf7e69 commit e4a153b
Show file tree
Hide file tree
Showing 21 changed files with 189 additions and 18 deletions.
4 changes: 3 additions & 1 deletion english/net/groupdocs.viewer.options/loadoptions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ public class LoadOptions
| [Encoding](../../groupdocs.viewer.options/loadoptions/encoding) { getset; } | 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) { getset; } | The type of the file to open. |
| [Password](../../groupdocs.viewer.options/loadoptions/password) { getset; } | The password for opening encrypted file. |
| [ResourceLoadingTimeout](../../groupdocs.viewer.options/loadoptions/resourceloadingtimeout) { getset; } | The external resources e.g. graphics loading timeout. The default value is 30 seconds. This option is supported for Word Processing documents that contain external resources. |
| [ResourceLoadingTimeout](../../groupdocs.viewer.options/loadoptions/resourceloadingtimeout) { getset; } | The external resources e.g. graphics loading timeout. The default value is 30 seconds. |
| [SkipExternalResources](../../groupdocs.viewer.options/loadoptions/skipexternalresources) { getset; } | When set to `true` all external resource such as images will not be loaded except [`WhitelistedResources`](./whitelistedresources). |
| [WhitelistedResources](../../groupdocs.viewer.options/loadoptions/whitelistedresources) { getset; } | The list of URL fragments corresponding to external resources that should be loaded when [`SkipExternalResources`](./skipexternalresources) is set to `true`. |

### See Also

Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,48 @@
---
title: ResourceLoadingTimeout
second_title: GroupDocs.Viewer for .NET API Reference
description: The external resources e.g. graphics loading timeout. The default value is 30 seconds. This option is supported for Word Processing documents that contain external resources.
description: The external resources e.g. graphics loading timeout. The default value is 30 seconds.
type: docs
weight: 60
url: /net/groupdocs.viewer.options/loadoptions/resourceloadingtimeout/
---
## LoadOptions.ResourceLoadingTimeout property

The external resources e.g. graphics loading timeout. The default value is 30 seconds. This option is supported for Word Processing documents that contain external resources.
The external resources e.g. graphics loading timeout. The default value is 30 seconds.

```csharp
public TimeSpan ResourceLoadingTimeout { get; set; }
```

### Remarks

**This option is supported when rendering the following file formats:**

* Word processing - DOCX, DOC, etc.
* Spreadsheet - XLSX, XLS, etc.
* Web - HTML, HTM, etc.

**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(3); // Set resource loading timeout to 3 seconds
using (Viewer viewer = new Viewer("business-flyer.docx", loadOptions))
{
HtmlViewOptions viewOptions =
HtmlViewOptions.ForEmbeddedResources();

viewer.View(viewOptions);
}
```

### See Also

* class [LoadOptions](../../loadoptions)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
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.
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).

```csharp
public bool SkipExternalResources { get; set; }
```

### Remarks

**This option is supported when rendering the following file formats:**

* Word processing - DOCX, DOC, etc.
* Spreadsheet - XLSX, XLS, etc.
* Web - HTML, HTM, etc.
* Presentation - PPTX, PPT, etc.

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

### See Also

* class [LoadOptions](../../loadoptions)
* namespace [GroupDocs.Viewer.Options](../../loadoptions)
* 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,53 @@
---
title: WhitelistedResources
second_title: GroupDocs.Viewer for .NET API Reference
description: The list of URL fragments corresponding to external resources that should be loaded when SkipExternalResourcesgroupdocs.viewer.options/loadoptions/skipexternalresources is set to true.
type: docs
weight: 80
url: /net/groupdocs.viewer.options/loadoptions/whitelistedresources/
---
## LoadOptions.WhitelistedResources property

The list of URL fragments corresponding to external resources that should be loaded when [`SkipExternalResources`](../skipexternalresources) is set to `true`.

```csharp
public List<string> WhitelistedResources { get; set; }
```

### Remarks

**This option is supported when rendering the following file formats:**

* Word processing - DOCX, DOC, etc.
* Spreadsheet - XLSX, XLS, etc.
* Web - HTML, HTM, etc.
* Presentation - PPTX, PPT, etc.

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

### See Also

* class [LoadOptions](../../loadoptions)
* namespace [GroupDocs.Viewer.Options](../../loadoptions)
* assembly [GroupDocs.Viewer](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Viewer.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ public class SpreadsheetOptions
| 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. |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
type: docs
weight: 50
weight: 60
url: /net/groupdocs.viewer.options/spreadsheetoptions/bottommargin/
---
## SpreadsheetOptions.BottomMargin property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CountColumnsPerPage
second_title: GroupDocs.Viewer for .NET API Reference
description: The columns count to include into each page when splitting worksheet into pages.
type: docs
weight: 60
weight: 70
url: /net/groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage/
---
## SpreadsheetOptions.CountColumnsPerPage property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CountRowsPerPage
second_title: GroupDocs.Viewer for .NET API Reference
description: The rows count to include into each page when splitting worksheet into pages.
type: docs
weight: 70
weight: 80
url: /net/groupdocs.viewer.options/spreadsheetoptions/countrowsperpage/
---
## SpreadsheetOptions.CountRowsPerPage property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: DetectSeparator
second_title: GroupDocs.Viewer for .NET API Reference
description: Detect separator for CSV/TSV files.
type: docs
weight: 80
weight: 90
url: /net/groupdocs.viewer.options/spreadsheetoptions/detectseparator/
---
## SpreadsheetOptions.DetectSeparator property
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
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.
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.

```csharp
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.

### 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/)

### See Also

* class [SpreadsheetOptions](../../spreadsheetoptions)
* namespace [GroupDocs.Viewer.Options](../../spreadsheetoptions)
* assembly [GroupDocs.Viewer](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Viewer.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ForSplitSheetIntoPages
second_title: GroupDocs.Viewer for .NET API Reference
description: Initializes new instance of SpreadsheetOptionsgroupdocs.viewer.options/spreadsheetoptions for rendering sheet into pages.
type: docs
weight: 40
weight: 50
url: /net/groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages/
---
## ForSplitSheetIntoPages(int) {#forsplitsheetintopages}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
type: docs
weight: 90
weight: 100
url: /net/groupdocs.viewer.options/spreadsheetoptions/leftmargin/
---
## SpreadsheetOptions.LeftMargin property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: RenderGridLines
second_title: GroupDocs.Viewer for .NET API Reference
description: Enables grid lines rendering.
type: docs
weight: 100
weight: 110
url: /net/groupdocs.viewer.options/spreadsheetoptions/rendergridlines/
---
## SpreadsheetOptions.RenderGridLines property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: RenderHeadings
second_title: GroupDocs.Viewer for .NET API Reference
description: Enables headings rendering.
type: docs
weight: 110
weight: 120
url: /net/groupdocs.viewer.options/spreadsheetoptions/renderheadings/
---
## SpreadsheetOptions.RenderHeadings property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: RenderHiddenColumns
second_title: GroupDocs.Viewer for .NET API Reference
description: Enables hidden columns rendering.
type: docs
weight: 120
weight: 130
url: /net/groupdocs.viewer.options/spreadsheetoptions/renderhiddencolumns/
---
## SpreadsheetOptions.RenderHiddenColumns property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: RenderHiddenRows
second_title: GroupDocs.Viewer for .NET API Reference
description: Enables hidden rows rendering.
type: docs
weight: 130
weight: 140
url: /net/groupdocs.viewer.options/spreadsheetoptions/renderhiddenrows/
---
## SpreadsheetOptions.RenderHiddenRows property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
type: docs
weight: 140
weight: 150
url: /net/groupdocs.viewer.options/spreadsheetoptions/rightmargin/
---
## SpreadsheetOptions.RightMargin property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: SkipEmptyColumns
second_title: GroupDocs.Viewer for .NET API Reference
description: Disables empty columns rendering.
type: docs
weight: 150
weight: 160
url: /net/groupdocs.viewer.options/spreadsheetoptions/skipemptycolumns/
---
## SpreadsheetOptions.SkipEmptyColumns property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: SkipEmptyRows
second_title: GroupDocs.Viewer for .NET API Reference
description: Disables empty rows rendering.
type: docs
weight: 160
weight: 170
url: /net/groupdocs.viewer.options/spreadsheetoptions/skipemptyrows/
---
## SpreadsheetOptions.SkipEmptyRows property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: TextOverflowMode
second_title: GroupDocs.Viewer for .NET API Reference
description: The text overflow mode for rendering spreadsheet documents into HTML.
type: docs
weight: 170
weight: 180
url: /net/groupdocs.viewer.options/spreadsheetoptions/textoverflowmode/
---
## SpreadsheetOptions.TextOverflowMode property
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
type: docs
weight: 180
weight: 190
url: /net/groupdocs.viewer.options/spreadsheetoptions/topmargin/
---
## SpreadsheetOptions.TopMargin property
Expand Down

0 comments on commit e4a153b

Please sign in to comment.