HiraokaHyperTools.iTextSharp-LGPL  0.2.5
iTextSharp.text.pdf.PdfPCell Class Reference
Inheritance diagram for iTextSharp.text.pdf.PdfPCell:
iTextSharp.text.Rectangle iTextSharp.text.Element iTextSharp.text.IElement

Public Member Functions

 PdfPCell ()
 
 PdfPCell (Phrase phrase)
 
 PdfPCell (Image image)
 
 PdfPCell (Image image, bool fit)
 
 PdfPCell (PdfPTable table)
 
 PdfPCell (PdfPTable table, PdfPCell style)
 
 PdfPCell (PdfPCell cell)
 
void AddElement (IElement element)
 
void SetLeading (float fixedLeading, float multipliedLeading)
 
bool HasFixedHeight ()
 
bool HasMinimumHeight ()
 
float GetMaxHeight ()
 
- Public Member Functions inherited from iTextSharp.text.Rectangle
 Rectangle (float llx, float lly, float urx, float ury)
 Constructs a Rectangle-object. More...
 
 Rectangle (float urx, float ury)
 Constructs a Rectangle-object starting from the origin (0, 0). More...
 
 Rectangle (Rectangle rect)
 Constructs a Rectangle-object. More...
 
virtual void CloneNonPositionParameters (Rectangle rect)
 
virtual void SoftCloneNonPositionParameters (Rectangle rect)
 
virtual bool Process (IElementListener listener)
 Processes the element by adding it (or the different parts) to an IElementListener. More...
 
bool IsContent ()
 
virtual bool IsNestable ()
 
virtual void Normalize ()
 
Rectangle GetRectangle (float top, float bottom)
 Gets a Rectangle that is altered to fit on the page. More...
 
Rectangle Rotate ()
 Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle. More...
 
virtual void EnableBorderSide (int side)
 
virtual void DisableBorderSide (int side)
 
virtual float GetLeft (float margin)
 Returns the lower left x-coordinate, considering a given margin. More...
 
virtual float GetRight (float margin)
 Returns the upper right x-coordinate, considering a given margin. More...
 
virtual float GetTop (float margin)
 Returns the upper right y-coordinate, considering a given margin. More...
 
virtual float GetBottom (float margin)
 Returns the lower left y-coordinate, considering a given margin. More...
 
bool HasBorders ()
 Indicates if the table has borders. More...
 
bool HasBorder (int type)
 Indicates if the table has a some type of border. More...
 
override String ToString ()
 Gets the content of the text element. More...
 

Protected Attributes

Phrase phrase
 
- Protected Attributes inherited from iTextSharp.text.Rectangle
float llx
 the lower left x-coordinate. More...
 
float lly
 summary> the upper right x-coordinate. More...
 
float urx
 summary> the upper right y-coordinate. More...
 
float ury
 summary> This represents the status of the 4 sides of the rectangle. More...
 
int border = UNDEFINED
 summary> This is the width of the border around this rectangle. More...
 
float borderWidth = UNDEFINED
 summary> This is the color of the border of this rectangle. More...
 
Color borderColor = null
 
Color borderColorLeft = null
 
Color borderColorRight = null
 
Color borderColorTop = null
 
Color borderColorBottom = null
 
float borderWidthLeft = UNDEFINED
 
float borderWidthRight = UNDEFINED
 
float borderWidthTop = UNDEFINED
 
float borderWidthBottom = UNDEFINED
 
bool useVariableBorders = false
 summary> This is the color of the background of this rectangle. More...
 
Color backgroundColor = null
 summary> This is the rotation value of this rectangle. More...
 
int rotation = 0
 

Properties

Phrase Phrase [get, set]
 
int HorizontalAlignment [get, set]
 
int VerticalAlignment [get, set]
 
float? EffectivePaddingLeft [get]
 
float PaddingLeft [get, set]
 
float? EffectivePaddingRight [get]
 
float PaddingRight [get, set]
 
float? EffectivePaddingTop [get]
 
float PaddingTop [get, set]
 
float? EffectivePaddingBottom [get]
 
float PaddingBottom [get, set]
 
float Padding [set]
 
bool UseBorderPadding [get, set]
 
float Leading [get]
 
float MultipliedLeading [get]
 
float Indent [get, set]
 
float ExtraParagraphSpace [get, set]
 
float FixedHeight [get, set]
 
bool NoWrap [get, set]
 
