iText 7 7.1.9 API
iText.Layout.Element.AreaBreak Class Reference

A layout object that terminates the current content area and creates a new one. More...

Inheritance diagram for iText.Layout.Element.AreaBreak:
iText.Layout.Element.AbstractElement< iText.Layout.Element.AreaBreak >

Public Member Functions

  AreaBreak ()
  Creates an AreaBreak. More...
 
  AreaBreak (AreaBreakType? areaBreakType)
  Creates an AreaBreak that terminates a specified area type. More...
 
  AreaBreak (PageSize pageSize)
  Creates an AreaBreak. More...
 
virtual PageSize  GetPageSize ()
  Gets the page size. More...
 
virtual void  SetPageSize (PageSize pageSize)
  Sets the page size. More...
 
virtual ? AreaBreakType  GetAreaType ()
  Gets the type of area that this AreaBreak will terminate. More...
 
- Public Member Functions inherited from iText.Layout.Element.AbstractElement< iText.Layout.Element.AreaBreak >
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 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...
 

Detailed Description

A layout object that terminates the current content area and creates a new one.

A layout object that terminates the current content area and creates a new one. If no iText.Kernel.Geom.PageSize is given, the new content area will have the same size as the current one.

Constructor & Destructor Documentation

◆ AreaBreak() [1/3]

iText.Layout.Element.AreaBreak.AreaBreak ( )
inline

Creates an AreaBreak.

Creates an AreaBreak. The new content area will have the same size as the current one.

◆ AreaBreak() [2/3]

iText.Layout.Element.AreaBreak.AreaBreak ( AreaBreakType areaBreakType )
inline

Creates an AreaBreak that terminates a specified area type.

Parameters
areaBreakType an area break type

◆ AreaBreak() [3/3]

iText.Layout.Element.AreaBreak.AreaBreak ( PageSize  pageSize )
inline

Creates an AreaBreak.

Creates an AreaBreak. The new content area will have the specified page size.

Parameters
pageSize the size of the new content area

Member Function Documentation

◆ GetAreaType()

virtual ? AreaBreakType iText.Layout.Element.AreaBreak.GetAreaType ( )
inlinevirtual

Gets the type of area that this AreaBreak will terminate.

Returns
the current area break type

◆ GetPageSize()

virtual PageSize iText.Layout.Element.AreaBreak.GetPageSize ( )
inlinevirtual

Gets the page size.

Returns
the page size of the next content area.

◆ SetPageSize()

virtual void iText.Layout.Element.AreaBreak.SetPageSize ( PageSize  pageSize )
inlinevirtual

Sets the page size.

Parameters
pageSize the new page size of the next content area.