Set PDF Viewer Preferences for the Generated PDF Document

Winnovative HTML to PDF Converter for .NET Documentation

Winnovative HTML to PDF Converter allows you to set various PDF viewer preferences to be used when the generated PDF document is displayed in a PDF viewer. You can hide the viewer menu and toolbar, you can instruct the viewer to initially display the bookmarks, thumbnails or attachments and you can select the page layout to one or two columns.

The PDF viewer preferences can be set in HtmlToPdfConverterPdfViewerPreferences object. The most important options are detailed below.

PDF Viewer Preferences

Page Mode. You can use this option to instruct the PDF viewer to initially display the bookmarks panel, thumbnails panel or attachments panel when the generated PDF document is opened. The property you can set in your code for this option is ViewerPreferencesPageMode
Page Layout. You can use this option to set the PDF page layout to continuous one column, single page, two column left, two column right when the generated PDF document is opened. The property you can set in your code for this option is ViewerPreferencesPageLayout
Hide Menu Bar. You can use this option to hide the menu bar of the PDF viewer when the generated PDF document is opened. The property you can set in your code for this option is ViewerPreferencesHideMenuBar
Hide Toolbar. You can use this option to hide the toolbar of the PDF viewer when the generated PDF document is opened. The property you can set in your code for this option is ViewerPreferencesHideToolbar
Hide Window UI. You can use this option to hide the user interface elements (scroll bars, navigation controls) of the PDF viewer when the generated PDF document is opened. The property you can set in your code for this option is ViewerPreferencesHideWindowUI
Display Document Title. You can use this option to display the document title in PDF viewer title bar when the generated PDF document is opened. The property you can set in your code for this option is ViewerPreferencesDisplayDocTitle

Code Sample - Set PDF Viewer Preferences for the Generated PDF Document

Copy

protected void convertToPdfButton_Click(object sender, EventArgs e)
{
    // Create a HTML to PDF converter object with default settings
    HtmlToPdfConverter htmlToPdfConverter = new HtmlToPdfConverter();

    // Set license key received after purchase to use the converter in licensed mode
    // Leave it not set to use the converter in demo mode
    htmlToPdfConverter.LicenseKey = "fvDh8eDx4fHg4P/h8eLg/+Dj/+jo6Og=";

    // Set an adddional delay in seconds to wait for JavaScript or AJAX calls after page load completed
    // Set this property to 0 if you don't need to wait for such asynchcronous operations to finish
    htmlToPdfConverter.ConversionDelay = 2;

    // Set the PDF Viewer Preferences

    // Set page layout to continuous one column, single page, two column left, two column right
    htmlToPdfConverter.PdfViewerPreferences.PageLayout = SelectedPageLayout();
    // Set page mode to default, display bookmarks, display thumbnails, display attachments
    htmlToPdfConverter.PdfViewerPreferences.PageMode = SelectedPageMode();

    // Hide the viewer menu
    htmlToPdfConverter.PdfViewerPreferences.HideMenuBar = hideMenuBarCheckBox.Checked;
    // Hide the viewer toolbar
    htmlToPdfConverter.PdfViewerPreferences.HideToolbar = hideToolbarCheckBox.Checked;
    // Hide scroll bars and navigation controls
    htmlToPdfConverter.PdfViewerPreferences.HideWindowUI = hideWindowUICheckBox.Checked;

    // Display the document title in viewer title bar
    htmlToPdfConverter.PdfViewerPreferences.DisplayDocTitle = displayDocTitleCheckBox.Checked;

    // Convert the HTML page to a PDF document in a memory buffer
    byte[] outPdfBuffer = htmlToPdfConverter.ConvertUrl(urlTextBox.Text);

    // Send the PDF as response to browser

    // Set response content type
    Response.AddHeader("Content-Type", "application/pdf");

    // Instruct the browser to open the PDF file as an attachment or inline
    Response.AddHeader("Content-Disposition", String.Format("attachment; filename=Set_PDF_Viewer_Preferences.pdf; size={0}", outPdfBuffer.Length.ToString()));

    // Write the PDF document buffer to HTTP response
    Response.BinaryWrite(outPdfBuffer);

    // End the HTTP response and stop the current page processing
    Response.End();
}

Protected Sub convertToPdfButton_Click(ByVal sender As Object, ByVal e As EventArgs)
    ' Create a HTML to PDF converter object with default settings
    Dim htmlToPdfConverter As New HtmlToPdfConverter()

    ' Set license key received after purchase to use the converter in licensed mode
    ' Leave it not set to use the converter in demo mode
    htmlToPdfConverter.LicenseKey = "fvDh8eDx4fHg4P/h8eLg/+Dj/+jo6Og="

    ' Set an adddional delay in seconds to wait for JavaScript or AJAX calls after page load completed
    ' Set this property to 0 if you don't need to wait for such asynchcronous operations to finish
    htmlToPdfConverter.ConversionDelay = 2

    ' Set the PDF Viewer Preferences

    ' Set page layout to continuous one column, single page, two column left, two column right
    htmlToPdfConverter.PdfViewerPreferences.PageLayout = SelectedPageLayout()
    ' Set page mode to default, display bookmarks, display thumbnails, display attachments
    htmlToPdfConverter.PdfViewerPreferences.PageMode = SelectedPageMode()

    ' Hide the viewer menu
    htmlToPdfConverter.PdfViewerPreferences.HideMenuBar = hideMenuBarCheckBox.Checked
    ' Hide the viewer toolbar
    htmlToPdfConverter.PdfViewerPreferences.HideToolbar = hideToolbarCheckBox.Checked
    ' Hide scroll bars and navigation controls
    htmlToPdfConverter.PdfViewerPreferences.HideWindowUI = hideWindowUICheckBox.Checked

    ' Display the document title in viewer title bar
    htmlToPdfConverter.PdfViewerPreferences.DisplayDocTitle = displayDocTitleCheckBox.Checked

    ' Convert the HTML page to a PDF document in a memory buffer
    Dim outPdfBuffer() As Byte = htmlToPdfConverter.ConvertUrl(urlTextBox.Text)

    ' Send the PDF as response to browser

    ' Set response content type
    Response.AddHeader("Content-Type", "application/pdf")

    ' Instruct the browser to open the PDF file as an attachment or inline
    Response.AddHeader("Content-Disposition", String.Format("attachment; filename=Set_PDF_Viewer_Preferences.pdf; size={0}", outPdfBuffer.Length.ToString()))

    ' Write the PDF document buffer to HTTP response
    Response.BinaryWrite(outPdfBuffer)

    ' End the HTTP response and stop the current page processing
    Response.End()
End Sub