PdfPTable Table [get, set]
 
float MinimumHeight [get, set]
 
int Colspan [get, set]
 
int Rowspan [get, set]
 
float FollowingIndent [get, set]
 
float RightIndent [get, set]
 
float SpaceCharRatio [get, set]
 
int RunDirection [get, set]
 
Image Image [get, set]
 
IPdfPCellEvent CellEvent [get, set]
 
int ArabicOptions [get, set]
 
bool UseAscender [get, set]
 
bool UseDescender [get, set]
 
ColumnText Column [get, set]
 
ArrayList CompositeElements [get]
 
new int Rotation [get, set]
 
- Properties inherited from iTextSharp.text.Rectangle
virtual int Type [get]
 Gets the type of the text element. More...
 
virtual ArrayList Chunks [get]
 Gets all the chunks in this element. More...
 
virtual float Top [get, set]
 Get/set the upper right y-coordinate. More...
 
virtual int Border [get, set]
 Get/set the border More...
 
virtual float GrayFill [get, set]
 Get/set the grayscale of the rectangle. More...
 
virtual float Left [get, set]
 Get/set the lower left x-coordinate. More...
 
virtual float Right [get, set]
 Get/set the upper right x-coordinate. More...
 
virtual float Bottom [get, set]
 Get/set the lower left y-coordinate. More...
 
virtual Color BorderColorBottom [get, set]
 
virtual Color BorderColorTop [get, set]
 
virtual Color BorderColorLeft [get, set]
 
virtual Color BorderColorRight [get, set]
 
virtual float Width [get, set]
 Returns the width of the rectangle. More...
 
float Height [get]
 Returns the height of the rectangle. More...
 
virtual float BorderWidth [get, set]
 Get/set the borderwidth. More...
 
virtual Color BorderColor [get, set]
 Get/set the color of the border. More...
 
virtual Color BackgroundColor [get, set]
 Get/set the backgroundcolor. More...
 
int Rotation [get]
 Returns the rotation More...
 
virtual float BorderWidthLeft [get, set]
 
virtual float BorderWidthRight [get, set]
 
virtual float BorderWidthTop [get, set]
 
virtual float BorderWidthBottom [get, set]
 
virtual bool UseVariableBorders [get, set]
 
- Properties inherited from iTextSharp.text.IElement
int Type [get]
 Gets the type of the text element. More...
 
ArrayList Chunks [get]
 Gets all the chunks in this element. More...
 

Additional Inherited Members

- Static Public Attributes inherited from iTextSharp.text.Rectangle
const int UNDEFINED = -1
 This is the value that will be used as undefined. More...
 
const int TOP_BORDER = 1
 summary> This represents one side of the border of the Rectangle. More...
 
const int BOTTOM_BORDER = 2
 summary> This represents one side of the border of the Rectangle. More...
 
const int LEFT_BORDER = 4
 summary> This represents one side of the border of the Rectangle. More...
 
const int RIGHT_BORDER = 8
 summary> This represents a rectangle without borders. More...
 
const int NO_BORDER = 0
 summary> This represents a type of border. More...
 
const int BOX = TOP_BORDER + BOTTOM_BORDER + LEFT_BORDER + RIGHT_BORDER
 
- Static Public Attributes inherited from iTextSharp.text.Element
const int HEADER = 0
 This is a possible type of Element. More...
 
const int TITLE = 1
 This is a possible type of Element. More...
 
const int SUBJECT = 2
 This is a possible type of Element. More...
 
const int KEYWORDS = 3
 This is a possible type of Element. More...
 
const int AUTHOR = 4
 This is a possible type of Element. More...
 
const int PRODUCER = 5
 This is a possible type of Element. More...
 
const int CREATIONDATE = 6
 This is a possible type of Element. More...
 
const int CREATOR = 7
 This is a possible type of Element. More...
 
const int CHUNK = 10
 This is a possible type of Element. More...
 
const int PHRASE = 11
 This is a possible type of Element. More...
 
const int PARAGRAPH = 12
 This is a possible type of Element. More...
 
const int SECTION = 13
 This is a possible type of Element More...
 
const int LIST = 14
 This is a possible type of Element More...
 
const int LISTITEM = 15
 This is a possible type of Element More...
 
const int CHAPTER = 16
 This is a possible type of Element More...
 
const int ANCHOR = 17
 This is a possible type of Element More...
 
