# WebConvertParams Class

> Parameters controlling Document::from_web_url and Document::from_html_file.

- Product: Adobe PDF Library 21
- Language: Modern C++
- Version: 21.4.0
- HTML page: https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/WebConvertParams
- Version index: https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/llms.txt

```cpp
class WebConvertParams
```

**Namespace:** `datalogics_interface`

## Description

Parameters controlling Document::from_web_url and Document::from_html_file. Plain value type. Safe to construct and pass by reference. Parameters that control web/HTML-to-PDF conversion. Configure the target page geometry, viewport, image handling, and behavior on this object, then pass it to a web-to-PDF conversion call. The enum-valued settings (viewport preset, page size, page orientation, image compression, and downsampling resolution) take named values rather than raw integers. Safe to construct and configure on any platform; conversion itself runs only where the WebToPDF plugin is supported.

**Uses types:** [`WebDownsamplingDPI`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebDownsamplingDPI.md), [`WebImageCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebImageCompression.md), [`WebPageOrientation`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebPageOrientation.md), [`WebPageSize`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebPageSize.md), [`WebViewportPreset`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebViewportPreset.md)

## Constructors

### WebConvertParams

```cpp
datalogics_interface::WebConvertParams::WebConvertParams()
```

*constructor*

### WebConvertParams

```cpp
datalogics_interface::WebConvertParams::WebConvertParams(const WebConvertParams &)
```

*constructor*

**Parameters**

- (unnamed) ([`const WebConvertParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/WebConvertParams.md))

### WebConvertParams

```cpp
datalogics_interface::WebConvertParams::WebConvertParams(WebConvertParams &&) noexcept
```

*constructor*

**Parameters**

- (unnamed) ([`WebConvertParams &&`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/WebConvertParams.md))

### ~WebConvertParams

```cpp
datalogics_interface::WebConvertParams::~WebConvertParams()
```

*destructor*

## Methods

### get_display_header_footer

```cpp
bool datalogics_interface::WebConvertParams::get_display_header_footer() const
```

**Returns:** `bool`

Show default browser-style header/footer.

### get_downsampling_dpi

```cpp
WebDownsamplingDPI datalogics_interface::WebConvertParams::get_downsampling_dpi() const
```

**Returns:** [`WebDownsamplingDPI`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebDownsamplingDPI.md)

### get_enable_verbose_logging

```cpp
bool datalogics_interface::WebConvertParams::get_enable_verbose_logging() const
```

**Returns:** `bool`

Emit debug-level log messages.

### get_generate_tagged_pdf

```cpp
bool datalogics_interface::WebConvertParams::get_generate_tagged_pdf() const
```

**Returns:** `bool`

Produce a tagged (accessible) PDF.

### get_image_compression

```cpp
WebImageCompression datalogics_interface::WebConvertParams::get_image_compression() const
```

**Returns:** [`WebImageCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebImageCompression.md)

### get_margin_bottom_inches

```cpp
double datalogics_interface::WebConvertParams::get_margin_bottom_inches() const
```

**Returns:** `double`

### get_margin_left_inches

```cpp
double datalogics_interface::WebConvertParams::get_margin_left_inches() const
```

**Returns:** `double`

### get_margin_right_inches

```cpp
double datalogics_interface::WebConvertParams::get_margin_right_inches() const
```

**Returns:** `double`

### get_margin_top_inches

```cpp
double datalogics_interface::WebConvertParams::get_margin_top_inches() const
```

**Returns:** `double`

### get_page_height_points

```cpp
double datalogics_interface::WebConvertParams::get_page_height_points() const
```

**Returns:** `double`

### get_page_orientation

```cpp
WebPageOrientation datalogics_interface::WebConvertParams::get_page_orientation() const
```

**Returns:** [`WebPageOrientation`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebPageOrientation.md)

### get_page_size

```cpp
WebPageSize datalogics_interface::WebConvertParams::get_page_size() const
```

**Returns:** [`WebPageSize`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebPageSize.md)

### get_page_width_points

```cpp
double datalogics_interface::WebConvertParams::get_page_width_points() const
```

**Returns:** `double`

Used when size == Custom. 1 pt = 1/72 in.

### get_print_background

```cpp
bool datalogics_interface::WebConvertParams::get_print_background() const
```

**Returns:** `bool`

Print CSS background colors and images.

### get_scale

```cpp
double datalogics_interface::WebConvertParams::get_scale() const
```

**Returns:** `double`

Content scale factor (1.0 = 100%).

### get_timeout_seconds

```cpp
int datalogics_interface::WebConvertParams::get_timeout_seconds() const
```

**Returns:** `int`

Conversion timeout. Sentinels match the plugin: `0` = use the plugin default (300s), `-1` = infinite, positive values = explicit seconds.

### get_viewport_height_px

```cpp
int datalogics_interface::WebConvertParams::get_viewport_height_px() const
```

**Returns:** `int`

### get_viewport_preset

```cpp
WebViewportPreset datalogics_interface::WebConvertParams::get_viewport_preset() const
```

**Returns:** [`WebViewportPreset`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebViewportPreset.md)

### get_viewport_width_px

```cpp
int datalogics_interface::WebConvertParams::get_viewport_width_px() const
```

**Returns:** `int`

Used when preset == Custom.

### operator=

```cpp
WebConvertParams & datalogics_interface::WebConvertParams::operator=(const WebConvertParams &)
```

**Parameters**

- (unnamed) ([`const WebConvertParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/WebConvertParams.md))

