HiQPdf Documentation

PdfHeader Class

HiQPdf Client for .NET Core
This class controls the header of the PDF document generated by the HTML to PDF Converter. A reference to an object of this class is exposed by the Header property of the PdfDocumentControl class
Inheritance Hierarchy

SystemObject
  HiQPdfClientPdfHeader

Namespace:  HiQPdfClient
Assembly:  HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 15.0.0
Syntax

public class PdfHeader

The PdfHeader type exposes the following members.

Properties

  NameDescription
Public propertyAdjustPageCount
Can be used to adjust the total number of pages in page numbering control
Public propertyBackgroundColor
The color to be used as background for the header
Public propertyEnabled
Controls if the generated PDF document has a header or not. This property is false by default and the document does not have a header
Public propertyFirstPageNumber
Controls the number of the first page in page numbering control
Public propertyHeight
Gets or sets the height in points of header. 1 point is 1/72 inch.
Public propertyRepeatInEvenPages
Controls if the header is repeated in even pages of the PDF document. By default is repeated on all pages
Public propertyRepeatInFirstPage
Controls if the header is repeated in the first page of the PDF document. By default is repeated on all pages
Public propertyRepeatInOddPages
Controls if the header is repeated in odd pages of the PDF document. By default is repeated on all pages
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLayout
Layout a PDF object in the header
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference