A Rectangle is the representation of a geometric figure. More...

Inheritance diagram for iTextSharp.text.Rectangle:

Public Member Functions
	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...

Static Public Attributes
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...

Protected Attributes
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
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...

Detailed Description

A Rectangle is the representation of a geometric figure.

See also: T:iTextSharp.text.Element, T:iTextSharp.text.Table, T:iTextSharp.text.Cell, T:iTextSharp.text.HeaderFooter

Constructor & Destructor Documentation

◆ Rectangle() [1/3]

iTextSharp.text.Rectangle.Rectangle	(	float	llx,
		float	lly,
		float	urx,
		float	ury
	)

Constructs a Rectangle-object.

Parameters

llx	lower left x
lly	lower left y
urx	upper right x
ury	upper right y

◆ Rectangle() [2/3]

iTextSharp.text.Rectangle.Rectangle	(	float	urx,
		float	ury
	)

Constructs a Rectangle-object starting from the origin (0, 0).

Parameters

urx	upper right x
ury	upper right y

◆ Rectangle() [3/3]

iTextSharp.text.Rectangle.Rectangle ( Rectangle rect )

Constructs a Rectangle-object.

Parameters

rect	another Rectangle

Member Function Documentation

◆ CloneNonPositionParameters()

virtual void iTextSharp.text.Rectangle.CloneNonPositionParameters ( Rectangle rect )

virtual

Copies all of the parameters from a Rectangle object except the position.

Parameters

rect	`Rectangle` to copy from

Reimplemented in iTextSharp.text.RectangleReadOnly.

◆ DisableBorderSide()

virtual void iTextSharp.text.Rectangle.DisableBorderSide ( int side )

virtual

Disables the border on the specified side.

Parameters

side	the side to disable. One of `LEFT, RIGHT, TOP, BOTTOM`

Reimplemented in iTextSharp.text.RectangleReadOnly.

◆ EnableBorderSide()

virtual void iTextSharp.text.Rectangle.EnableBorderSide ( int side )

virtual

Enables the border on the specified side.

Parameters

side	the side to enable. One of `LEFT, RIGHT, TOP, BOTTOM`

Reimplemented in iTextSharp.text.RectangleReadOnly.

◆ GetBottom()

virtual float iTextSharp.text.Rectangle.GetBottom ( float margin )

virtual

Returns the lower left y-coordinate, considering a given margin.

Parameters

margin a margin

Returns: the lower left y-coordinate

Reimplemented in iTextSharp.text.Table.

◆ GetLeft()

virtual float iTextSharp.text.Rectangle.GetLeft ( float margin )

virtual

Returns the lower left x-coordinate, considering a given margin.

Parameters

margin a margin

Returns: the lower left x-coordinate

Reimplemented in iTextSharp.text.Table.

◆ GetRectangle()

Rectangle iTextSharp.text.Rectangle.GetRectangle	(	float	top,
		float	bottom
	)

Gets a Rectangle that is altered to fit on the page.

Parameters

top	the top position
bottom	the bottom position

Returns: a Rectangle

◆ GetRight()

virtual float iTextSharp.text.Rectangle.GetRight ( float margin )

virtual

Returns the upper right x-coordinate, considering a given margin.

Parameters

margin a margin

Returns: the upper right x-coordinate

Reimplemented in iTextSharp.text.Table.

◆ GetTop()

virtual float iTextSharp.text.Rectangle.GetTop ( float margin )

virtual

Returns the upper right y-coordinate, considering a given margin.

Parameters

margin a margin

Returns: the upper right y-coordinate

Reimplemented in iTextSharp.text.Table.

◆ HasBorder()

bool iTextSharp.text.Rectangle.HasBorder ( int type )

Indicates if the table has a some type of border.

Parameters

type	the type of border

Returns: a bool

◆ HasBorders()

bool iTextSharp.text.Rectangle.HasBorders ( )

Indicates if the table has borders.

Returns: a bool

◆ IsContent()

bool iTextSharp.text.Rectangle.IsContent ( )

See also: com.lowagie.text.Element::isContent()

Since: iText 2.0.8

Implements iTextSharp.text.IElement.

◆ IsNestable()

virtual bool iTextSharp.text.Rectangle.IsNestable ( )

virtual

See also: com.lowagie.text.Element::isNestable()

Since: iText 2.0.8

Implements iTextSharp.text.IElement.

Reimplemented in iTextSharp.text.Table, iTextSharp.text.SimpleTable, and iTextSharp.text.Image.

◆ Normalize()

virtual void iTextSharp.text.Rectangle.Normalize ( )

virtual

Switches lowerleft with upperright

Reimplemented in iTextSharp.text.RectangleReadOnly.

◆ Process()

virtual bool iTextSharp.text.Rectangle.Process ( IElementListener listener )

virtual

Processes the element by adding it (or the different parts) to an IElementListener.

Parameters

listener an IElementListener

Returns: true if the element was processed successfully

Implements iTextSharp.text.IElement.

Reimplemented in iTextSharp.text.Table, and iTextSharp.text.Cell.

◆ Rotate()

Rectangle iTextSharp.text.Rectangle.Rotate ( )

Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle.

Returns: a Rectangle

◆ SoftCloneNonPositionParameters()

virtual void iTextSharp.text.Rectangle.SoftCloneNonPositionParameters ( Rectangle rect )

virtual

Copies all of the parameters from a Rectangle object except the position.

Parameters