const int CELL = 20
 This is a possible type of Element. More...
 
const int ROW = 21
 This is a possible type of Element. More...
 
const int TABLE = 22
 This is a possible type of Element. More...
 
const int PTABLE = 23
 This is a possible type of Element. More...
 
const int ANNOTATION = 29
 This is a possible type of Element. More...
 
const int RECTANGLE = 30
 This is a possible type of Element. More...
 
const int JPEG = 32
 This is a possible type of Element. More...
 
const int JPEG2000 = 33
 
const int IMGRAW = 34
 This is a possible type of Element. More...
 
const int IMGTEMPLATE = 35
 This is a possible type of Element. More...
 
const int JBIG2 = 36
 
const int MULTI_COLUMN_TEXT = 40
 This is a possible type of More...
 
const int MARKED = 50
 
const int YMARK = 55
 
const int ALIGN_UNDEFINED = -1
 A possible value for paragraph Element. This specifies that the text is aligned to the left indent and extra whitespace should be placed on the right. More...
 
const int ALIGN_LEFT = 0
 A possible value for paragraph Element. This specifies that the text is aligned to the left indent and extra whitespace should be placed on the right. More...
 
const int ALIGN_CENTER = 1
 A possible value for paragraph Element. This specifies that the text is aligned to the center and extra whitespace should be placed equally on the left and right. More...
 
const int ALIGN_RIGHT = 2
 A possible value for paragraph Element. This specifies that the text is aligned to the right indent and extra whitespace should be placed on the left. More...
 
const int ALIGN_JUSTIFIED = 3
 A possible value for paragraph Element. This specifies that extra whitespace should be spread out through the rows of the paragraph with the text lined up with the left and right indent except on the last line which should be aligned to the left. More...
 
const int ALIGN_TOP = 4
 A possible value for vertical Element. More...
 
const int ALIGN_MIDDLE = 5
 A possible value for vertical Element. More...
 
const int ALIGN_BOTTOM = 6
 A possible value for vertical Element. More...
 
const int ALIGN_BASELINE = 7
 A possible value for vertical Element. More...
 
const int ALIGN_JUSTIFIED_ALL = 8
 Does the same as ALIGN_JUSTIFIED but the last line is also spread out. More...
 
const int CCITTG4 = 0x100
 Pure two-dimensional encoding (Group 4) More...
 
const int CCITTG3_1D = 0x101
 Pure one-dimensional encoding (Group 3, 1-D) More...
 
const int CCITTG3_2D = 0x102
 Mixed one- and two-dimensional encoding (Group 3, 2-D) More...
 
const int CCITT_BLACKIS1 = 1
 A flag indicating whether 1-bits are to be interpreted as black pixels and 0-bits as white pixels, More...
 
const int CCITT_ENCODEDBYTEALIGN = 2
 A flag indicating whether the filter expects extra 0-bits before each encoded line so that the line begins on a byte boundary. More...
 
const int CCITT_ENDOFLINE = 4
 A flag indicating whether end-of-line bit patterns are required to be present in the encoding. More...
 
const int CCITT_ENDOFBLOCK = 8
 A flag indicating whether the filter expects the encoded data to be terminated by an end-of-block pattern, overriding the Rows parameter. The use of this flag will set the key /EndOfBlock to false. More...
 

Detailed Description

A cell in a PdfPTable.

Constructor & Destructor Documentation

◆ PdfPCell() [1/7]

iTextSharp.text.pdf.PdfPCell.PdfPCell ( )

Constructs an empty PdfPCell. The default padding is 2.

◆ PdfPCell() [2/7]

iTextSharp.text.pdf.PdfPCell.PdfPCell ( Phrase  phrase)

Constructs a PdfPCell with a Phrase. The default padding is 2.

Parameters
phrasethe text

◆ PdfPCell() [3/7]

iTextSharp.text.pdf.PdfPCell.PdfPCell ( Image  image)

Constructs a PdfPCell with an Image. The default padding is 0.

Parameters
imagethe Image

◆ PdfPCell() [4/7]

iTextSharp.text.pdf.PdfPCell.PdfPCell ( Image  image,
bool  fit 
)

Constructs a PdfPCell with an Image. The default padding is 0.25 for a border width of 0.5.

Parameters
imagethe Image
fittrue to fit the image to the cell

◆ PdfPCell() [5/7]

