A layout object that terminates the current page content if any and starts the new page. More...

Inheritance diagram for iText.Layout.Element.SectionBreak:

Public Member Functions
	SectionBreak ()
	Creates new SectionBreak instance. More...

	SectionBreak (PageSize pageSize)
	Creates new SectionBreak instance. More...

	SectionBreak (PageMarginBoxes pageMarginBoxes)
	Creates new SectionBreak instance. More...

	SectionBreak (PageSize pageSize, PageMarginBoxes pageMarginBoxes)
	Creates new SectionBreak instance. More...

virtual PageSize	GetPageSize ()
	Gets the page size. More...

virtual iText.Layout.Element.SectionBreak	SetPageSize (PageSize pageSize)
	Sets the page size. More...

virtual PageMarginBoxes	GetPageMargins ()
	Gets the page margins. More...

virtual iText.Layout.Element.SectionBreak	SetPageMargins (PageMarginBoxes pageMarginBoxes)
	Sets the page margins. More...

virtual FootnotesProperties	GetFootnotesProperties ()
	Gets iText.Layout.Properties.Margins.FootnotesProperties specified for the document via SectionBreak to customize footnotes. More...

virtual iText.Layout.Element.SectionBreak	SetFootnotesProperties (FootnotesProperties footnotesProperties)
	Sets iText.Layout.Properties.Margins.FootnotesProperties for the document. More...

Public Member Functions inherited from iText.Layout.Element.AbstractElement< iText.Layout.Element.SectionBreak >
virtual IRenderer	GetRenderer ()
	Gets a renderer for this element. More...

virtual void	SetNextRenderer (IRenderer renderer)
	Overrides the iText.Layout.Renderer.IRenderer instance which will be returned by the next call to the GetRenderer(). More...

virtual IRenderer	CreateRendererSubTree ()
	Creates a renderer subtree with root in the current element. More...

override bool	HasProperty (int property)
	Checks if this entity has the specified property. More...

override T1	GetProperty< T1 > (int property)
	Gets the property from this entity. More...

virtual T	AddStyle (Style style)
	Add a new style to this element. More...

virtual T	AddStyleIfAbsent (Style style)
	Adds a new style that contains only those properties from the given style that are not already defined on this element (either directly or via previously added styles). More...

virtual ICollection< Style >	GetStyles ()
	Gets the styles added to this element. More...

virtual IList< IElement >	GetChildren ()
	Gets the child elements of this elements More...

virtual bool	IsEmpty ()
	Returns `true` if this list contains no elements. More...

virtual T	SetAction (PdfAction action)
	Sets an action on this Element. More...

virtual T	SetPageNumber (int pageNumber)
	Explicitly sets the page number this element should be put on. More...

Package Functions
override IRenderer	MakeNewRenderer ()
	Creates a new renderer instance. More...

Additional Inherited Members
Package Attributes inherited from iText.Layout.Element.AbstractElement< iText.Layout.Element.SectionBreak >
IRenderer	nextRenderer

IList< IElement >	childElements

ICollection< Style >	styles

Detailed Description

A layout object that terminates the current page content if any and starts the new page.

If no iText.Kernel.Geom.PageSize and iText.Layout.Properties.Margins.PageMarginBoxes are given, the new content section will have default page size and page margins.

Specified (or default if not specified) iText.Kernel.Geom.PageSize and iText.Layout.Properties.Margins.PageMarginBoxes will be applied for all next pages until it'll be overridden by other SectionBreak or AreaBreak elements.

Constructor & Destructor Documentation

◆ SectionBreak() [1/4]

iText.Layout.Element.SectionBreak.SectionBreak ( )

inline

Creates new SectionBreak instance.

The new content section will have default page size and page margins.

◆ SectionBreak() [2/4]

iText.Layout.Element.SectionBreak.SectionBreak ( PageSize pageSize )

inline

Creates new SectionBreak instance.

The new content section will have the specified page size and default page margins.

Parameters

pageSize

iText.Kernel.Geom.PageSize page size of the new content section

◆ SectionBreak() [3/4]

iText.Layout.Element.SectionBreak.SectionBreak ( PageMarginBoxes pageMarginBoxes )

inline

Creates new SectionBreak instance.

The new content section will have the specified page margins and default page size.

Parameters

pageMarginBoxes

iText.Layout.Properties.Margins.PageMarginBoxes page margins of the new content section

◆ SectionBreak() [4/4]

iText.Layout.Element.SectionBreak.SectionBreak	(	PageSize	pageSize,
		PageMarginBoxes	pageMarginBoxes
	)

inline

Creates new SectionBreak instance.

The new content section will have the specified page size and page margins.

Parameters

pageSize

iText.Kernel.Geom.PageSize page size of the new content section

Parameters

pageMarginBoxes

iText.Layout.Properties.Margins.PageMarginBoxes page margins of the new content section

Member Function Documentation

◆ GetFootnotesProperties()

virtual FootnotesProperties iText.Layout.Element.SectionBreak.GetFootnotesProperties ( )

inlinevirtual

Gets iText.Layout.Properties.Margins.FootnotesProperties specified for the document via SectionBreak to customize footnotes.

Returns

iText.Layout.Properties.Margins.FootnotesProperties specified for the document

◆ GetPageMargins()

virtual PageMarginBoxes iText.Layout.Element.SectionBreak.GetPageMargins ( )

inlinevirtual

Gets the page margins.

Returns: the page margins of the next content section

◆ GetPageSize()

virtual PageSize iText.Layout.Element.SectionBreak.GetPageSize ( )

inlinevirtual

Gets the page size.

Returns: the page size of the next content section

◆ MakeNewRenderer()

override IRenderer iText.Layout.Element.SectionBreak.MakeNewRenderer ( )

inlinepackagevirtual

Creates a new renderer instance.

Returns: new iText.Layout.Renderer.IRenderer

Implements iText.Layout.Element.AbstractElement< iText.Layout.Element.SectionBreak >.

◆ SetFootnotesProperties()

virtual iText.Layout.Element.SectionBreak iText.Layout.Element.SectionBreak.SetFootnotesProperties ( FootnotesProperties footnotesProperties )

inlinevirtual

Sets iText.Layout.Properties.Margins.FootnotesProperties for the document.

Parameters

footnotesProperties

iText.Layout.Properties.Margins.FootnotesProperties to customize footnotes

Returns: this same SectionBreak instance

◆ SetPageMargins()

virtual iText.Layout.Element.SectionBreak iText.Layout.Element.SectionBreak.SetPageMargins ( PageMarginBoxes pageMarginBoxes )

inlinevirtual

Sets the page margins.

Parameters

pageMarginBoxes the page margins of the next content section

Returns: this same instance

◆ SetPageSize()

virtual iText.Layout.Element.SectionBreak iText.Layout.Element.SectionBreak.SetPageSize ( PageSize pageSize )

inlinevirtual

Sets the page size.

Parameters

pageSize the new page size of the next content section

Returns: this same instance

Public Member Functions

Package Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SectionBreak() [1/4]

◆ SectionBreak() [2/4]

◆ SectionBreak() [3/4]

◆ SectionBreak() [4/4]

Member Function Documentation

◆ GetFootnotesProperties()

◆ GetPageMargins()

◆ GetPageSize()

◆ MakeNewRenderer()

◆ SetFootnotesProperties()

◆ SetPageMargins()

◆ SetPageSize()