com.grapecity.documents.excel.drawing

Interface IBackgroundPictures

All Superinterfaces:

java.lang.Iterable<IBackgroundPicture>

public interface IBackgroundPictures
extends java.lang.Iterable<IBackgroundPicture>

A collection of all the IBackgroundPicture objects on the specified sheet.

Method Summary

Modifier and Type	Method and Description
IBackgroundPicture	addPicture(java.io.InputStream stream, ImageType type, double left, double top, double width, double height) Creates a background picture from an existing stream.
IBackgroundPicture	addPicture(java.lang.String filename, double left, double top, double width, double height) Creates a background picture from an existing file.
IBackgroundPicture	addPictureInPixel(java.io.InputStream stream, ImageType type, double left, double top, double width, double height) Creates a background picture from an existing stream.
IBackgroundPicture	addPictureInPixel(java.lang.String filename, double left, double top, double width, double height) Creates a background picture from an existing file.
IBackgroundPicture	get(int index) Returns a single object from a collection.
IBackgroundPicture	get(java.lang.String name) Returns a single object from a collection.
int	getCount() Returns the number of objects in the collection.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

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(java.lang.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(java.lang.String filename,
                              double left,
                              double top,
                              double width,
                              double height)
                       throws java.io.IOException

Creates a background picture from an existing file. Returns the IBackgroundPicture object that 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 rectangle relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the destination rectangle relative 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:

java.io.IOException

addPicture

IBackgroundPicture addPicture(java.io.InputStream stream,
                              ImageType type,
                              double left,
                              double top,
                              double width,
                              double height)
                       throws java.io.IOException

Creates a background picture from an existing stream. Returns the IBackgroundPicture object that 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 rectangle relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the destination rectangle relative 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:

java.io.IOException

addPictureInPixel

IBackgroundPicture addPictureInPixel(java.lang.String filename,
                                     double left,
                                     double top,
                                     double width,
                                     double height)
                              throws java.io.IOException

Creates a background picture from an existing file. Returns the IBackgroundPicture object that 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 rectangle relative to the upper-left corner of the document.

top - The position (in pixels) of the upper-left corner of the destination rectangle relative 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:

java.io.IOException

addPictureInPixel

IBackgroundPicture addPictureInPixel(java.io.InputStream stream,
                                     ImageType type,
                                     double left,
                                     double top,
                                     double width,
                                     double height)
                              throws java.io.IOException

Creates a background picture from an existing stream. Returns the IBackgroundPicture object that 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 rectangle relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the destination rectangle relative 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:

java.io.IOException