iTextSharp.text.pdf.PdfPCell.PdfPCell ( PdfPTable  table)

Constructs a PdfPCell with a PdfPtable. This constructor allows nested tables. The default padding is 0.

Parameters
tableThe PdfPTable

◆ PdfPCell() [6/7]

iTextSharp.text.pdf.PdfPCell.PdfPCell ( PdfPTable  table,
PdfPCell  style 
)

Constructs a PdfPCell with a PdfPtable. This constructor allows nested tables.

Parameters
tableThe PdfPTable
styleThe style to apply to the cell (you could use getDefaultCell())
Since
2.1.0

◆ PdfPCell() [7/7]

iTextSharp.text.pdf.PdfPCell.PdfPCell ( PdfPCell  cell)

Constructs a deep copy of a PdfPCell.

Parameters
cellthe PdfPCell to duplicate

Member Function Documentation

◆ AddElement()

void iTextSharp.text.pdf.PdfPCell.AddElement ( IElement  element)

Adds an iText element to the cell.

Parameters
element

◆ GetMaxHeight()

float iTextSharp.text.pdf.PdfPCell.GetMaxHeight ( )

Returns the height of the cell.

Returns
the height of the cell
Since
3.0.0

◆ HasFixedHeight()

bool iTextSharp.text.pdf.PdfPCell.HasFixedHeight ( )

Tells you whether the cell has a fixed height.

Returns
true is a fixed height was set.
Since
2.1.5

◆ HasMinimumHeight()

bool iTextSharp.text.pdf.PdfPCell.HasMinimumHeight ( )

Tells you whether the cell has a minimum height.

Returns
true if a minimum height was set.
Since
2.1.5

◆ SetLeading()

void iTextSharp.text.pdf.PdfPCell.SetLeading ( float  fixedLeading,
float  multipliedLeading 
)

Sets the leading fixed and variable. The resultant leading will be fixedLeading+multipliedLeading*maxFontSize where maxFontSize is the size of the bigest font in the line.

Parameters
fixedLeadingthe fixed leading
multipliedLeadingthe variable leading

Member Data Documentation

◆ phrase

Phrase iTextSharp.text.pdf.PdfPCell.phrase
protected

The text in the cell.

Property Documentation

◆ ArabicOptions

int iTextSharp.text.pdf.PdfPCell.ArabicOptions
getset

Gets the arabic shaping options.

Returns
the arabic shaping options

◆ CellEvent

IPdfPCellEvent iTextSharp.text.pdf.PdfPCell.CellEvent
getset

Gets the cell event for this cell.

Returns
the cell event

◆ Colspan

int iTextSharp.text.pdf.PdfPCell.Colspan
getset

Getter for property colspan.

Returns
Value of property colspan.

◆ Column

ColumnText iTextSharp.text.pdf.PdfPCell.Column
getset

Gets the ColumnText with the content of the cell.

Returns
a columntext object

◆ CompositeElements

ArrayList iTextSharp.text.pdf.PdfPCell.CompositeElements
get

Returns the list of composite elements of the column.

Returns
a List object.
Since
2.1.1

◆ EffectivePaddingBottom

float? iTextSharp.text.pdf.PdfPCell.EffectivePaddingBottom
get

