Table of Contents

Class DocumentRenderer

Namespace
iText.Layout.Renderer
Assembly
itext.layout.dll
public class DocumentRenderer : RootRenderer, IRenderer, IPropertyContainer
Inheritance
DocumentRenderer
Implements
Derived
Inherited Members

Constructors

DocumentRenderer(Document) 

public DocumentRenderer(Document document)

Parameters

document Document

DocumentRenderer(Document, bool) 

public DocumentRenderer(Document document, bool immediateFlush)

Parameters

document Document
immediateFlush bool

Fields

document 

protected Document document

Field Value

Document

targetCounterHandler 

protected TargetCounterHandler targetCounterHandler

Field Value

TargetCounterHandler

wrappedContentPage 

protected IList<int> wrappedContentPage

Field Value

IList<int>

Methods

AddNewPage(PageSize)

Adds new page with defined page size to PDF document.

protected virtual PageSize AddNewPage(PageSize customPageSize)

Parameters

customPageSize PageSize

the size of new page, can be null

Returns

PageSize

the page size of created page

EnsureDocumentHasNPages(int, PageSize)

Ensures that PDF document has n pages.

protected virtual PageSize EnsureDocumentHasNPages(int n, PageSize customPageSize)

Parameters

n int

the expected number of pages if document

customPageSize PageSize

the size of created pages, can be null

Returns

PageSize

the page size of the last created page, or null if no page was created

Remarks

Ensures that PDF document has n pages. If document has fewer pages, adds new pages by calling AddNewPage(PageSize) method.

FlushSingleRenderer(IRenderer) 

protected override void FlushSingleRenderer(IRenderer resultRenderer)

Parameters

resultRenderer IRenderer

GetNextRenderer()

For DocumentRenderer , this has a meaning of the renderer that will be used for relayout.

public override IRenderer GetNextRenderer()

Returns

IRenderer

relayout renderer.

GetOccupiedArea() 

public override LayoutArea GetOccupiedArea()

Returns

LayoutArea

GetTargetCounterHandler()

Get handler for target-counters.

public virtual TargetCounterHandler GetTargetCounterHandler()

Returns

TargetCounterHandler

the TargetCounterHandler instance

IsRelayoutRequired()

Indicates if relayout is required for targetCounterHandler.

public virtual bool IsRelayoutRequired()

Returns

bool

true if relayout is required, false otherwise

UpdateCurrentArea(LayoutResult) 

protected override LayoutArea UpdateCurrentArea(LayoutResult overflowResult)

Parameters

overflowResult LayoutResult

Returns

LayoutArea