iText.Layout.Properties.BackgroundPosition Class Reference

Class to hold background-position property. More...

Public Types
enum	PositionX { LEFT, RIGHT, CENTER }
	A specialized enum containing positions in x-dimension (horizontal positions). More...
enum	PositionY { TOP, BOTTOM, CENTER }
	A specialized enum containing positions in y-dimension (vertical positions). More...

Public Member Functions
	BackgroundPosition ()
	Creates a new BackgroundPosition instance. More...
virtual void	CalculatePositionValues (float fullWidth, float fullHeight, UnitValue outXValue, UnitValue outYValue)
	Converts all percentage and enum values to point equivalent. More...
virtual BackgroundPosition.PositionX	GetPositionX ()
	Gets horizontal position. More...
virtual iText.Layout.Properties.BackgroundPosition	SetPositionX (BackgroundPosition.PositionX xPosition)
	Sets horizontal position. More...
virtual BackgroundPosition.PositionY	GetPositionY ()
	Gets vertical position. More...
virtual iText.Layout.Properties.BackgroundPosition	SetPositionY (BackgroundPosition.PositionY yPosition)
	Sets vertical position. More...
virtual UnitValue	GetXShift ()
	Gets horizontal shift. More...
virtual iText.Layout.Properties.BackgroundPosition	SetXShift (UnitValue xShift)
	Sets horizontal shift. More...
virtual UnitValue	GetYShift ()
	Gets vertical shift. More...
virtual iText.Layout.Properties.BackgroundPosition	SetYShift (UnitValue yShift)
	Sets vertical shift. More...
override bool	Equals (Object o)
override int	GetHashCode ()

Detailed Description

Class to hold background-position property.

Member Enumeration Documentation

PositionX

enum iText.Layout.Properties.BackgroundPosition.PositionX

strong

A specialized enum containing positions in x-dimension (horizontal positions).

PositionY

enum iText.Layout.Properties.BackgroundPosition.PositionY

strong

A specialized enum containing positions in y-dimension (vertical positions).

Constructor & Destructor Documentation

BackgroundPosition()

iText.Layout.Properties.BackgroundPosition.BackgroundPosition ( )

inline

Creates a new BackgroundPosition instance.

Creates a new BackgroundPosition instance. Fills it with default values.

Member Function Documentation

CalculatePositionValues()

virtual void iText.Layout.Properties.BackgroundPosition.CalculatePositionValues ( float  fullWidth, float  fullHeight, UnitValue  outXValue, UnitValue  outYValue  )

inlinevirtual

Converts all percentage and enum values to point equivalent.

Parameters

fullWidth	container width to calculate percentage.
fullHeight	container height to calculate percentage.
outXValue

UnitValue to store processed xPosition.

Parameters

outYValue

UnitValue to store processed yPosition.

Equals()

override bool iText.Layout.Properties.BackgroundPosition.Equals ( Object  o )

inline

Returns

true if every field equals. False otherwise.

GetHashCode()

override int iText.Layout.Properties.BackgroundPosition.GetHashCode ( )

inline

Returns

object's hashCode.

GetPositionX()

virtual BackgroundPosition.PositionX iText.Layout.Properties.BackgroundPosition.GetPositionX ( )

inlinevirtual

Gets horizontal position.

Returns

position in x-dimension

GetPositionY()

virtual BackgroundPosition.PositionY iText.Layout.Properties.BackgroundPosition.GetPositionY ( )

inlinevirtual

Gets vertical position.

Returns

position in y-dimension

GetXShift()

virtual UnitValue iText.Layout.Properties.BackgroundPosition.GetXShift ( )

inlinevirtual

Gets horizontal shift.

Returns

shift in x-dimension from left

GetYShift()

virtual UnitValue iText.Layout.Properties.BackgroundPosition.GetYShift ( )

inlinevirtual

Gets vertical shift.

Returns

shift in y-dimension from top

SetPositionX()

virtual iText.Layout.Properties.BackgroundPosition iText.Layout.Properties.BackgroundPosition.SetPositionX ( BackgroundPosition.PositionX  xPosition )

inlinevirtual

Sets horizontal position.

Parameters

xPosition

position in x-dimension

Returns

BackgroundPosition

SetPositionY()

virtual iText.Layout.Properties.BackgroundPosition iText.Layout.Properties.BackgroundPosition.SetPositionY ( BackgroundPosition.PositionY  yPosition )

inlinevirtual

Sets vertical position.

Parameters

yPosition

position in y-dimension

Returns

BackgroundPosition

SetXShift()

virtual iText.Layout.Properties.BackgroundPosition iText.Layout.Properties.BackgroundPosition.SetXShift ( UnitValue  xShift )

inlinevirtual

Sets horizontal shift.

Parameters

xShift

shift in x-dimension from left

Returns

BackgroundPosition

SetYShift()

virtual iText.Layout.Properties.BackgroundPosition iText.Layout.Properties.BackgroundPosition.SetYShift ( UnitValue  yShift )

inlinevirtual

Sets vertical shift.

Parameters

yShift

shift in y-dimension

Returns

BackgroundPosition