HiQPdf Documentation

PdfRepeatCanvas Class

Quickly Create High Quality PDFs
This canvas is automatically laid out in the same position on each PDF page
Inheritance Hierarchy

SystemObject
  HiQPdfPdfCanvas
    HiQPdfPdfRepeatCanvas
      HiQPdfPdfDocumentFooter
      HiQPdfPdfDocumentHeader

Namespace:  HiQPdf
Assembly:  HiQPdf (in HiQPdf.dll) Version: 11.4.0.0
Syntax

public class PdfRepeatCanvas : PdfCanvas

The PdfRepeatCanvas type exposes the following members.

Properties

  NameDescription
Public propertyAdjustPageCount
Can be used to adjust the total number of pages in page numbering control
Public propertyAnchoringMode
Controls the anchoring mode of the canvas in PDF page
Public propertyDockingMode
Controls the docking mode of the canvas in PDF page
Public propertyDrawableRectangle
The rectangle in canvas where the PDF objects can be laid out. The position of all the PDF objects laid out in canvas are relative to this rectangle
(Inherited from PdfCanvas.)
Public propertyFirstPageNumber
Controls the number of the first page in page numbering control
Public propertyHeight
The canvas height in points
Public propertyParentDocument
The parent document of this canvas
(Inherited from PdfCanvas.)
Public propertyRectangle
The bounding rectangle of this canvas, the same in each PDF page
Public propertyRepeatInBackground
Controls if the canvas is repeated in back of the page content. By default the canvas is rendered in the front of the main content
Public propertyRepeatInEvenPages
Controls if the canvas is repeated in even pages of the PDF document. By default is repeated on all pages
Public propertyRepeatInFirstPage
Controls if the canvas is repeated in the first page of the PDF document. By default is repeated on all pages
Public propertyRepeatInOddPages
Controls if the canvas is repeated in odd pages of the PDF document. By default is repeated on all pages
Public propertyWidth
The canvas width in points
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 a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLayout
Layout the PDF object given as parameter in this repeated canvas
(Overrides PdfCanvasLayout(PdfObject).)
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
Events

  NameDescription
Public eventRepeatingInPdfPageEvent
The event is raised right before the canvas is repeated in a PDF page. You can set the CancelRepeating property to false to cancel canvas repeating in PDF page
Top
See Also

Reference