Winnovative Logo

PdfHeaderOptions Class

Winnovative Client for .NET Core
This class encapsulates the options to control the appearance of the header in the rendered PDF document. The HtmlToPdfConverter class exposes a a reference to an object of this type in PdfHeaderOptions property. If the ShowHeader property of the PdfDocumentOptions object exposed by the PdfDocumentOptions property is false, the header options have no effect.
Inheritance Hierarchy

SystemObject
  WinnovativeClientPdfHeaderOptions

Namespace:  WinnovativeClient
Assembly:  WinnovativeClient_NetCore (in WinnovativeClient_NetCore.dll) Version: 17.0.0
Syntax

public class PdfHeaderOptions

The PdfHeaderOptions type exposes the following members.

Properties

  NameDescription
Public propertyHeaderBackColor
The background color of the header.
Public propertyHeaderHeight
Gets or sets the height in points of PDF header. 1 point is 1/72 inch.
Public propertyPageNumberingPageCountIncrement
Gets or sets an increment for the total number of pages displayed using &P; variable in a TextArea element added to the header.
Public propertyPageNumberingStartIndex
Gets or sets the start index for page numbering using the &p; variable in a TextArea element added to the header.
Public propertyShowInEvenPages
Gets or sets a flag indicating if the header is displayed int the even pages of the PDF document
Public propertyShowInFirstPage
Gets or sets a flag indicating if the header is displayed in the first page of the PDF document
Public propertyShowInOddPages
Gets or sets a flag indicating if the header is displayed in the odd pages of the PDF document
Top
Methods

  NameDescription
Public methodAddElement
Add a PDF element to be rendered in header by the HTML to PDF converter
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
See Also

Reference