pdfHTML 6.0.0 API
iText.Html2pdf.Attach.Impl.Layout.RunningElementContainer Class Reference

A wrapper for the running elements taken out of the normal flow. More...

Public Member Functions

  RunningElementContainer (IElementNode runningElement, ITagWorker processedElementWorker)
  Initializes a new instance of RunningElementContainer that contains given running element iText.StyledXmlParser.Node.IElementNode and iText.Html2pdf.Attach.ITagWorker instances. More...
 
virtual void  SetOccurrencePage (int pageNum, bool firstOnPage)
  Sets the page on which underlying running element was to be placed. More...
 
virtual int  GetOccurrencePage ()
  Gets the page on which underlying running element was to be placed. More...
 
virtual bool  IsFirstOnPage ()
  Specifies if the given running element would have placed as the first element on the page or not. More...
 

Detailed Description

A wrapper for the running elements taken out of the normal flow.

Constructor & Destructor Documentation

◆ RunningElementContainer()

iText.Html2pdf.Attach.Impl.Layout.RunningElementContainer.RunningElementContainer ( IElementNode  runningElement,
ITagWorker  processedElementWorker 
)
inline

Initializes a new instance of RunningElementContainer that contains given running element iText.StyledXmlParser.Node.IElementNode and iText.Html2pdf.Attach.ITagWorker instances.

Parameters
runningElement the iText.StyledXmlParser.Node.IElementNode of the running element.
processedElementWorker the iText.Html2pdf.Attach.ITagWorker that was created for the running element and have been already completely processed (with all running element children).

Member Function Documentation

◆ GetOccurrencePage()

virtual int iText.Html2pdf.Attach.Impl.Layout.RunningElementContainer.GetOccurrencePage ( )
inlinevirtual

Gets the page on which underlying running element was to be placed.

Returns
the 1-based index of the page or 0 if element page is not yet defined.

◆ IsFirstOnPage()

virtual bool iText.Html2pdf.Attach.Impl.Layout.RunningElementContainer.IsFirstOnPage ( )
inlinevirtual

Specifies if the given running element would have placed as the first element on the page or not.

Specifies if the given running element would have placed as the first element on the page or not. Returned value only makes sense if GetOccurrencePage() returns value greater than 0.

Returns
true if it would be the first element on the page, otherwise false.

◆ SetOccurrencePage()

virtual void iText.Html2pdf.Attach.Impl.Layout.RunningElementContainer.SetOccurrencePage ( int  pageNum,
bool  firstOnPage 
)
inlinevirtual

Sets the page on which underlying running element was to be placed.

Parameters
pageNum the 1-based index of the page on which running element was to be placed.
firstOnPage specifies if the given running element would have placed as the first element on the page or not.