**Returns:** [`WebConvertParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/WebConvertParams.md)

### operator=

```cpp
WebConvertParams & datalogics_interface::WebConvertParams::operator=(WebConvertParams &&) noexcept
```

**Parameters**

- (unnamed) ([`WebConvertParams &&`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/WebConvertParams.md))

**Returns:** [`WebConvertParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/WebConvertParams.md)

### set_display_header_footer

```cpp
void datalogics_interface::WebConvertParams::set_display_header_footer(bool value)
```

**Parameters**

- `value` (`bool`)

**Returns:** `void`

### set_downsampling_dpi

```cpp
void datalogics_interface::WebConvertParams::set_downsampling_dpi(WebDownsamplingDPI dpi)
```

**Parameters**

- `dpi` ([`WebDownsamplingDPI`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebDownsamplingDPI.md))

**Returns:** `void`

### set_enable_verbose_logging

```cpp
void datalogics_interface::WebConvertParams::set_enable_verbose_logging(bool value)
```

**Parameters**

- `value` (`bool`)

**Returns:** `void`

### set_generate_tagged_pdf

```cpp
void datalogics_interface::WebConvertParams::set_generate_tagged_pdf(bool value)
```

**Parameters**

- `value` (`bool`)

**Returns:** `void`

### set_image_compression

```cpp
void datalogics_interface::WebConvertParams::set_image_compression(WebImageCompression c)
```

**Parameters**

- `c` ([`WebImageCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebImageCompression.md))

**Returns:** `void`

### set_log_callback

```cpp
void datalogics_interface::WebConvertParams::set_log_callback(LogCallback cb)
```

**Parameters**

- `cb` (`LogCallback`)

**Returns:** `void`

### set_margins_inches

```cpp
void datalogics_interface::WebConvertParams::set_margins_inches(double top, double right, double bottom, double left)
```

**Parameters**

- `top` (`double`)
- `right` (`double`)
- `bottom` (`double`)
- `left` (`double`)

**Returns:** `void`

### set_page_height_points

```cpp
void datalogics_interface::WebConvertParams::set_page_height_points(double h)
```

**Parameters**

- `h` (`double`)

**Returns:** `void`

### set_page_orientation

```cpp
void datalogics_interface::WebConvertParams::set_page_orientation(WebPageOrientation o)
```

**Parameters**

- `o` ([`WebPageOrientation`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebPageOrientation.md))

**Returns:** `void`

### set_page_size

```cpp
void datalogics_interface::WebConvertParams::set_page_size(WebPageSize size)
```

**Parameters**

- `size` ([`WebPageSize`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebPageSize.md))

**Returns:** `void`

### set_page_width_points

```cpp
void datalogics_interface::WebConvertParams::set_page_width_points(double w)
```

**Parameters**

- `w` (`double`)

**Returns:** `void`

### set_prefer_css_page_size

```cpp
void datalogics_interface::WebConvertParams::set_prefer_css_page_size(bool value)
```

**Parameters**

- `value` (`bool`)

**Returns:** `void`

### set_print_background

```cpp
void datalogics_interface::WebConvertParams::set_print_background(bool value)
```

**Parameters**

- `value` (`bool`)

**Returns:** `void`

### set_progress_callback

```cpp
void datalogics_interface::WebConvertParams::set_progress_callback(ProgressCallback cb)
```

**Parameters**

- `cb` (`ProgressCallback`)

**Returns:** `void`

### set_scale

```cpp
void datalogics_interface::WebConvertParams::set_scale(double value)
```

**Parameters**

- `value` (`double`)

**Returns:** `void`

### set_timeout_seconds

```cpp
void datalogics_interface::WebConvertParams::set_timeout_seconds(int seconds)
```

**Parameters**

- `seconds` (`int`)

**Returns:** `void`

### set_viewport_height_px

```cpp
void datalogics_interface::WebConvertParams::set_viewport_height_px(int px)
```

**Parameters**

- `px` (`int`)

**Returns:** `void`

### set_viewport_preset

```cpp
void datalogics_interface::WebConvertParams::set_viewport_preset(WebViewportPreset preset)
```

**Parameters**

- `preset` ([`WebViewportPreset`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/WebViewportPreset.md))

**Returns:** `void`

### set_viewport_width_px

```cpp
void datalogics_interface::WebConvertParams::set_viewport_width_px(int px)
```

**Parameters**

- `px` (`int`)

**Returns:** `void`