Class LayoutResult

Namespace

iText.Layout.Layout

Assembly

itext.layout.dll

Represents the result of content layouting.

public class LayoutResult

Inheritance

object

LayoutResult

Derived

MinMaxWidthLayoutResult

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LayoutResult(int, LayoutArea, IRenderer, IRenderer)

Creates the LayoutResult result of layouting }.

public LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)

Parameters

status int

the status of Layout(LayoutContext)

occupiedArea LayoutArea

the area occupied by the content

splitRenderer IRenderer

the renderer to draw the splitted part of the content

overflowRenderer IRenderer

the renderer to draw the overflowed part of the content

Remarks

Creates the LayoutResult result of layouting }. The causeOfNothing will be set as null.

LayoutResult(int, LayoutArea, IRenderer, IRenderer, IRenderer)

Creates the LayoutResult result of layouting }.

public LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)

Parameters

status int

the status of Layout(LayoutContext)

occupiedArea LayoutArea

the area occupied by the content

splitRenderer IRenderer

the renderer to draw the splitted part of the content

overflowRenderer IRenderer

the renderer to draw the overflowed part of the content

cause IRenderer

the first renderer to produce NOTHING

Fields

FULL

The status of Layout(LayoutContext) which indicates that the content was fully placed.

public const int FULL = 1

Field Value

int

NOTHING

The status of Layout(LayoutContext) which indicates that the content was not placed.

public const int NOTHING = 3

Field Value

int

PARTIAL

The status of Layout(LayoutContext) which indicates that the content was placed partially.

public const int PARTIAL = 2

Field Value

int

areaBreak

The AreaBreak that will be rendered by this object.

protected AreaBreak areaBreak

Field Value

AreaBreak

causeOfNothing

The first renderer to produce NOTHING during Layout(LayoutContext).

protected IRenderer causeOfNothing

Field Value

IRenderer

occupiedArea

The area occupied by the content during its layouting.

protected LayoutArea occupiedArea

Field Value

LayoutArea

Remarks

The area occupied by the content during its layouting. which indicates whether the content was added or not and, if yes, was it added fully or partially.

overflowRenderer

The overflow renderer created during layouting.

protected IRenderer overflowRenderer

Field Value

IRenderer

Remarks

The overflow renderer created during layouting. This renderer will be used to draw the overflowed part of content.

splitRenderer

The split renderer created during layouting.

protected IRenderer splitRenderer

Field Value

IRenderer

Remarks

The split renderer created during layouting. This renderer will be used to draw the splitted part of content.

status

The status of Layout(LayoutContext) which indicates whether the content was added or not and, if yes, was it added fully or partially.

protected int status

Field Value

int

Methods

GetAreaBreak()

Gets areaBreak value.

public virtual AreaBreak GetAreaBreak()

Returns

AreaBreak

the areaBreak value

GetCauseOfNothing()

Gets the first renderer to produce NOTHING during Layout(LayoutContext)

public virtual IRenderer GetCauseOfNothing()

Returns

IRenderer

the renderer

GetOccupiedArea()

Gets the layout area occupied by the content during layouting.

public virtual LayoutArea GetOccupiedArea()

Returns

LayoutArea

the layout area occupied by the content

GetOverflowRenderer()

Gets the overflow renderer created during layouting.

public virtual IRenderer GetOverflowRenderer()

Returns

IRenderer

the renderer

GetSplitRenderer()

Gets the split renderer created during layouting.

public virtual IRenderer GetSplitRenderer()

Returns

IRenderer

the renderer

GetStatus()

Gets the status of Layout(LayoutContext).

public virtual int GetStatus()

Returns

int

the status

SetAreaBreak(AreaBreak)

Sets areaBreak value.

public virtual LayoutResult SetAreaBreak(AreaBreak areaBreak)

Parameters

areaBreak AreaBreak

the areaBreak value

Returns

LayoutResult

the areaBreak value

SetOverflowRenderer(IRenderer)

Sets the overflow renderer.

public virtual void SetOverflowRenderer(IRenderer overflowRenderer)

Parameters

overflowRenderer IRenderer

the renderer to draw the overflowed part of the content

SetSplitRenderer(IRenderer)

Sets the split renderer.

public virtual void SetSplitRenderer(IRenderer splitRenderer)

Parameters

splitRenderer IRenderer

the renderer to draw the splitted part of the content

SetStatus(int)

Sets the status of Layout(LayoutContext).

public virtual void SetStatus(int status)

Parameters

status int

the status of Layout(LayoutContext)

ToString()

public override string ToString()

Returns

string