iText 5

IDocListener

IDocListener Public interface

Description

A class that implements DocListener will perform some actions when some actions are performed on a Document.

Diagram

flowchart LR classDef interfaceStyle stroke-dasharray: 5 5; classDef abstractStyle stroke-width:4px subgraph iTextSharp.text iTextSharp.text.IDocListener[[IDocListener]] class iTextSharp.text.IDocListener interfaceStyle; iTextSharp.text.IElementListener[[IElementListener]] class iTextSharp.text.IElementListener interfaceStyle; end subgraph System System.IDisposable[[IDisposable]] end iTextSharp.text.IElementListener --> iTextSharp.text.IDocListener System.IDisposable --> iTextSharp.text.IDocListener

Members

Properties

Public properties

Type

Name

Methods

int

PageCount


Sets the page number.

set

Methods

Public methods

Returns

Name

void

Close

()
Signals that the Document was closed and that no other
Elements will be added.

bool

NewPage

()
Signals that an new page has to be started.

void

Open

()
Signals that the Document has been opened and that
Elements can be added.

void

ResetPageCount

()
Sets the page number to 0.

bool

SetMarginMirroring

(bool marginMirroring)

bool

SetMarginMirroringTopBottom

(bool marginMirroringTopBottom)

bool

SetMargins

(float marginLeft, float marginRight, float marginTop, float marginBottom)
Sets the margins.

bool

SetPageSize

(

Rectangle

pageSize)
Sets the pagesize.

Details

Summary

A class that implements DocListener will perform some actions when some actions are performed on a Document.

Inheritance

Methods

Open

public void Open()

Summary

Signals that the Document has been opened and that Elements can be added.

Close

public void Close()

Summary

Signals that the Document was closed and that no other Elements will be added.

Remarks

The output stream of every writer implementing IDocListener will be closed.

NewPage

public bool NewPage()

Summary

Signals that an new page has to be started.

Returns

true if the page was added, false if not.

SetPageSize

public bool SetPageSize(Rectangle pageSize)

Arguments

Type

Name

Description

Rectangle

pageSize

the new pagesize

Summary

Sets the pagesize.

Returns

a boolean

SetMargins

public bool SetMargins(float marginLeft, float marginRight, float marginTop, float marginBottom)

Arguments

Type

Name

Description

float

marginLeft

the margin on the left

float

marginRight

the margin on the right

float

marginTop

the margin on the top

float

marginBottom

the margin on the bottom

Summary

Sets the margins.

Returns
SetMarginMirroring

public bool SetMarginMirroring(bool marginMirroring)

Arguments

Type

Name

Description

bool

marginMirroring

SetMarginMirroringTopBottom

public bool SetMarginMirroringTopBottom(bool marginMirroringTopBottom)

Arguments

Type

Name

Description

bool

marginMirroringTopBottom

ResetPageCount

public void ResetPageCount()

Summary

Sets the page number to 0.

Properties

PageCount

public int PageCount { set; }

Summary

Sets the page number.

Value

the new page number

Generated with ModularDoc