Skip to content

Commit

Permalink
Update content 2024-03-04 08:24:05
Browse files Browse the repository at this point in the history
  • Loading branch information
yevgen-nykytenko committed Mar 4, 2024
1 parent 6b92ede commit 1040bc3
Show file tree
Hide file tree
Showing 8 changed files with 498 additions and 14 deletions.
25 changes: 25 additions & 0 deletions english/java/com.groupdocs.viewer.options/cadoptions/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ Example usage:
| [getWidth()](#getWidth--) | Gets the width of the output result in pixels. |
| [getHeight()](#getHeight--) | Gets the height of the output result in pixels. |
| [getBackgroundColor()](#getBackgroundColor--) | Gets the background color of the image. |
| [getBackgroundColorAsHex()](#getBackgroundColorAsHex--) | Gets the background color of the image. |
| [setBackgroundColor(Color backgroundColor)](#setBackgroundColor-java.awt.Color-) | Sets the background color of the image. |
| [setBackgroundColor(String colorName)](#setBackgroundColor-java.lang.String-) | Sets the background color of the image. |
| [getTiles()](#getTiles--) | Gets the drawing regions to render. |
| [setTiles(List<Tile> value)](#setTiles-java.util.List-com.groupdocs.viewer.options.Tile--) | Sets the drawing regions to render. |
| [isRenderLayouts()](#isRenderLayouts--) | Indicates whether layouts from the CAD document should be rendered. |
Expand Down Expand Up @@ -205,6 +207,16 @@ Gets the background color of the image.

**Returns:**
java.awt.Color - the background color of the image.
### getBackgroundColorAsHex() {#getBackgroundColorAsHex--}
```
public String getBackgroundColorAsHex()
```


Gets the background color of the image.

**Returns:**
java.lang.String - the background color of the image in 0xFFFFFF format.
### setBackgroundColor(Color backgroundColor) {#setBackgroundColor-java.awt.Color-}
```
public void setBackgroundColor(Color backgroundColor)
Expand All @@ -218,6 +230,19 @@ Sets the background color of the image.
| --- | --- | --- |
| backgroundColor | java.awt.Color | The background color of the image. |

### setBackgroundColor(String colorName) {#setBackgroundColor-java.lang.String-}
```
public void setBackgroundColor(String colorName)
```


Sets the background color of the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| colorName | java.lang.String | The background color name of the image. |

### getTiles() {#getTiles--}
```
public final List<Tile> getTiles()
Expand Down
29 changes: 29 additions & 0 deletions english/java/com.groupdocs.viewer.options/emailoptions/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ Example usage:
| [getDateTimeFormat()](#getDateTimeFormat--) | Gets the time format for the date and time values. |
| [setDateTimeFormat(String dateTimeFormat)](#setDateTimeFormat-java.lang.String-) | Gets the time format for the date and time values. |
| [getTimeZoneOffset()](#getTimeZoneOffset--) | Gets the time zone offset for the message. |
| [getTimeZoneOffsetMinutes()](#getTimeZoneOffsetMinutes--) | Gets the time zone minutes offset minutes for the message. |
| [setTimeZoneOffset(TimeZone timeZoneOffset)](#setTimeZoneOffset-java.util.TimeZone-) | Gets the time zone offset for the message. |
| [setTimeZoneOffset(int offsetMinutes)](#setTimeZoneOffset-int-) | Gets the time zone offset minutes offset for the message. |
| [getPageSize()](#getPageSize--) | Gets the size of the output page. |
| [setPageSize(PageSize value)](#setPageSize-com.groupdocs.viewer.options.PageSize-) | Gets the size of the output page. |
| [getFieldTextMap()](#getFieldTextMap--) | Retrieves the mapping between email message fields and their text representations. |
Expand Down Expand Up @@ -101,6 +103,18 @@ Gets the time zone offset for the message.

**Returns:**
java.util.TimeZone - the time zone offset.
### getTimeZoneOffsetMinutes() {#getTimeZoneOffsetMinutes--}
```
public int getTimeZoneOffsetMinutes()
```


Gets the time zone minutes offset minutes for the message.

**Note:** The time zone offset minutes represents the minutes difference between the message's time and Coordinated Universal Time (UTC).

**Returns:**
int - the time zone offset.
### setTimeZoneOffset(TimeZone timeZoneOffset) {#setTimeZoneOffset-java.util.TimeZone-}
```
public void setTimeZoneOffset(TimeZone timeZoneOffset)
Expand All @@ -116,6 +130,21 @@ Gets the time zone offset for the message.
| --- | --- | --- |
| timeZoneOffset | java.util.TimeZone | The time zone offset. |

### setTimeZoneOffset(int offsetMinutes) {#setTimeZoneOffset-int-}
```
public void setTimeZoneOffset(int offsetMinutes)
```


Gets the time zone offset minutes offset for the message.

**Note:** The time zone minutes offset represents the time difference between the message's time and Coordinated Universal Time (UTC).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| offsetMinutes | int | The time zone offset. |

### getPageSize() {#getPageSize--}
```
public final PageSize getPageSize()
Expand Down
60 changes: 54 additions & 6 deletions english/java/com.groupdocs.viewer.options/htmlviewoptions/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ Example usage:
| [setRenderResponsive(boolean value)](#setRenderResponsive-boolean-) | Sets whether responsive rendering is enabled. |
| [isMinify()](#isMinify--) | Checks if HTML content and HTML resources minification is enabled. |
| [setMinify(boolean value)](#setMinify-boolean-) | Sets whether HTML content and HTML resources minification is enabled. |
| [setRenderToSinglePage(boolean renderSinglePage)](#setRenderToSinglePage-boolean-) | Sets whether HTML content will be rendered to a single page. |
| [isRenderToSinglePage()](#isRenderToSinglePage--) | Determines whether HTML content will be rendered to a single page. |
| [setRenderToSinglePage(boolean renderSinglePage)](#setRenderToSinglePage-boolean-) | Enables rendering an entire document to one HTML file. |
| [isRenderToSinglePage()](#isRenderToSinglePage--) | Enables rendering an entire document to one HTML file. |
| [isExcludeFonts()](#isExcludeFonts--) | Determines whether to exclude fonts from the HTML document. |
| [setExcludeFonts(boolean value)](#setExcludeFonts-boolean-) | Sets whether to exclude fonts from the HTML document. |
| [getFontsToExclude()](#getFontsToExclude--) | Retrieves the list of font names to exclude from the HTML document. |
Expand Down Expand Up @@ -416,23 +416,71 @@ public void setRenderToSinglePage(boolean renderSinglePage)
```


Sets whether HTML content will be rendered to a single page.
Enables rendering an entire document to one HTML file.

**See the following topics for more information:**

* [Render archives as HTML, PDF, and image files][Render archives as HTML_ PDF_ and image files]
* [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
* [Render web documents as PDF, PNG, and JPEG files][Render web documents as PDF_ PNG_ and JPEG files]

**Example:**

```
try (final Viewer viewer = new Viewer("invoice.docx")) {
HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
viewOptions.setRenderToSinglePage(true);
viewer.view(viewOptions);
}
```


[Render archives as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-archive-files/#create-a-single-html-page
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/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/java/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/java/render-web-documents/#create-an-html-file-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderSinglePage | boolean | true if HTML content should be rendered to a single page, false otherwise. |
| renderSinglePage | boolean | |

### isRenderToSinglePage() {#isRenderToSinglePage--}
```
public boolean isRenderToSinglePage()
```


Determines whether HTML content will be rendered to a single page.
Enables rendering an entire document to one HTML file.

**See the following topics for more information:**

* [Render archives as HTML, PDF, and image files][Render archives as HTML_ PDF_ and image files]
* [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
* [Render web documents as PDF, PNG, and JPEG files][Render web documents as PDF_ PNG_ and JPEG files]

**Example:**

```
try (final Viewer viewer = new Viewer("invoice.docx")) {
HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
viewOptions.setRenderToSinglePage(true);
viewer.view(viewOptions);
}
```


[Render archives as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-archive-files/#create-a-single-html-page
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/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/java/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/java/render-web-documents/#create-an-html-file-with-embedded-resources

**Returns:**
boolean - true if HTML content will be rendered to a single page, false otherwise.
boolean
### isExcludeFonts() {#isExcludeFonts--}
```
public final boolean isExcludeFonts()
Expand Down
133 changes: 125 additions & 8 deletions english/java/com.groupdocs.viewer.options/loadoptions/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ Example usage:
| [setFileType(FileType value)](#setFileType-com.groupdocs.viewer.FileType-) | Sets the type of the file to open. |
| [getPassword()](#getPassword--) | Gets the password for opening an encrypted file. |
| [setPassword(String value)](#setPassword-java.lang.String-) | Sets the password for opening an encrypted file. |
| [getCharset()](#getCharset--) | Gets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). |
| [setCharset(Charset value)](#setCharset-java.nio.charset.Charset-) | Sets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). |
| [getCharset()](#getCharset--) | The charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). |
| [setCharset(Charset value)](#setCharset-java.nio.charset.Charset-) | The charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG). |
| [isDetectCharset()](#isDetectCharset--) | This option enables [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), [FileType.TSV](../../com.groupdocs.viewer/filetype\#TSV), and [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV) files charset detection. |
| [setDetectCharset(boolean detectCharset)](#setDetectCharset-boolean-) | This option enables [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), [FileType.TSV](../../com.groupdocs.viewer/filetype\#TSV), and [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV) files charset detection. |
| [getResourceLoadingTimeout()](#getResourceLoadingTimeout--) | Gets the timeout for loading external resources, such as graphics. |
| [setResourceLoadingTimeout(int resourceLoadingTimeout)](#setResourceLoadingTimeout-int-) | Sets the timeout for loading external resources, such as graphics. |
| [getUrlConnectTimeout()](#getUrlConnectTimeout--) | Gets the connection timeout for creating a [Viewer](../../com.groupdocs.viewer/viewer) using java.net.URL to load a document. |
Expand Down Expand Up @@ -145,26 +147,141 @@ public final Charset getCharset()
```


Gets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG).
The charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG).

***Note:** The default value is Charset\#defaultCharset().defaultCharset().*
Default value is java.nio.charset.StandardCharsets\#UTF\_8.UTF\_8.

**Learn more**

* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
* [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
* [Render email messages as HTML, PDF, PNG, and JPEG files][Render email messages as HTML_ PDF_ PNG_ and JPEG files]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset
try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
viewer.view(viewOptions);
}
```


[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files
[Render email messages as HTML_ PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Returns:**
java.nio.charset.Charset - the charset used for opening text-based files or email messages.
java.nio.charset.Charset
### setCharset(Charset value) {#setCharset-java.nio.charset.Charset-}
```
public final void setCharset(Charset value)
```


Sets the charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG).
The charset used when opening text-based files or email messages such as [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV), [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), and [FileType.MSG](../../com.groupdocs.viewer/filetype\#MSG).

Default value is java.nio.charset.StandardCharsets\#UTF\_8.UTF\_8.

**Learn more**

* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
* [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
* [Render email messages as HTML, PDF, PNG, and JPEG files][Render email messages as HTML_ PDF_ PNG_ and JPEG files]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset
try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
viewer.view(viewOptions);
}
```


[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files
[Render email messages as HTML_ PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset | |

### isDetectCharset() {#isDetectCharset--}
```
public boolean isDetectCharset()
```


This option enables [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), [FileType.TSV](../../com.groupdocs.viewer/filetype\#TSV), and [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV) files charset detection. In case the charset can't be detected the default [getCharset()](../../com.groupdocs.viewer.options/loadoptions\#getCharset--) is used.

**Learn more about rendering text and tab/comma delimited files**

* [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
loadOptions.setDetectCharset(true); // Enable encoding detection
try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
viewer.view(viewOptions);
}
```


[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/

**Returns:**
boolean
### setDetectCharset(boolean detectCharset) {#setDetectCharset-boolean-}
```
public void setDetectCharset(boolean detectCharset)
```


This option enables [FileType.TXT](../../com.groupdocs.viewer/filetype\#TXT), [FileType.TSV](../../com.groupdocs.viewer/filetype\#TSV), and [FileType.CSV](../../com.groupdocs.viewer/filetype\#CSV) files charset detection. In case the charset can't be detected the default [getCharset()](../../com.groupdocs.viewer.options/loadoptions\#getCharset--) is used.

**Learn more about rendering text and tab/comma delimited files**

* [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
* [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
loadOptions.setDetectCharset(true); // Enable encoding detection
try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
viewer.view(viewOptions);
}
```


***Note:** The default value is Charset\#defaultCharset().defaultCharset().*
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset | The charset used for opening text-based files or email messages. |
| detectCharset | boolean | |

### getResourceLoadingTimeout() {#getResourceLoadingTimeout--}
```
Expand Down
Loading

0 comments on commit 1040bc3

Please sign in to comment.