/** Gets the effective bottom padding. This will include the bottom border width if UseBorderPadding is true.

Returns
effective value of property paddingBottom.

◆ EffectivePaddingLeft

float? iTextSharp.text.pdf.PdfPCell.EffectivePaddingLeft
get

Gets the effective left padding. This will include the left border width if UseBorderPadding is true.

Returns
effective value of property paddingLeft.

◆ EffectivePaddingRight

float? iTextSharp.text.pdf.PdfPCell.EffectivePaddingRight
get

Gets the effective right padding. This will include the right border width if UseBorderPadding is true.

Returns
effective value of property paddingRight.

◆ EffectivePaddingTop

float? iTextSharp.text.pdf.PdfPCell.EffectivePaddingTop
get

Gets the effective top padding. This will include the top border width if isUseBorderPadding() is true.

Returns
effective value of property paddingTop.

◆ ExtraParagraphSpace

float iTextSharp.text.pdf.PdfPCell.ExtraParagraphSpace
getset

Gets the extra space between paragraphs.

Returns
the extra space between paragraphs

◆ FixedHeight

float iTextSharp.text.pdf.PdfPCell.FixedHeight
getset

Getter for property fixedHeight.

Returns
Value of property fixedHeight.

◆ FollowingIndent

float iTextSharp.text.pdf.PdfPCell.FollowingIndent
getset

Gets the following paragraph lines indent.

Returns
the indent

◆ HorizontalAlignment

int iTextSharp.text.pdf.PdfPCell.HorizontalAlignment
getset

Gets the horizontal alignment for the cell.

Returns
the horizontal alignment for the cell

◆ Image

Image iTextSharp.text.pdf.PdfPCell.Image
getset

Getter for property image.

Returns
Value of property image.

◆ Indent

float iTextSharp.text.pdf.PdfPCell.Indent
getset

Gets the first paragraph line indent.

Returns
the indent

◆ Leading

float iTextSharp.text.pdf.PdfPCell.Leading
get

Gets the fixed leading

Returns
the leading

◆ MinimumHeight

float iTextSharp.text.pdf.PdfPCell.MinimumHeight
getset

Getter for property minimumHeight.

Returns
Value of property minimumHeight.

◆ MultipliedLeading

float iTextSharp.text.pdf.PdfPCell.MultipliedLeading
get

Gets the variable leading

Returns
the leading

◆ NoWrap

bool iTextSharp.text.pdf.PdfPCell.NoWrap
getset

Setter for property noWrap.

Parameters
noWrapNew value of property noWrap.

◆ Padding

float iTextSharp.text.pdf.PdfPCell.Padding
set

Sets the padding of the contents in the cell (space between content and border).

Parameters
padding

◆ PaddingBottom

float iTextSharp.text.pdf.PdfPCell.PaddingBottom
getset

Getter for property paddingBottom.

Returns
Value of property paddingBottom.

◆ PaddingLeft

float iTextSharp.text.pdf.PdfPCell.PaddingLeft
getset
Returns
Value of property paddingLeft.

◆ PaddingRight

float iTextSharp.text.pdf.PdfPCell.PaddingRight
getset

Getter for property paddingRight.

Returns
Value of property paddingRight.

◆ PaddingTop

float iTextSharp.text.pdf.PdfPCell.PaddingTop
getset

Getter for property paddingTop.

Returns
Value of property paddingTop.

◆ Phrase

Phrase iTextSharp.text.pdf.PdfPCell.Phrase
getset

Gets the Phrase from this cell.

Returns
the Phrase

◆ RightIndent

float iTextSharp.text.pdf.PdfPCell.RightIndent
getset

Gets the right paragraph lines indent.

Returns
the indent

◆ Rotation

new int iTextSharp.text.pdf.PdfPCell.Rotation
getset

Sets the rotation of the cell. Possible values are 0, 90, 180 and 270.

Parameters
rotationthe rotation of the cell

◆ Rowspan

int iTextSharp.text.pdf.PdfPCell.Rowspan
getset

Getter for property rowspan.

Returns
Value of property rowspan.

◆ RunDirection

int iTextSharp.text.pdf.PdfPCell.RunDirection
getset

Gets the run direction of the text content in the cell

Returns
One of the following values: PdfWriter.RUN_DIRECTION_DEFAULT, PdfWriter.RUN_DIRECTION_NO_BIDI, PdfWriter.RUN_DIRECTION_LTR or PdfWriter.RUN_DIRECTION_RTL.

◆ SpaceCharRatio

float iTextSharp.text.pdf.PdfPCell.SpaceCharRatio
getset

Gets the space/character extra spacing ratio for fully justified text.

Returns
the space/character extra spacing ratio

◆ Table

PdfPTable iTextSharp.text.pdf.PdfPCell.Table
getset

Getter for property table.

Returns
Value of property table.

◆ UseAscender

bool iTextSharp.text.pdf.PdfPCell.UseAscender
getset

Gets state of first line height based on max ascender

Returns
true if an ascender is to be used.

◆ UseBorderPadding

bool iTextSharp.text.pdf.PdfPCell.UseBorderPadding
getset

Adjusts effective padding to include border widths.

Parameters
useadjust effective padding if true

◆ UseDescender

bool iTextSharp.text.pdf.PdfPCell.UseDescender
getset

Getter for property useDescender.

Returns
Value of property useDescender.

◆ VerticalAlignment

int iTextSharp.text.pdf.PdfPCell.VerticalAlignment
getset

Gets the vertical alignment for the cell.

Returns
the vertical alignment for the cell

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