GrapeCity.Documents.Excel

GrapeCity.Documents.Excel.Drawing.IShapes

Interface IShapes

Namespace: GrapeCity.Documents.Excel.Drawing

Assembly: GcDocs.Excel.dll

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

public interface IShapes : IEnumerable<IShape>, IEnumerable

Inherited Members: System.Collections.Generic.IEnumerable<GrapeCity.Documents.Excel.Drawing.IShape>.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.

IShape this[int index] { get; }

Parameters

index int: Required int. The index number for the object.

Property Value

IShape

this[string]

Returns a single object from a collection.

IShape this[string name] { get; }

Parameters

name string: Required string. The name for the object.

Property Value

IShape

Range

Returns a IShapeRangeProvider object that receives parameters of the Range property.

IShapeRangeProvider Range { get; }

Property Value

IShapeRangeProvider

Methods

AddCameraPicture(string, IRange)

Creates a picture from reference range to the target range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.
Returns the IShape object that represents the new picture.

IShape AddCameraPicture(string reference, IRange targetRange)

Parameters

reference string: The range of the picture generated from.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

AddCameraPicture(string, double, double, double, double)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

IShape AddCameraPicture(string reference, double left, double top, double width, double height)

Parameters

reference string: The range of the picture generated from.
left double: The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.
width double: The width and height of the AutoShape's boundary box, in points.
height double: The width and height of the AutoShape's boundary box, in points.

Returns

IShape: The IShapeThe object.

AddCameraPicture(string, double, double)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

IShape AddCameraPicture(string reference, double left, double top)

Parameters

reference string: The range of the picture generated from.
left double: The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.

Returns

IShape: The IShapeThe object.

AddCameraPicture(string, string, IRange)

Creates a picture from reference range to the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.
Returns the IShape object that represents the new picture.

IShape AddCameraPicture(string reference, string name, IRange targetRange)

Parameters

reference string: The range of the picture generated from.
name string: The picture name.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

AddCameraPicture(string, string, double, double, double, double)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

IShape AddCameraPicture(string reference, string name, double left, double top, double width, double height)

Parameters

reference string: The range of the picture generated from.
name string: The picture name.
left double: The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.
width double: The width and height of the AutoShape's boundary box, in points.
height double: The width and height of the AutoShape's boundary box, in points.

Returns

IShape: The IShapeThe object.

AddCameraPicture(string, string, double, double)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

IShape AddCameraPicture(string reference, string name, double left, double top)

Parameters

reference string: The range of the picture generated from.
name string: The picture name.
left double: The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.

Returns

IShape: The IShapeThe object.

AddChart(ChartType, IRange)

Creates a chart at the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.

IShape AddChart(ChartType chartType, IRange targetRange)

Parameters

chartType ChartType: The chart type.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

AddChart(ChartType, double, double, double, double)

Creates a chart at the specified location on the active sheet.

IShape AddChart(ChartType chartType, double left, double top, double width, double height)

Parameters

chartType ChartType: The chart type.
left double: The distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
top double: The distance, in points, from the top edge of the top most shape in the shape range to the top edge of the worksheet.
width double: The width, in points, of the object.
height double: The height, in points, of the object.

Returns

IShape: The IShapeThe object.

AddChart(string, ChartType, IRange)

Creates a chart at the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.

IShape AddChart(string name, ChartType chartType, IRange targetRange)

Parameters

name string: The chart name.
chartType ChartType: The chart type.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

AddChart(string, ChartType, double, double, double, double)

Creates a chart at the specified location on the active sheet.

IShape AddChart(string name, ChartType chartType, double left, double top, double width, double height)

Parameters

name string: The chart name.
chartType ChartType: The chart type.
left double: The distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
top double: The distance, in points, from the top edge of the top most shape in the shape range to the top edge of the worksheet.
width double: The width, in points, of the object.
height double: The height, in points, of the object.

Returns

IShape: The IShapeThe object.

AddChartInPixel(ChartType, double, double, double, double)

Creates a chart at the specified location on the active sheet.

IShape AddChartInPixel(ChartType chartType, double left, double top, double width, double height)

Parameters

chartType ChartType: The chart type.
left double: The distance, in pixels, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
top double: The distance, in pixels, from the top edge of the top most shape in the shape range to the top edge of the worksheet.
width double: The width, in pixels, of the object.
height double: The height, in pixels, of the object.

Returns

IShape: The IShape object.

AddChartInPixel(string, ChartType, double, double, double, double)

Creates a chart at the specified location on the active sheet.

IShape AddChartInPixel(string name, ChartType chartType, double left, double top, double width, double height)

Parameters

name string: The chart name.
chartType ChartType: The chart type.
left double: The distance, in pixels, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).
top double: The distance, in pixels, from the top edge of the top most shape in the shape range to the top edge of the worksheet.
width double: The width, in pixels, of the object.
height double: The height, in pixels, of the object.

Returns

IShape: The IShape object.

AddConnector(ConnectorType, IRange)

Creates a connector at the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.
Returns the IShape object that represents the new connector.

IShape AddConnector(ConnectorType type, IRange targetRange)

Parameters

type ConnectorType: The connector type to add.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShape object.

AddConnector(ConnectorType, double, double, double, double)

Creates a connector. Returns the IShape object that represents the new connector.

IShape AddConnector(ConnectorType type, double beginX, double beginY, double endX, double endY)

Parameters

type ConnectorType: The connector type to add.
beginX double: The horizontal position (in points) of the connector's starting point relative to the upper-left corner of the document.
beginY double: The vertical position (in points) of the connector's starting point relative to the upper-left corner of the document.
endX double: The horizontal position (in points) of the connector's end point relative to the upper-left corner of the document.
endY double: The veritcal position (in points) of the connector's end point relative to the upper-left corner of the document.

Returns

IShape: The IShape object.

AddConnector(string, ConnectorType, IRange)

IShape AddConnector(string name, ConnectorType type, IRange targetRange)

Parameters

name string: The connector name.
type ConnectorType: The connector type to add.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShape object.

AddConnector(string, ConnectorType, double, double, double, double)

Creates a connector. Returns the IShape object that represents the new connector.

IShape AddConnector(string name, ConnectorType type, double beginX, double beginY, double endX, double endY)

Parameters

name string: The connector name.
type ConnectorType: The connector type to add.
beginX double: The horizontal position (in points) of the connector's starting point relative to the upper-left corner of the document.
beginY double: The vertical position (in points) of the connector's starting point relative to the upper-left corner of the document.
endX double: The horizontal position (in points) of the connector's end point relative to the upper-left corner of the document.
endY double: The veritcal position (in points) of the connector's end point relative to the upper-left corner of the document.

Returns

IShape: The IShape object.

AddConnectorInPixel(ConnectorType, double, double, double, double)

Creates a connector. Returns the IShape object that represents the new connector.

IShape AddConnectorInPixel(ConnectorType type, double beginX, double beginY, double endX, double endY)

Parameters

type ConnectorType: The connector type to add.
beginX double: The horizontal position (in pixels) of the connector's starting point relative to the upper-left corner of the document.
beginY double: The vertical position (in pixels) of the connector's starting point relative to the upper-left corner of the document.
endX double: The horizontal position (in pixels) of the connector's end point relative to the upper-left corner of the document.
endY double: The veritcal position (in pixels) of the connector's end point relative to the upper-left corner of the document.

Returns

IShape: The IShape object.

AddConnectorInPixel(string, ConnectorType, double, double, double, double)

Creates a connector. Returns the IShape object that represents the new connector.

IShape AddConnectorInPixel(string name, ConnectorType type, double beginX, double beginY, double endX, double endY)

Parameters

name string: The connector name.
type ConnectorType: The connector type to add.
beginX double: The horizontal position (in pixels) of the connector's starting point relative to the upper-left corner of the document.
beginY double: The vertical position (in pixels) of the connector's starting point relative to the upper-left corner of the document.
endX double: The horizontal position (in pixels) of the connector's end point relative to the upper-left corner of the document.
endY double: The veritcal position (in pixels) of the connector's end point relative to the upper-left corner of the document.

Returns

IShape: The IShape object.

AddPicture(Stream, ImageType, IRange)

Creates a picture from an existing stream at the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.
Returns the IShape object that represents the new picture.

IShape AddPicture(Stream stream, ImageType type, IRange targetRange)

Parameters

stream System.IO.Stream: The stream from which the object is to be created.
type ImageType: Specifies the type of picture to create.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

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

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

IShape 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 picture to create.
left double: The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in points.
height double: The height of the picture, in points.

Returns

IShape: The IShapeThe object.

AddPicture(string, IRange)

Creates a picture from an existing file at the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.
Returns the IShape object that represents the new picture.

IShape AddPicture(string filename, IRange targetRange)

Parameters

filename string: The file from which the object is to be created.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

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

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

IShape 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 picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in points.
height double: The height of the picture, in points.

Returns

IShape: The IShapeThe object.

AddPicture(string, Stream, ImageType, IRange)

IShape AddPicture(string name, Stream stream, ImageType type, IRange targetRange)

Parameters

name string: The picture name
stream System.IO.Stream: The stream from which the object is to be created.
type ImageType: Specifies the type of picture to create.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

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

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

