Class BackgroundImage

Namespace

iText.Layout.Properties

Assembly

itext.layout.dll

Class to hold background-image property.

public class BackgroundImage

Inheritance

object

BackgroundImage

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BackgroundImage(BackgroundImage)

Creates a copy of passed BackgroundImage instance.

public BackgroundImage(BackgroundImage backgroundImage)

Parameters

backgroundImage BackgroundImage

BackgroundImage for cloning

Fields

image

protected PdfXObject image

Field Value

PdfXObject

linearGradientBuilder

protected AbstractLinearGradientBuilder linearGradientBuilder

Field Value

AbstractLinearGradientBuilder

Methods

GetBackgroundClip()

Gets background-clip.

public virtual BackgroundBox GetBackgroundClip()

Returns

BackgroundBox

BackgroundBox

GetBackgroundOrigin()

Gets background-origin.

public virtual BackgroundBox GetBackgroundOrigin()

Returns

BackgroundBox

BackgroundBox

GetBackgroundPosition()

Gets background-position.

public virtual BackgroundPosition GetBackgroundPosition()

Returns

BackgroundPosition

BackgroundPosition

GetBackgroundSize()

Gets the background size property.

public virtual BackgroundSize GetBackgroundSize()

Returns

BackgroundSize

BackgroundSize instance

GetBlendMode()

Get the image's blend mode.

public virtual BlendMode GetBlendMode()

Returns

BlendMode

the BlendMode representation of the image's blend mode

GetForm()

Gets initial image if it is instanceof PdfFormXObject , otherwise returns null.

public virtual PdfFormXObject GetForm()

Returns

PdfFormXObject

PdfFormXObject

GetImage()

Gets initial image if it is instanceof PdfImageXObject , otherwise returns null.

public virtual PdfImageXObject GetImage()

Returns

PdfImageXObject

PdfImageXObject

GetImageHeight()

Gets initial image height.

public virtual float GetImageHeight()

Returns

float

the initial image height

GetImageWidth()

Gets initial image width.

public virtual float GetImageWidth()

Returns

float

the initial image width

GetLinearGradientBuilder()

Gets linearGradientBuilder.

public virtual AbstractLinearGradientBuilder GetLinearGradientBuilder()

Returns

AbstractLinearGradientBuilder

AbstractLinearGradientBuilder

GetRepeat()

Gets image BackgroundRepeat instance.

public virtual BackgroundRepeat GetRepeat()

Returns

BackgroundRepeat

the image background repeat

IsBackgroundSpecified()

Returns is background specified.

public virtual bool IsBackgroundSpecified()

Returns

bool

true if background is specified, otherwise false