[]
        
(Showing Draft Content)

GrapeCity.Documents.Excel.Drawing.IBackgroundPictures

Interface IBackgroundPictures

Namespace
GrapeCity.Documents.Excel.Drawing
Assembly
GcDocs.Excel.dll

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

public interface IBackgroundPictures : IEnumerable<IBackgroundPicture>, IEnumerable
Inherited Members
System.Collections.Generic.IEnumerable<GrapeCity.Documents.Excel.Drawing.IBackgroundPicture>.GetEnumerator()

Properties

Count

Returns the number of objects in the collection.

int Count { get; }

Property Value

int

this[int]

Returns a single object from a collection.

IBackgroundPicture this[int index] { get; }

Parameters

index int

Required int. The index number for the object.

Property Value

IBackgroundPicture

this[string]

Returns a single object from a collection.

IBackgroundPicture this[string name] { get; }

Parameters

name string

Required string. The name for the object.

Property Value

IBackgroundPicture

Methods

AddPicture(Stream, ImageType, double, double, double, double)

Creates a background picture from an existing stream. Returns the IBackgroundPicture object that represents the new background picture.

IBackgroundPicture AddPicture(Stream stream, ImageType type, double left, double top, double width, double height)

Parameters

stream System.IO.Stream

The stream from which the object is to be created.

type ImageType

Specifies the type of background picture to create.

left double

The position (in points) of the upper-left corner of the destination rectangle relative to the upper-left corner of the document.

top double

The position (in points) of the upper-left corner of the destination rectangle relative to the top of the document.

width double

The width of the destination rectangle, in points.

height double

The height of the destination rectangle, in points.

Returns

IBackgroundPicture

The IBackgroundPictureThe object.

AddPicture(string, double, double, double, double)

Creates a background picture from an existing file. Returns the IBackgroundPicture object that represents the new background picture.

IBackgroundPicture AddPicture(string filename, double left, double top, double width, double height)

Parameters

filename string

The file from which the object is to be created

left double

The position (in points) of the upper-left corner of the destination rectangle relative to the upper-left corner of the document.

top double

The position (in points) of the upper-left corner of the destination rectangle relative to the top of the document.

width double

The width of the destination rectangle, in points.

height double

The height of the destination rectangle, in points.

Returns

IBackgroundPicture

The IBackgroundPictureThe object.

AddPictureInPixel(Stream, ImageType, double, double, double, double)

Creates a background picture from an existing stream. Returns the IBackgroundPicture object that represents the new background picture.

IBackgroundPicture AddPictureInPixel(Stream stream, ImageType type, double left, double top, double width, double height)

Parameters

stream System.IO.Stream

The stream from which the object is to be created.

type ImageType

Specifies the type of background picture to create.

left double

The position (in pixels) of the upper-left corner of the destination rectangle relative to the upper-left corner of the document.

top double

The position (in pixels) of the upper-left corner of the destination rectangle relative to the top of the document.

width double

The width of destination rectangle, in pixels.

height double

The height of destination rectangle, in pixels.

Returns

IBackgroundPicture

The IBackgroundPicture object.

AddPictureInPixel(string, double, double, double, double)

Creates a background picture from an existing file. Returns the IBackgroundPicture object that represents the new background picture.

IBackgroundPicture AddPictureInPixel(string filename, double left, double top, double width, double height)

Parameters

filename string

The file from which the object is to be created

left double

The position (in pixels) of the upper-left corner of the destination rectangle relative to the upper-left corner of the document.

top double

The position (in pixels) of the upper-left corner of the destination rectangle relative to the top of the document.

width double

The width of destination rectangle, in pixels.

height double

The height of destination rectangle, in pixels.

Returns

IBackgroundPicture

The IBackgroundPicture object.