com.groupdocs.watermark.contents

Class SpreadsheetImageFillFormat

java.lang.Object

com.groupdocs.watermark.contents.OfficeImageFillFormat<SpreadsheetWatermarkableImage>

com.groupdocs.watermark.contents.SpreadsheetImageFillFormat

public class SpreadsheetImageFillFormat
extends OfficeImageFillFormat<SpreadsheetWatermarkableImage>

Represents the image fill format settings in an Excel document.

Method Summary

Modifier and Type	Method and Description
SpreadsheetWatermarkableImage	getBackgroundImage() Gets the background image.
boolean	getTileAsTexture() Gets a value indicating whether the image is tiled across the background.
double	getTransparency() Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
void	setBackgroundImage(SpreadsheetWatermarkableImage value) Sets the background image.
void	setTileAsTexture(boolean value) Sets a value indicating whether the image is tiled across the background.
void	setTransparency(double value) Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

Methods inherited from class com.groupdocs.watermark.contents.OfficeImageFillFormat

checkIfBackgroundImageIsSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBackgroundImage

public SpreadsheetWatermarkableImage getBackgroundImage()

Gets the background image.

Specified by:

getBackgroundImage in class OfficeImageFillFormat<SpreadsheetWatermarkableImage>

Returns:

The background image. Returns null if the image is not set.

getTileAsTexture

public boolean getTileAsTexture()

Gets a value indicating whether the image is tiled across the background.

Specified by:

getTileAsTexture in class OfficeImageFillFormat<SpreadsheetWatermarkableImage>

Returns:

True if the image is tiled across the background; otherwise, false (the image is stretched).

getTransparency

public double getTransparency()

Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

Specified by:

getTransparency in class OfficeImageFillFormat<SpreadsheetWatermarkableImage>

Returns:

The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

setBackgroundImage

public void setBackgroundImage(SpreadsheetWatermarkableImage value)

Sets the background image.

Specified by:

setBackgroundImage in class OfficeImageFillFormat<SpreadsheetWatermarkableImage>

Parameters:

value - The background image. Returns null if the image is not set.

setTileAsTexture

public void setTileAsTexture(boolean value)

Sets a value indicating whether the image is tiled across the background.

Specified by:

setTileAsTexture in class OfficeImageFillFormat<SpreadsheetWatermarkableImage>

Parameters:

value - True if the image is tiled across the background; otherwise, false (the image is stretched).

setTransparency

public void setTransparency(double value)

Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

Specified by:

setTransparency in class OfficeImageFillFormat<SpreadsheetWatermarkableImage>

Parameters:

value - The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).