Class ParagraphOrphansControl

Namespace

iText.Layout.Properties

Assembly

itext.layout.dll

A specialized class holding configurable parameters related to Paragraph 's orphans restrictions.

public class ParagraphOrphansControl

Inheritance

object

ParagraphOrphansControl

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

A specialized class holding configurable parameters related to Paragraph 's orphans restrictions. This class is meant to be used as the value for the ORPHANS_CONTROL key.

Constructors

ParagraphOrphansControl(int)

Creates a ParagraphOrphansControl instance with a specified orphans limitation.

public ParagraphOrphansControl(int minOrphans)

Parameters

minOrphans int

minimal number of paragraph's lines to remain on an area before an area break.

Methods

GetMinOrphans()

Gets minimal number of paragraph's lines to remain on an area before a split.

public virtual int GetMinOrphans()

Returns

int

minimal number of paragraph's lines to remain on an area before an area break.

HandleViolatedOrphans(ParagraphRenderer, string)

Writes a log message reporting that orphans constraint is violated.

public virtual void HandleViolatedOrphans(ParagraphRenderer renderer, string message)

Parameters

renderer ParagraphRenderer

a renderer processing orphans

message string

string explaining the reason for violation

Remarks

Writes a log message reporting that orphans constraint is violated. This method is to be overridden if violation scenarios need to be handled in some other way.

SetMinAllowedOrphans(int)

Sets parameter that defines orphans restrictions.

public virtual ParagraphOrphansControl SetMinAllowedOrphans(int minOrphans)

Parameters

minOrphans int

minimal number of paragraph's lines to remain on an area before an area break.

Returns

ParagraphOrphansControl

this ParagraphOrphansControl instance