iText.Layout.Properties.BackgroundImage Class Reference

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

Classes
class	Builder
	BackgroundImage builder class. More...

Public Member Functions
	BackgroundImage? (iText.Layout.Properties.BackgroundImage backgroundImage)
	Creates a copy of passed BackgroundImage instance. More...
virtual PdfImageXObject	GetImage ()
	Gets initial image if it is instanceof iText.Kernel.Pdf.Xobject.PdfImageXObject , otherwise returns null. More...
virtual PdfFormXObject	GetForm ()
	Gets initial image if it is instanceof iText.Kernel.Pdf.Xobject.PdfFormXObject , otherwise returns null. More...
virtual float[]	CalculateBackgroundImageSize (float areaWidth, float areaHeight)
	Calculates width and height values for background image with a given area params. More...
virtual BackgroundPosition	GetBackgroundPosition ()
	Gets background-position. More...
virtual AbstractLinearGradientBuilder	GetLinearGradientBuilder ()
	Gets linearGradientBuilder. More...
virtual bool	IsBackgroundSpecified ()
	Returns is background specified. More...
virtual BackgroundSize	GetBackgroundSize ()
	Gets the background size property. More...
virtual float	GetImageWidth ()
	Gets initial image width. More...
virtual float	GetImageHeight ()
	Gets initial image height. More...
virtual BackgroundRepeat	GetRepeat ()
	Gets image BackgroundRepeat instance. More...
virtual BlendMode	GetBlendMode ()
	Get the image's blend mode. More...
virtual BackgroundBox	GetBackgroundClip ()
	Gets background-clip. More...
virtual BackgroundBox	GetBackgroundOrigin ()
	Gets background-origin. More...

Package Functions
virtual float[]	ResolveWidthAndHeight (float? width, float? height, float areaWidth, float areaHeight)
	Resolves the final size of the background image in specified area. More...

Package Attributes
PdfXObject	image
AbstractLinearGradientBuilder	linearGradientBuilder

Detailed Description

Class to hold background-image property.

Member Function Documentation

BackgroundImage?()

iText.Layout.Properties.BackgroundImage.BackgroundImage? ( iText.Layout.Properties.BackgroundImage  backgroundImage )

inline

Creates a copy of passed BackgroundImage instance.

Parameters

backgroundImage

BackgroundImage for cloning

CalculateBackgroundImageSize()

virtual float [] iText.Layout.Properties.BackgroundImage.CalculateBackgroundImageSize ( float  areaWidth, float  areaHeight  )

inlinevirtual

Calculates width and height values for background image with a given area params.

Parameters

areaWidth	width of the area of this images
areaHeight	height of the area of this images

Returns

array of two float values. NOTE that first value defines width, second defines height

GetBackgroundClip()

virtual BackgroundBox iText.Layout.Properties.BackgroundImage.GetBackgroundClip ( )

inlinevirtual

Gets background-clip.

Returns

BackgroundBox

GetBackgroundOrigin()

virtual BackgroundBox iText.Layout.Properties.BackgroundImage.GetBackgroundOrigin ( )

inlinevirtual

Gets background-origin.

Returns

BackgroundBox

GetBackgroundPosition()

virtual BackgroundPosition iText.Layout.Properties.BackgroundImage.GetBackgroundPosition ( )

inlinevirtual

Gets background-position.

Returns

BackgroundPosition

GetBackgroundSize()

virtual BackgroundSize iText.Layout.Properties.BackgroundImage.GetBackgroundSize ( )

inlinevirtual

Gets the background size property.

Returns

BackgroundSize instance

GetBlendMode()

virtual BlendMode iText.Layout.Properties.BackgroundImage.GetBlendMode ( )

inlinevirtual

Get the image's blend mode.

Returns

the BlendMode representation of the image's blend mode

GetForm()

virtual PdfFormXObject iText.Layout.Properties.BackgroundImage.GetForm ( )

inlinevirtual

Gets initial image if it is instanceof iText.Kernel.Pdf.Xobject.PdfFormXObject , otherwise returns null.

Returns

iText.Kernel.Pdf.Xobject.PdfFormXObject

GetImage()

virtual PdfImageXObject iText.Layout.Properties.BackgroundImage.GetImage ( )

inlinevirtual

Gets initial image if it is instanceof iText.Kernel.Pdf.Xobject.PdfImageXObject , otherwise returns null.

Returns

iText.Kernel.Pdf.Xobject.PdfImageXObject

GetImageHeight()

virtual float iText.Layout.Properties.BackgroundImage.GetImageHeight ( )

inlinevirtual

Gets initial image height.

Returns

the initial image height

GetImageWidth()

virtual float iText.Layout.Properties.BackgroundImage.GetImageWidth ( )

inlinevirtual

Gets initial image width.

Returns

the initial image width

GetLinearGradientBuilder()

virtual AbstractLinearGradientBuilder iText.Layout.Properties.BackgroundImage.GetLinearGradientBuilder ( )

inlinevirtual

Gets linearGradientBuilder.

Returns

iText.Kernel.Colors.Gradients.AbstractLinearGradientBuilder

GetRepeat()

virtual BackgroundRepeat iText.Layout.Properties.BackgroundImage.GetRepeat ( )

inlinevirtual

Gets image BackgroundRepeat instance.

Returns

the image background repeat

IsBackgroundSpecified()

virtual bool iText.Layout.Properties.BackgroundImage.IsBackgroundSpecified ( )

inlinevirtual

Returns is background specified.

Returns

true if background is specified, otherwise false

ResolveWidthAndHeight()

virtual float [] iText.Layout.Properties.BackgroundImage.ResolveWidthAndHeight ( float?  width, float?  height, float  areaWidth, float  areaHeight  )

inlinepackagevirtual

Resolves the final size of the background image in specified area.

Parameters

width	the intrinsic background image width
height	the intrinsic background image height
areaWidth	the area width in which background will be placed
areaHeight	the area height in which background will be placed

Returns

the final size of the background image