PictureFillFormat

PictureFillFormat class

Represents a picture fill style.

compressImage

NameDescription
compressImage (boolean, float)Compresses the image by reducing its size based on the shape size and specified resolution. Optionally, it also deletes cropped areas.

Parameters:

NameTypeDescription
deleteCroppedAreasOfImagebooleanIf true, the method will remove the cropped areas of the image, potentially further reducing its size.
resolutionfloatThe target resolution in DPI. This value must be positive and defines how the image will be resized. This method changes the image’s size and resolution similar to PowerPoint’s “Picture Format -> Compress Pictures” feature.

Returns: boolean

Exception

ErrorCondition
ArgumentExceptionThrown when the resolution is not a positive value.

deletePictureCroppedAreas

NameDescription
deletePictureCroppedAreas ()Delete cropped areas of the fill Picture.

Returns: PPImage


getCropBottom

NameDescription
getCropBottom ()Returns or sets the number of percents of real image height that are cropped off the bottom of the picture. Read/write float.

Returns: float


getCropLeft

NameDescription
getCropLeft ()Returns or sets the number of percents of real image width that are cropped off the left of the picture. Read/write float.

Returns: float


getCropRight

NameDescription
getCropRight ()Returns or sets the number of percents of real image width that are cropped off the right of the picture. Read/write float.

Returns: float


getCropTop

NameDescription
getCropTop ()Returns or sets the number of percents of real image height that are cropped off the top of the picture. Read/write float.

Returns: float


getDpi

NameDescription
getDpi ()Returns or sets the dpi which is used to fill a picture. Read/write int.

Returns: int


getPicture

NameDescription
getPicture ()Returns the picture. Read-only ISlidesPicture.

Returns: Picture


getPictureFillMode

NameDescription
getPictureFillMode ()Returns or sets the picture fill mode. Read/write PictureFillMode.

Returns: int


getStretchOffsetBottom

NameDescription
getStretchOffsetBottom ()Returns or sets bottom edge of the fill rectangle that is defined by a percentage offset from the bottom edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: float


getStretchOffsetLeft

NameDescription
getStretchOffsetLeft ()Returns or sets left edge of the fill rectangle that is defined by a percentage offset from the left edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: float


getStretchOffsetRight

NameDescription
getStretchOffsetRight ()Returns or sets right edge of the fill rectangle that is defined by a percentage offset from the right edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: float


getStretchOffsetTop

NameDescription
getStretchOffsetTop ()Returns or sets top edge of the fill rectangle that is defined by a percentage offset from the top edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: float


getTileAlignment

NameDescription
getTileAlignment ()Returns or sets how the texture is aligned within the shape. This setting controls the starting point of the texture pattern and how it repeats across the shape. Read/write RectangleAlignment. Default is RectangleAlignment#TopLeft.

Returns: byte


getTileFlip

NameDescription
getTileFlip ()Flips the texture tile around its horizontal, vertical or both axis. Read/write TileFlip. Default is TileFlip#NoFlip.

Returns: int


getTileOffsetX

NameDescription
getTileOffsetX ()Returns or sets the horizontal offset of the texture from the shape’s origin in points. A positive value moves the texture to the right, while a negative value moves it to the left. Read/write float.

Returns: float


getTileOffsetY

NameDescription
getTileOffsetY ()Returns or sets the vertical offset of the texture from the shape’s origin in points. A positive value moves the texture down, while a negative value moves it up. Read/write float.

Returns: float


getTileScaleX

NameDescription
getTileScaleX ()Returns or sets the horizontal scale for the texture fill as a percentage. Read/write float.

Returns: float


getTileScaleY

NameDescription
getTileScaleY ()Returns or sets the vertical scale for the texture fill as a percentage. Read/write float.

Returns: float


getVersion

NameDescription
getVersion ()

Returns: long


setCropBottom

NameDescription
setCropBottom (float)Returns or sets the number of percents of real image height that are cropped off the bottom of the picture. Read/write float.

Returns: void


setCropLeft

NameDescription
setCropLeft (float)Returns or sets the number of percents of real image width that are cropped off the left of the picture. Read/write float.

Returns: void


setCropRight

NameDescription
setCropRight (float)Returns or sets the number of percents of real image width that are cropped off the right of the picture. Read/write float.

Returns: void


setCropTop

NameDescription
setCropTop (float)Returns or sets the number of percents of real image height that are cropped off the top of the picture. Read/write float.

Returns: void


setDpi

NameDescription
setDpi (int)Returns or sets the dpi which is used to fill a picture. Read/write int.

Returns: void


setPictureFillMode

NameDescription
setPictureFillMode (int)Returns or sets the picture fill mode. Read/write PictureFillMode.

Returns: void


setStretchOffsetBottom

NameDescription
setStretchOffsetBottom (float)Returns or sets bottom edge of the fill rectangle that is defined by a percentage offset from the bottom edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: void


setStretchOffsetLeft

NameDescription
setStretchOffsetLeft (float)Returns or sets left edge of the fill rectangle that is defined by a percentage offset from the left edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: void


setStretchOffsetRight

NameDescription
setStretchOffsetRight (float)Returns or sets right edge of the fill rectangle that is defined by a percentage offset from the right edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: void


setStretchOffsetTop

NameDescription
setStretchOffsetTop (float)Returns or sets top edge of the fill rectangle that is defined by a percentage offset from the top edge of the shape’s bounding box. A positive percentage specifies an inset, while a negative percentage specifies an outset. Read/write float.

Returns: void


setTileAlignment

NameDescription
setTileAlignment (byte)Returns or sets how the texture is aligned within the shape. This setting controls the starting point of the texture pattern and how it repeats across the shape. Read/write RectangleAlignment. Default is RectangleAlignment#TopLeft.

Returns: void


setTileFlip

NameDescription
setTileFlip (int)Flips the texture tile around its horizontal, vertical or both axis. Read/write TileFlip. Default is TileFlip#NoFlip.

Returns: void


setTileOffsetX

NameDescription
setTileOffsetX (float)Returns or sets the horizontal offset of the texture from the shape’s origin in points. A positive value moves the texture to the right, while a negative value moves it to the left. Read/write float.

Returns: void


setTileOffsetY

NameDescription
setTileOffsetY (float)Returns or sets the vertical offset of the texture from the shape’s origin in points. A positive value moves the texture down, while a negative value moves it up. Read/write float.

Returns: void


setTileScaleX

NameDescription
setTileScaleX (float)Returns or sets the horizontal scale for the texture fill as a percentage. Read/write float.

Returns: void


setTileScaleY

NameDescription
setTileScaleY (float)Returns or sets the vertical scale for the texture fill as a percentage. Read/write float.

Returns: void