IShape AddPicture(string name, Stream stream, ImageType type, double left, double top, double width, double height)

Parameters

name string: The picture name.
stream System.IO.Stream: The stream from which the object is to be created.
type ImageType: Specifies the type of picture to create.
left double: The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in points.
height double: The height of the picture, in points.

Returns

IShape: The IShapeThe object.

AddPicture(string, string, IRange)

IShape AddPicture(string name, string filename, IRange targetRange)

Parameters

name string: The picture name.
filename string: The file from which the object is to be created.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

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

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

IShape AddPicture(string name, string filename, double left, double top, double width, double height)

Parameters

name string: The picture name.
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 picture relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in points.
height double: The height of the picture, in points.

Returns

IShape: The IShapeThe object.

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

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

IShape 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 picture to create.
left double: The position (in pixels) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in pixels) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in pixels.
height double: The height of the picture, in pixels.

Returns

IShape: The IShape object.

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

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

IShape 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 picture relative to the upper-left corner of the document.
top double: The position (in pixels) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in pixels.
height double: The height of the picture, in pixels.

Returns

IShape: The IShape object.

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

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

IShape AddPictureInPixel(string name, Stream stream, ImageType type, double left, double top, double width, double height)

Parameters

name string: The picture name.
stream System.IO.Stream: The stream from which the object is to be created.
type ImageType: Specifies the type of picture to create.
left double: The position (in pixels) of the upper-left corner of the picture relative to the upper-left corner of the document.
top double: The position (in pixels) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in pixels.
height double: The height of the picture, in pixels.

Returns

IShape: The IShape object.

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

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

IShape AddPictureInPixel(string name, string filename, double left, double top, double width, double height)

Parameters

name string: The picture name.
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 picture relative to the upper-left corner of the document.
top double: The position (in pixels) of the upper-left corner of the picture relative to the top of the document.
width double: The width of the picture, in pixels.
height double: The height of the picture, in pixels.

Returns

IShape: The IShape object.

AddShape(AutoShapeType, IRange)

Returns the IShape object that represents the new AutoShape at the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.

IShape AddShape(AutoShapeType type, IRange targetRange)

Parameters

type AutoShapeType: Specifies the type of AutoShape to create.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

AddShape(AutoShapeType, double, double, double, double)

Returns the IShape object that represents the new AutoShape in a worksheet.

IShape AddShape(AutoShapeType type, double left, double top, double width, double height)

Parameters

type AutoShapeType: Specifies the type of AutoShape to create.
left double: The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
width double: The width and height of the AutoShape's boundary box, in points.
height double: The width and height of the AutoShape's boundary box, in points.

Returns

IShape: The IShapeThe object.

AddShape(string, AutoShapeType, IRange)

Returns the IShape object that represents the new AutoShape at the specified range on the current sheet.
The sheet of targetRange and the sheet of the shape being added must be the same sheet.

IShape AddShape(string name, AutoShapeType type, IRange targetRange)

Parameters

name string: The shape name.
type AutoShapeType: Specifies the type of AutoShape to create.
targetRange IRange: The target range of the current sheet.

Returns

IShape: The IShapeThe object.

AddShape(string, AutoShapeType, double, double, double, double)

Returns the IShape object that represents the new AutoShape in a worksheet.

IShape AddShape(string name, AutoShapeType type, double left, double top, double width, double height)

Parameters

name string: The shape name.
type AutoShapeType: Specifies the type of AutoShape to create.
left double: The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
top double: The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
width double: The width and height of the AutoShape's boundary box, in points.
height double: The width and height of the AutoShape's boundary box, in points.

Returns

IShape: The IShapeThe object.

AddShapeInPixel(AutoShapeType, double, double, double, double)

Returns the IShape object that represents the new AutoShape in a worksheet.

IShape AddShapeInPixel(AutoShapeType type, double left, double top, double width, double height)

Parameters

type AutoShapeType: Specifies the type of AutoShape to create.
left double: The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
top double: The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
width double: The width and height of the AutoShape's boundary box, in pixels.
height double: The width and height of the AutoShape's boundary box, in pixels.

Returns

IShape: The IShape object.

AddShapeInPixel(string, AutoShapeType, double, double, double, double)

Returns the IShape object that represents the new AutoShape in a worksheet.

IShape AddShapeInPixel(string name, AutoShapeType type, double left, double top, double width, double height)

Parameters

name string: The shape name.
type AutoShapeType: Specifies the type of AutoShape to create.
left double: The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
top double: The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.
width double: The width and height of the AutoShape's boundary box, in pixels.
height double: The width and height of the AutoShape's boundary box, in pixels.

Returns

IShape: The IShape object.