iTextSharp.text.pdf.PdfPRow Class Reference

Public Member Functions
	PdfPRow (PdfPCell[] cells)
	PdfPRow (PdfPRow row)
bool	SetWidths (float[] widths)
void	InitExtraHeights ()
void	SetExtraHeight (int cell, float height)
float	CalculateHeights ()
void	WriteBorderAndBackground (float xPos, float yPos, float currentMaxHeight, PdfPCell cell, PdfContentByte[] canvases)
void	WriteCells (int colStart, int colEnd, float xPos, float yPos, PdfContentByte[] canvases)
bool	IsCalculated ()
PdfPRow	SplitRow (PdfPTable table, int rowIndex, float new_height)
PdfPCell[]	GetCells ()

Static Public Member Functions
static float	SetColumn (ColumnText ct, float left, float bottom, float right, float top)

Static Public Attributes
const float	BOTTOM_LIMIT = -(1 << 30)
const float	RIGHT_LIMIT = 20000

Protected Member Functions
void	SaveAndRotateCanvases (PdfContentByte[] canvases, float a, float b, float c, float d, float e, float f)
void	RestoreCanvases (PdfContentByte[] canvases)

Protected Attributes
PdfPCell[]	cells
float[]	widths
float[]	extraHeights
float	maxHeight = 0
bool	calculated = false

Properties
float	MaxHeights [get, set]

Detailed Description

A row in a PdfPTable.

Author

Paulo Soares (psoar.nosp@m.es@c.nosp@m.onsis.nosp@m.te.p.nosp@m.t)

Constructor & Destructor Documentation

PdfPRow() [1/2]

iTextSharp.text.pdf.PdfPRow.PdfPRow

(

PdfPCell[]

cells

)

Constructs a new PdfPRow with the cells in the array that was passed as a parameter.

Parameters

cells

PdfPRow() [2/2]

iTextSharp.text.pdf.PdfPRow.PdfPRow

(

PdfPRow

row

)

Makes a copy of an existing row.

Parameters

row

Member Function Documentation

CalculateHeights()

float iTextSharp.text.pdf.PdfPRow.CalculateHeights

(

)

Calculates the heights of each cell in the row.

Returns

the maximum height of the row.

GetCells()

PdfPCell [] iTextSharp.text.pdf.PdfPRow.GetCells

(

)

Returns the array of cells in the row. Please be extremely careful with this method. Use the cells as read only objects.

Returns

an array of cells

Since

2.1.1

InitExtraHeights()

void iTextSharp.text.pdf.PdfPRow.InitExtraHeights

(

)

Initializes the extra heights array.

Since

2.1.6

IsCalculated()

bool iTextSharp.text.pdf.PdfPRow.IsCalculated

(

)

Checks if the dimensions of the columns were calculated.

Returns

true if the dimensions of the columns were calculated

RestoreCanvases()

void iTextSharp.text.pdf.PdfPRow.RestoreCanvases ( PdfContentByte[]  canvases )

protected

Since

2.1.6 private is now protected

SaveAndRotateCanvases()

void iTextSharp.text.pdf.PdfPRow.SaveAndRotateCanvases ( PdfContentByte[]  canvases, float  a, float  b, float  c, float  d, float  e, float  f  )

protected

Since

2.1.6 private is now protected

SetColumn()

static float iTextSharp.text.pdf.PdfPRow.SetColumn ( ColumnText  ct, float  left, float  bottom, float  right, float  top  )

static

Since

3.0.0 protected is now public static

SetExtraHeight()

void iTextSharp.text.pdf.PdfPRow.SetExtraHeight	(	int	cell,
		float	height
	)

Sets an extra height for a cell.

Parameters

cell	the index of the cell that needs an extra height
height	the extra height

Since

2.1.6

SetWidths()

bool iTextSharp.text.pdf.PdfPRow.SetWidths

(

float[]

widths

)

Sets the widths of the columns in the row.

Parameters

widths

Returns

true if everything went right

SplitRow()

PdfPRow iTextSharp.text.pdf.PdfPRow.SplitRow	(	PdfPTable	table,
		int	rowIndex,
		float	new_height
	)

Splits a row to newHeight. The returned row is the remainder. It will return null if the newHeight was so small that only an empty row would result.

Parameters

new_height

the new height

Returns

the remainder row or null if the newHeight was so small that only an empty row would result

WriteBorderAndBackground()

void iTextSharp.text.pdf.PdfPRow.WriteBorderAndBackground	(	float	xPos,
		float	yPos,
		float	currentMaxHeight,
		PdfPCell	cell,
		PdfContentByte[]	canvases
	)

Writes the border and background of one cell in the row.

Parameters

xPos	The x-coordinate where the table starts on the canvas
yPos	The y-coordinate where the table starts on the canvas
currentMaxHeight	The height of the cell to be drawn.
cell
canvases

Since

2.1.6 extra parameter currentMaxHeight

WriteCells()

void iTextSharp.text.pdf.PdfPRow.WriteCells	(	int	colStart,
		int	colEnd,
		float	xPos,
		float	yPos,
		PdfContentByte[]	canvases
	)

Writes a number of cells (not necessarily all cells).

Parameters

colStart	The first column to be written. Remember that the column index starts with 0.
colEnd	The last column to be written. Remember that the column index starts with 0. If -1, all the columns to the end are written.
xPos	The x-coordinate where the table starts on the canvas
yPos	The y-coordinate where the table starts on the canvas

Member Data Documentation

BOTTOM_LIMIT

const float iTextSharp.text.pdf.PdfPRow.BOTTOM_LIMIT = -(1 << 30)

static

the bottom limit (bottom right y)

calculated

bool iTextSharp.text.pdf.PdfPRow.calculated = false

protected

cells

PdfPCell [] iTextSharp.text.pdf.PdfPRow.cells

protected

extraHeights

float [] iTextSharp.text.pdf.PdfPRow.extraHeights

protected

extra heights that needs to be added to a cell because of rowspans.

Since

2.1.6

maxHeight

float iTextSharp.text.pdf.PdfPRow.maxHeight = 0

protected

RIGHT_LIMIT

const float iTextSharp.text.pdf.PdfPRow.RIGHT_LIMIT = 20000

static

the right limit

Since

2.1.5

widths

float [] iTextSharp.text.pdf.PdfPRow.widths

protected

Property Documentation

MaxHeights

float iTextSharp.text.pdf.PdfPRow.MaxHeights

getset

Gets the maximum height of the row (i.e. of the 'highest' cell).

Returns

the maximum height of the row

---

The documentation for this class was generated from the following file:

• src/core/iTextSharp/text/pdf/PdfPRow.cs