rect	`Rectangle` to copy from

Reimplemented in iTextSharp.text.RectangleReadOnly.

◆ ToString()

override String iTextSharp.text.Rectangle.ToString ( )

Gets the content of the text element.

Returns: the content of the text element

Implements iTextSharp.text.IElement.

Member Data Documentation

◆ backgroundColor

Color iTextSharp.text.Rectangle.backgroundColor = null

protected

summary> This is the rotation value of this rectangle.

◆ border

int iTextSharp.text.Rectangle.border = UNDEFINED

protected

summary> This is the width of the border around this rectangle.

const int iTextSharp.text.Rectangle.BOTTOM_BORDER = 2

static

summary> This represents one side of the border of the Rectangle.

◆ BOX

const int iTextSharp.text.Rectangle.BOX = TOP_BORDER + BOTTOM_BORDER + LEFT_BORDER + RIGHT_BORDER

static

◆ LEFT_BORDER

const int iTextSharp.text.Rectangle.LEFT_BORDER = 4

static

summary> This represents one side of the border of the Rectangle.

◆ llx

float iTextSharp.text.Rectangle.llx

protected

the lower left x-coordinate.

summary> the lower left y-coordinate.

◆ lly

float iTextSharp.text.Rectangle.lly

protected

summary> the upper right x-coordinate.

◆ NO_BORDER

const int iTextSharp.text.Rectangle.NO_BORDER = 0

static

summary> This represents a type of border.

◆ RIGHT_BORDER

const int iTextSharp.text.Rectangle.RIGHT_BORDER = 8

static

summary> This represents a rectangle without borders.

◆ rotation

int iTextSharp.text.Rectangle.rotation = 0

protected

◆ TOP_BORDER

const int iTextSharp.text.Rectangle.TOP_BORDER = 1

static

summary> This represents one side of the border of the Rectangle.

◆ UNDEFINED

const int iTextSharp.text.Rectangle.UNDEFINED = -1

static

This is the value that will be used as undefined.

summary> This represents one side of the border of the Rectangle.

◆ urx

float iTextSharp.text.Rectangle.urx

protected

summary> the upper right y-coordinate.

◆ ury

float iTextSharp.text.Rectangle.ury

protected

summary> This represents the status of the 4 sides of the rectangle.

◆ useVariableBorders

bool iTextSharp.text.Rectangle.useVariableBorders = false

protected

summary> This is the color of the background of this rectangle.

Whether variable width borders are used.

Property Documentation

◆ BackgroundColor

virtual Color iTextSharp.text.Rectangle.BackgroundColor

getset

Get/set the backgroundcolor.

Gets the backgroundcolor.

Returns: a value

a Color

◆ Border

virtual int iTextSharp.text.Rectangle.Border

getset

Get/set the border

a int

◆ BorderColor

virtual Color iTextSharp.text.Rectangle.BorderColor

getset

Get/set the color of the border.

Gets the color of the border.

Returns: a value

◆ BorderWidthBottom

virtual float iTextSharp.text.Rectangle.BorderWidthBottom

getset

◆ BorderWidthLeft

virtual float iTextSharp.text.Rectangle.BorderWidthLeft

getset

◆ BorderWidthRight

virtual float iTextSharp.text.Rectangle.BorderWidthRight

virtual bool iTextSharp.text.Rectangle.UseVariableBorders

getset

Sets a parameter indicating if the rectangle has variable borders

Parameters

useVariableBorders indication if the rectangle has variable borders

◆ Width

virtual float iTextSharp.text.Rectangle.Width

getset

Returns the width of the rectangle.

a width

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

src/core/iTextSharp/text/Rectangle.cs

Public Member Functions

Static Public Attributes

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Rectangle() [1/3]

◆ Rectangle() [2/3]

◆ Rectangle() [3/3]

Member Function Documentation

◆ CloneNonPositionParameters()

◆ DisableBorderSide()

◆ EnableBorderSide()

◆ GetBottom()

◆ GetLeft()

◆ GetRectangle()

◆ GetRight()

◆ GetTop()

◆ HasBorder()

◆ HasBorders()

◆ IsContent()

◆ IsNestable()

◆ Normalize()

◆ Process()

◆ Rotate()

◆ SoftCloneNonPositionParameters()

◆ ToString()

Member Data Documentation

◆ backgroundColor

◆ border

◆ borderColor

◆ borderColorBottom

◆ borderColorLeft

◆ borderColorRight

◆ borderColorTop

◆ borderWidth

◆ borderWidthBottom

◆ borderWidthLeft

◆ borderWidthRight

◆ borderWidthTop

◆ BOTTOM_BORDER

◆ BOX

◆ LEFT_BORDER

◆ llx

◆ lly

◆ NO_BORDER

◆ RIGHT_BORDER

◆ rotation

◆ TOP_BORDER

◆ UNDEFINED

◆ urx

◆ ury

◆ useVariableBorders

Property Documentation

◆ BackgroundColor

◆ Border

◆ BorderColor

◆ BorderColorBottom

◆ BorderColorLeft

◆ BorderColorRight

◆ BorderColorTop

◆ BorderWidth

◆ BorderWidthBottom

◆ BorderWidthLeft

◆ BorderWidthRight

◆ BorderWidthTop

◆ Bottom

◆ Chunks

◆ GrayFill

◆ Height

◆ Left

◆ Right

◆ Rotation

◆ Top

◆ Type

◆ UseVariableBorders

◆ Width