iText 7 7.1.9 API
iText.Kernel.Events.PdfDocumentEvent Class Reference

Event dispatched by PdfDocument. More...

Inheritance diagram for iText.Kernel.Events.PdfDocumentEvent:
iText.Kernel.Events.Event

Public Member Functions

  PdfDocumentEvent (String type, PdfDocument document)
  Creates a PdfDocumentEvent. More...
 
  PdfDocumentEvent (String type, PdfPage page)
  Creates a PdfDocumentEvent. More...
 
virtual PdfDocument  GetDocument ()
  Returns the PdfDocument associated with this event. More...
 
virtual PdfPage  GetPage ()
  Returns the PdfPage associated with this event. More...
 
- Public Member Functions inherited from iText.Kernel.Events.Event
  Event (String type)
  Creates an event of the specified type. More...
 
virtual String  GetEventType ()
  Returns the type of this event. More...
 

Static Public Attributes

const String  START_PAGE = "StartPdfPage"
  Dispatched after page is created. More...
 
const String  INSERT_PAGE = "InsertPdfPage"
  Dispatched after page is inserted/added into document. More...
 
const String  REMOVE_PAGE = "RemovePdfPage"
  Dispatched after page is removed from document. More...
 
const String  END_PAGE = "EndPdfPage"
  Dispatched before page is closed and written. More...
 

Detailed Description

Event dispatched by PdfDocument.

Constructor & Destructor Documentation

◆ PdfDocumentEvent() [1/2]

iText.Kernel.Events.PdfDocumentEvent.PdfDocumentEvent ( String  type,
PdfDocument  document 
)
inline

Creates a PdfDocumentEvent.

Parameters
type type of the event that fired this event
document document that fired this event

◆ PdfDocumentEvent() [2/2]

iText.Kernel.Events.PdfDocumentEvent.PdfDocumentEvent ( String  type,
PdfPage  page 
)
inline

Creates a PdfDocumentEvent.

Parameters
type type of the event that fired this event
page page that fired this event

Member Function Documentation

◆ GetDocument()

virtual PdfDocument iText.Kernel.Events.PdfDocumentEvent.GetDocument ( )
inlinevirtual

Returns the PdfDocument associated with this event.

Returns
the PdfDocument associated with this event

◆ GetPage()

virtual PdfPage iText.Kernel.Events.PdfDocumentEvent.GetPage ( )
inlinevirtual

Returns the PdfPage associated with this event.

Returns the PdfPage associated with this event. Warning: this can be null.

Returns
the PdfPage associated with this event

Member Data Documentation

◆ END_PAGE

const String iText.Kernel.Events.PdfDocumentEvent.END_PAGE = "EndPdfPage"
static

Dispatched before page is closed and written.

◆ INSERT_PAGE

const String iText.Kernel.Events.PdfDocumentEvent.INSERT_PAGE = "InsertPdfPage"
static

Dispatched after page is inserted/added into document.

◆ REMOVE_PAGE

const String iText.Kernel.Events.PdfDocumentEvent.REMOVE_PAGE = "RemovePdfPage"
static

Dispatched after page is removed from document.

◆ START_PAGE

const String iText.Kernel.Events.PdfDocumentEvent.START_PAGE = "StartPdfPage"
static

Dispatched after page is created.