Table of Contents

Class BackgroundRepeat

Namespace
iText.Layout.Properties
Assembly
itext.layout.dll

Class to hold background-repeat property.

public class BackgroundRepeat
Inheritance
BackgroundRepeat
Inherited Members

Constructors

BackgroundRepeat()

Creates a new BackgroundRepeat instance.

public BackgroundRepeat()

Remarks

Creates a new BackgroundRepeat instance. The axis will have the value REPEAT.

BackgroundRepeat(BackgroundRepeatValue)

Creates a new BackgroundRepeat instance based on one BackgroundRepeat instance.

public BackgroundRepeat(BackgroundRepeat.BackgroundRepeatValue repeat)

Parameters

repeat BackgroundRepeat.BackgroundRepeatValue

the repeat value that will be set for for both axes

BackgroundRepeat(BackgroundRepeatValue, BackgroundRepeatValue)

Creates a new BackgroundRepeat instance based on two BackgroundRepeat instance.

public BackgroundRepeat(BackgroundRepeat.BackgroundRepeatValue xAxisRepeat, BackgroundRepeat.BackgroundRepeatValue yAxisRepeat)

Parameters

xAxisRepeat BackgroundRepeat.BackgroundRepeatValue

the repeat value that will be set for for X axis

yAxisRepeat BackgroundRepeat.BackgroundRepeatValue

the repeat value that will be set for for Y axis

Methods

GetXAxisRepeat()

Gets the BackgroundRepeat.BackgroundRepeatValue value for X axis.

public virtual BackgroundRepeat.BackgroundRepeatValue GetXAxisRepeat()

Returns

BackgroundRepeat.BackgroundRepeatValue

the repeat value for X axis.

GetYAxisRepeat()

Gets the BackgroundRepeat.BackgroundRepeatValue value for Y axis.

public virtual BackgroundRepeat.BackgroundRepeatValue GetYAxisRepeat()

Returns

BackgroundRepeat.BackgroundRepeatValue

the repeat value for Y axis.

IsNoRepeatOnXAxis()

Checks whether the NO_REPEAT value is set on X axis or not.

public virtual bool IsNoRepeatOnXAxis()

Returns

bool

is the X axis have NO_REPEAT value

IsNoRepeatOnYAxis()

Checks whether the NO_REPEAT value is set on Y axis or not.

public virtual bool IsNoRepeatOnYAxis()

Returns

bool

is the Y axis have NO_REPEAT value

PrepareRectangleToDrawingAndGetWhitespace(Rectangle, Rectangle, BackgroundSize)

Prepares the image rectangle for drawing.

public virtual Point PrepareRectangleToDrawingAndGetWhitespace(Rectangle imageRectangle, Rectangle backgroundArea, BackgroundSize backgroundSize)

Parameters

imageRectangle Rectangle

the image rectangle which will be changed

backgroundArea Rectangle

the background available area

backgroundSize BackgroundSize

the image background size property

Returns

Point

the necessary whitespace between backgrounds

Remarks

Prepares the image rectangle for drawing. This means that the size and position of the image rectangle will be changed to match the BackgroundRepeat.BackgroundRepeatValue values for the axes.