blob: 06cee5252dde8fd90c2eb5aef5facf708ee5cec2 [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class PrintToPDFCommandSettings </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PrintToPDFCommandSettings ">
<meta name="description" content="Print page as PDF.">
<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="docfx:docurl" content="https://github.com/SeleniumHQ/selenium/new/docfix/apiSpec/new?filename=OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.svg" alt="Selenium .NET API">
Selenium .NET API
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings">
<h1 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings" class="text-break">
Class PrintToPDFCommandSettings <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="OpenQA.html">OpenQA</a>.<a class="xref" href="OpenQA.Selenium.html">Selenium</a>.<a class="xref" href="OpenQA.Selenium.DevTools.html">DevTools</a>.<a class="xref" href="OpenQA.Selenium.DevTools.V148.html">V148</a>.<a class="xref" href="OpenQA.Selenium.DevTools.V148.Page.html">Page</a></dd></dl>
<dl><dt>Assembly</dt><dd>Selenium.WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Print page as PDF.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class PrintToPDFCommandSettings : ICommand</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">PrintToPDFCommandSettings</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="OpenQA.Selenium.DevTools.ICommand.html">ICommand</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
</dd></dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_CommandName_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.CommandName*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_CommandName" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.CommandName">
CommandName
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L19"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the name of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonIgnore]
public string CommandName { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_DisplayHeaderFooter_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.DisplayHeaderFooter*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_DisplayHeaderFooter" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.DisplayHeaderFooter">
DisplayHeaderFooter
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L32"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Display header and footer. Defaults to false.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;displayHeaderFooter&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? DisplayHeaderFooter { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_FooterTemplate_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.FooterTemplate*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_FooterTemplate" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.FooterTemplate">
FooterTemplate
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L124"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>HTML template for the print footer. Should use the same format as the <code>headerTemplate</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;footerTemplate&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? FooterTemplate { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_GenerateDocumentOutline_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.GenerateDocumentOutline*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_GenerateDocumentOutline" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.GenerateDocumentOutline">
GenerateDocumentOutline
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L153"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Whether or not to embed the document outline into the PDF.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;generateDocumentOutline&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? GenerateDocumentOutline { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_GenerateTaggedPDF_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.GenerateTaggedPDF*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_GenerateTaggedPDF" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.GenerateTaggedPDF">
GenerateTaggedPDF
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L146"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;generateTaggedPDF&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? GenerateTaggedPDF { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_HeaderTemplate_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.HeaderTemplate*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_HeaderTemplate" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.HeaderTemplate">
HeaderTemplate
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L117"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>HTML template for the print header. Should be valid HTML markup with following
classes used to inject printing values into them:</p>
<ul>
<li><code>date</code>: formatted print date</li>
<li><code>title</code>: document title</li>
<li><code>url</code>: document location</li>
<li><code>pageNumber</code>: current page number</li>
<li><code>totalPages</code>: total pages in the document</li>
</ul>
<p>For example, <code>&lt;span class=title&gt;&lt;/span&gt;</code> would generate span containing the title.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;headerTemplate&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? HeaderTemplate { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_Landscape_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.Landscape*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_Landscape" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.Landscape">
Landscape
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L25"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Paper orientation. Defaults to false.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;landscape&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? Landscape { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginBottom_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginBottom*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginBottom" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginBottom">
MarginBottom
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L74"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Bottom margin in inches. Defaults to 1cm (~0.4 inches).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;marginBottom&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? MarginBottom { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginLeft_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginLeft*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginLeft" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginLeft">
MarginLeft
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L81"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Left margin in inches. Defaults to 1cm (~0.4 inches).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;marginLeft&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? MarginLeft { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginRight_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginRight*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginRight" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginRight">
MarginRight
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L88"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Right margin in inches. Defaults to 1cm (~0.4 inches).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;marginRight&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? MarginRight { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginTop_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginTop*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_MarginTop" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.MarginTop">
MarginTop
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L67"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Top margin in inches. Defaults to 1cm (~0.4 inches).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;marginTop&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? MarginTop { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PageRanges_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PageRanges*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PageRanges" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PageRanges">
PageRanges
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L102"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are
printed in the document order, not in the order specified, and no
more than once.
Defaults to empty string, which implies the entire document is printed.
The page numbers are quietly capped to actual page count of the
document, and ranges beyond the end of the document are ignored.
If this results in no pages to print, an error is reported.
It is an error to specify a range with start greater than end.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;pageRanges&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? PageRanges { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PaperHeight_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PaperHeight*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PaperHeight" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PaperHeight">
PaperHeight
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L60"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Paper height in inches. Defaults to 11 inches.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;paperHeight&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? PaperHeight { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PaperWidth_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PaperWidth*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PaperWidth" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PaperWidth">
PaperWidth
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L53"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Paper width in inches. Defaults to 8.5 inches.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;paperWidth&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? PaperWidth { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PreferCSSPageSize_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PreferCSSPageSize*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PreferCSSPageSize" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PreferCSSPageSize">
PreferCSSPageSize
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L132"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Whether or not to prefer page size as defined by css. Defaults to false,
in which case the content will be scaled to fit the paper size.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;preferCSSPageSize&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? PreferCSSPageSize { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PrintBackground_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PrintBackground*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_PrintBackground" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.PrintBackground">
PrintBackground
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L39"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Print background graphics. Defaults to false.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;printBackground&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? PrintBackground { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_Scale_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.Scale*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_Scale" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.Scale">
Scale
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L46"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Scale of the webpage rendering. Defaults to 1.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;scale&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? Scale { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>?</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_TransferMode_" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.TransferMode*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Page_PrintToPDFCommandSettings_TransferMode" data-uid="OpenQA.Selenium.DevTools.V148.Page.PrintToPDFCommandSettings.TransferMode">
TransferMode
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L139"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>return as stream</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;transferMode&quot;)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? TransferMode { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Page/PrintToPDFCommand.cs/#L12" class="edit-link">Edit this page</a>
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>