ExcelToPdfConverter Class

Winnovative Excel to PDF Converter Documentation

This class is the main class of the Excel to PDF Converter which offers the necessary methods to create a PDF document from an Excel file or an Excel stream. The generated PDF document can be saved into a memory buffer or into a file

Inheritance Hierarchy

SystemObject
Winnovative.ExcelToPdfExcelToPdfConverter

Namespace: Winnovative.ExcelToPdf
Assembly: wnvexceltopdf (in wnvexceltopdf.dll) Version: 10.0.0.0

Syntax

C++

Copy

public class ExcelToPdfConverter

Public Class ExcelToPdfConverter

public ref class ExcelToPdfConverter

type ExcelToPdfConverter =  class end

The ExcelToPdfConverter type exposes the following members.

Constructors

	Name	Description
	ExcelToPdfConverter	Creates a Excel to PDF converter using the default settings

Top

Properties

	Name	Description
	LicenseKey	Gets or sets the license key string received from the vendor in Excel to PDF converter. If this property is null the converter will automatically enter in evaluation mode and a demo watermark will be displayed on the generated PDF document.
	PdfConverterConcurrencyLevel	This static parameter gives the maximum number of threads in the current .NET application domain that can convert Excel to PDF simultaneously. This parameter must be set before the first conversion performed in the current application domain. When this property is set with a negative value or zero the concurrency level is maximum. The default value is 4.
	PdfDocumentInfo	Gets a reference to the object to controlling the generated PDF document information like the document title, author, subject or creation date.
	PdfDocumentOptions	Gets a reference to the object controlling the conversion process and the generated PDF document properties. This property can be used to control the PDF document margins, PDF compression level, JPEG compression level, the PDF page size and orientation, the PDF document headers and footers, true type fonts embedding, fit width and stretch to fit, conversion to a single PDF page, append or prepend external PDF documents.
	PdfFooterOptions	Gets a reference to an object to control the generated PDF document footer options. The footer is displayed in the generated PDF document only if the ShowFooter property is true.
	PdfHeaderOptions	Gets a reference to an object to control the generated PDF document header options. The header is displayed in the generated PDF document only if the ShowHeader property is true.
	PdfSecurityOptions	Gets a reference to the object to controlling the generated PDF document security settings like user and owner password, restrict printing or editing of the generated PDF document.
	PdfViewerPreferences	Gets a reference to the object controlling how the generated PDF is displayed by a PDF viewer.
	ShowAllContent	Gets or sets a flag indicating if the cells are resized to show all content. The default value is true

Top

