Package com.grapecity.documents.excel.drawing

Interface IBackgroundPictures

All Superinterfaces:
Iterable<IBackgroundPicture>
public interface IBackgroundPictures extends Iterable<IBackgroundPicture>
A collection of all the IBackgroundPicture objects on the specified sheet.

  • Method Details

    • get

      IBackgroundPicture get(int index)
      Returns a single object from a collection.
      Parameters:
      index - Required int. The index number for the object.

    • get

      IBackgroundPicture get(String name)
      Returns a single object from a collection.
      Parameters:
      name - Required string. The name for the object.

    • getCount

      int getCount()
      Returns the number of objects in the collection.

    • addPicture

      IBackgroundPicture addPicture(String filename, double left, double top, double width, double height) throws IOException
      Creates a background picture from an existing file. Returns the IBackgroundPicture objectthat represents the new background picture.
      Parameters:
      filename - The file from which the object is to be created
      left - The position (in points) of the upper-left corner of the destination rectanglerelative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of the destination rectanglerelative to the top of the document.
      width - The width of the destination rectangle, in points.
      height - The height of the destination rectangle, in points.
      Returns:
      The IBackgroundPictureThe object.
      Throws:
      IOException

    • addPicture

      IBackgroundPicture addPicture(InputStream stream, ImageType type, double left, double top, double width, double height) throws IOException
      Creates a background picture from an existing stream. Returns the IBackgroundPicture objectthat represents the new background picture.
      Parameters:
      stream - The stream from which the object is to be created.
      type - Specifies the type of background picture to create.
      left - The position (in points) of the upper-left corner of the destination rectanglerelative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of the destination rectanglerelative to the top of the document.
      width - The width of the destination rectangle, in points.
      height - The height of the destination rectangle, in points.
      Returns:
      The IBackgroundPictureThe object.
      Throws:
      IOException

    • addPictureInPixel

      IBackgroundPicture addPictureInPixel(String filename, double left, double top, double width, double height) throws IOException
      Creates a background picture from an existing file. Returns the IBackgroundPicture objectthat represents the new background picture.
      Parameters:
      filename - The file from which the object is to be created
      left - The position (in pixels) of the upper-left corner of the destination rectanglerelative to the upper-left corner of the document.
      top - The position (in pixels) of the upper-left corner of the destination rectanglerelative to the top of the document.
      width - The width of the destination rectangle, in pixels.
      height - The height of the destination rectangle, in pixels.
      Returns:
      The IBackgroundPicture object.
      Throws:
      IOException

    • addPictureInPixel

      IBackgroundPicture addPictureInPixel(InputStream stream, ImageType type, double left, double top, double width, double height) throws IOException
      Creates a background picture from an existing stream. Returns the IBackgroundPicture objectthat represents the new background picture.
      Parameters:
      stream - The stream from which the object is to be created.
      type - Specifies the type of picture to create.
      left - The position (in points) of the upper-left corner of the destination rectanglerelative to the upper-left corner of the document.
      top - The position (in points) of the upper-left corner of the destination rectanglerelative to the top of the document.
      width - The width of the destination rectangle, in points.
      height - The height of the destination rectangle, in points.
      Returns:
      The IShape object.
      Throws:
      IOException