OfficeImageFillFormat Leave feedback
On this page
Inheritance: java.lang.Object
public abstract class OfficeImageFillFormat<TWatermarkableImage>
Represents the image fill format settings in any supported office content.
TWatermarkableImage : The exact type of the watermarkable image that is used as background.
| Constructor | Description |
|---|---|
| OfficeImageFillFormat() |
| Method | Description |
|---|---|
| getTileAsTexture() | Gets a value indicating whether the image is tiled across the background. |
| setTileAsTexture(boolean value) | Sets a value indicating whether the image is tiled across the background. |
| getTransparency() | Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| setTransparency(double value) | Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| getBackgroundImage() | Gets the background image. |
| setBackgroundImage(TWatermarkableImage value) | Sets the background image. |
| checkIfBackgroundImageIsSet() |
public OfficeImageFillFormat()
public abstract boolean getTileAsTexture()
Gets a value indicating whether the image is tiled across the background.
Returns: boolean - True if the image is tiled across the background; otherwise, false (the image is stretched).
public abstract void setTileAsTexture(boolean value)
Sets a value indicating whether the image is tiled across the background.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | True if the image is tiled across the background; otherwise, false (the image is stretched). |
public abstract double getTransparency()
Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
Returns: double - The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
public abstract void setTransparency(double value)
Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
public abstract TWatermarkableImage getBackgroundImage()
Gets the background image.
Returns: TWatermarkableImage - The background image. Returns null if the image is not set.
public abstract void setBackgroundImage(TWatermarkableImage value)
Sets the background image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TWatermarkableImage | The background image. Returns null if the image is not set. |
public final void checkIfBackgroundImageIsSet()
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.