Methods

	Name	Description
	ConvertExcelFile(String)	Converts an Excel file to PDF and returns the rendered PDF document into a memory buffer
	ConvertExcelFile(String, Int32)	Converts an Excel file to PDF and returns the rendered PDF document into a memory buffer. You can specify the list of worksheets to be exported to PDF
	ConvertExcelFile(String, String)	Converts an Excel file to PDF and returns the rendered PDF document into a memory buffer
	ConvertExcelFile(String, String, Int32)	Converts an Excel file to PDF and returns the rendered PDF document into a memory buffer. You can specify the list of worksheets to be exported to PDF
	ConvertExcelFileToFile(String, String)	Converts an Excel file to PDF and writes the rendered PDF document into a file
	ConvertExcelFileToFile(String, Int32, String)	Converts an Excel file to PDF and writes the rendered PDF document into a file. You can specify the list of worksheets to be exported to PDF
	ConvertExcelFileToFile(String, String, String)	Converts an Excel file to PDF and writes the rendered PDF document into a file
	ConvertExcelFileToFile(String, String, Int32, String)	Converts an Excel file to PDF and writes the rendered PDF document into a file. You can specify the password to open the Excel document and the list of worksheets to be exported to PDF
	ConvertExcelFileToPdfDocumentObject(String)	Converts an Excel file to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects
	ConvertExcelFileToPdfDocumentObject(String, Int32)	Converts an Excel file to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects. You can specify the list of worksheets to be exported to PDF
	ConvertExcelFileToPdfDocumentObject(String, String)	Converts an Excel file to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects
	ConvertExcelFileToPdfDocumentObject(String, String, Int32)	Converts an Excel file to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects. You can specify the password to open the Excel document and the list of worksheets to be exported to PDF
	ConvertExcelFileToStream(String, Stream)	Converts an Excel file to PDF and writes the rendered PDF document into a stream
	ConvertExcelFileToStream(String, Int32, Stream)	Converts an Excel file to PDF and writes the rendered PDF document into a stream. You can specify the list of worksheets to be exported to PDF
	ConvertExcelFileToStream(String, String, Stream)	Converts an Excel file to PDF and writes the rendered PDF document into a stream
	ConvertExcelFileToStream(String, String, Int32, Stream)	Converts an Excel file to PDF and writes the rendered PDF document into a stream. You can specify the password to open the Excel document and the list of worksheets to be exported to PDF
	ConvertExcelStream(Stream)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document into a memory buffer
	ConvertExcelStream(Stream, Int32)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document into a memory buffer. You can specify the list of worksheets to be exported to PDF
	ConvertExcelStream(Stream, String)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document into a memory buffer
	ConvertExcelStream(Stream, String, Int32)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document into a memory buffer. You can specify the password to open the Excel File and the list of worksheets to be exported to PDF
	ConvertExcelStreamToFile(Stream, String)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a file
	ConvertExcelStreamToFile(Stream, Int32, String)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a file. You can specify the list of worksheets to be exported to PDF
	ConvertExcelStreamToFile(Stream, String, String)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a file
	ConvertExcelStreamToFile(Stream, String, Int32, String)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a file. You can specify the password to open the Excel document and the list of worksheets to be exported to PDF
	ConvertExcelStreamToPdfDocumentObject(Stream)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects
	ConvertExcelStreamToPdfDocumentObject(Stream, Int32)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects. You can specify the list of worksheets to be exported to PDF
	ConvertExcelStreamToPdfDocumentObject(Stream, String)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects
	ConvertExcelStreamToPdfDocumentObject(Stream, String, Int32)	Converts an Excel document read from a stream to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations requiring this type of objects. You can specify the password to open the Excel document and the list of worksheets to be exported to PDF
	ConvertExcelStreamToStream(Stream, Stream)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a stream
	ConvertExcelStreamToStream(Stream, Int32, Stream)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a stream. You can specify the list of worksheets to be exported to PDF
	ConvertExcelStreamToStream(Stream, String, Stream)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a stream
	ConvertExcelStreamToStream(Stream, String, Int32, Stream)	Converts an Excel document read from a stream to PDF and writes the rendered PDF document into a stream. You can specify the password to open the Excel document and the list of worksheets to be exported to PDF
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetPageCount(Stream)	A fast method to obtain the page count of a PDF document from the specified stream.
	GetPageCount(String)	A fast method to obtain the page count of a PDF document from the specified file path.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	AfterRenderPdfPageEvent	The event is raised right after the Excel to PDF converter finished PDF page rendering. The PDF page configuration like size, orientation, header or footer is already defined and cannot be changed. In the handler of this event PDF elements can be added in the foreground of the rendered PDF page.
	BeforeRenderPdfPageEvent	The event is raised right before the page is rendered by Excel to PDF converter. The PDF page configuration like size, orientation, header or footer is already defined and cannot be changed. In the handler of this event PDF elements can be added in the background of the PDF page to be rendered.
	PrepareRenderPdfPageEvent	The event is raised after the Excel to PDF converter created the PDF page and before starting rendering it. In the handler of this event the PDF page configuration like size, orientation, header or footer can still be changed before starting rendering.

Top

Reference

Winnovative.ExcelToPdf Namespace