GrapeCity.Documents.Excel.Drawing.IShape

Interface IShape

Namespace

GrapeCity.Documents.Excel.Drawing

Assembly

GcDocs.Excel.dll

Represents an object in the drawing layer, such as an AutoShape, chart, or picture. The Shape object is a member of the IShapes collection. The Shapes collection contains all the shapes on a slide.

public interface IShape : IContainer

Inherited Members

IContainer.Top

IContainer.Left

IContainer.Width

IContainer.Height

IContainer.TopInPixel

IContainer.LeftInPixel

IContainer.WidthInPixel

IContainer.HeightInPixel

Properties

Adjustments

Gets a collection of adjustment values for the specified AutoShape or connector.

IAdjustments Adjustments { get; }

Property Value

IAdjustments

AutoShapeType

Returns or sets the shape type for the specified IShape object, which must represent an AutoShape other than a line, freeform drawing, or connector.

AutoShapeType AutoShapeType { get; set; }

Property Value

AutoShapeType

BottomRightCell

Returns the IRange object that represents the cell that lies under the lower-right corner of the object.

IRange BottomRightCell { get; }

Property Value

IRange

Chart

Returns an object that represents the IChart contained in this shape.

IChart Chart { get; }

Property Value

IChart

Connector

Gets whether the specified shape is a connector.

bool Connector { get; }

Property Value

bool

ConnectorFormat

Returns the IConnectorFormat object that contains connector formatting properties. Applies to IShape objects that represent connectors.

IConnectorFormat ConnectorFormat { get; }

Property Value

IConnectorFormat

Control

Gets the associated control.

IControl Control { get; }

Property Value

IControl

The associated control. null (Nothing) if the shape is not a control.

Fill

Returns the IFillFormat object that contains fill formatting properties for the specified chart or shape.

IFillFormat Fill { get; }

Property Value

IFillFormat

Formula

Gets or sets the formula of the current shape.

string Formula { get; set; }

Property Value

string

GroupItems

Returns the IGroupShapes object that represents the individual shapes in the specified group. Use the indexer of IGroupShapes to return a single shape from the group.

IGroupShapes GroupItems { get; }

Property Value

IGroupShapes

HasChart

Returns information if the IShape contains a chart.

bool HasChart { get; }

Property Value

bool

Hyperlink

Returns a Hyperlink object that represents the hyperlink for the shape.

IHyperlink Hyperlink { get; }

Property Value

IHyperlink

IsPrintable

Determines whether the object should be printed.

bool IsPrintable { get; set; }

Property Value

bool

Line

Returns the ILineFormat object that contains line formatting properties for the specified shape.

ILineFormat Line { get; }

Property Value

ILineFormat

Locked

Gets or sets whether the object is locked (True if the object is locked, False if the object can be modified when the sheet is protected, read or write Boolean).

bool Locked { get; set; }

Property Value

bool

Name

Returns or sets the name of the object.

string Name { get; set; }

Property Value

string

Parent

Gets the shape's parent sheet.

IWorksheet Parent { get; }

Property Value

IWorksheet

ParentGroup

Returns the IShape object that represents the common parent shape of a child shape or a range of child shapes.

IShape ParentGroup { get; }

Property Value

IShape

PictureFormat

Returns the IPictureFormat object that contains picture formatting properties for the specified shape.

IPictureFormat PictureFormat { get; }

Property Value

IPictureFormat

Placement

Returns or sets the way the object is attached to the cells below it (read or write Placement).

Placement Placement { get; set; }

Property Value

Placement

Rotation

Returns or sets the rotation of the shape in degrees.

double Rotation { get; set; }

Property Value

double

TextFrame

Returns the ITextFrame object that contains the text and font style properties for the specified shape.

ITextFrame TextFrame { get; }

Property Value

ITextFrame

ThreeD

Returns the IThreeDFormat object that contains 3-D – effect formatting properties for the specified shape.

IThreeDFormat ThreeD { get; }

Property Value

IThreeDFormat

Title

Gets or sets the title of the alternative text associated with the specified shape.

string Title { get; set; }

Property Value

string

TopLeftCell

Returns the IRange object that represents the cell that lies under the upper-left corner of the specified object.

IRange TopLeftCell { get; }

Property Value

IRange

Type

Returns the shape type.

ShapeType Type { get; }

Property Value

ShapeType

Visible

Determines whether the object is visible.

bool Visible { get; set; }

Property Value

bool

ZOrderPosition

Returns the position of the specified shape in the z-order.

int ZOrderPosition { get; }

Property Value

int

Methods

Delete()

Deletes the object.

void Delete()

Duplicate()

Duplicates the shape and returns a reference to the new copy.

IShape Duplicate()

Returns

IShape

FromJson(string)

Generate a new shape from the json string.

void FromJson(string json)

Parameters

json string

the json string represents a shape

ToImage(Stream, ImageType, ImageSaveOptions)

Saves the shape to the specified image stream using options.

void ToImage(Stream stream, ImageType imageType, ImageSaveOptions options)

Parameters

stream System.IO.Stream

The output image stream.

imageType ImageType

Specifies the type of image to create.

options ImageSaveOptions

The options for output image.

ToImage(Stream, ImageType)

Saves the shape to the specified image stream.

void ToImage(Stream stream, ImageType imageType)

Parameters

stream System.IO.Stream

The output image stream.

imageType ImageType

Specifies the type of image to create.

ToImage(string, ImageSaveOptions)

Saves the shape to the specified image file using options.

void ToImage(string fileName, ImageSaveOptions options)

Parameters

fileName string

The output image file.

options ImageSaveOptions

The options for output image.

ToImage(string)

Saves the shape to the specified image file.

void ToImage(string fileName)

Parameters

fileName string

The output image file.

ToJson()

Generates a json string from the shape.

string ToJson()

Returns

string

the json string

Ungroup()

Ungroups any grouped shapes in the specified shape or range of shapes. Disassembles pictures and OLE objects within the specified shape or range of shapes.

IShapeRange Ungroup()

Returns

IShapeRange

A ShapeRange object that represents the ungrouped shapes.

ZOrder(ZOrderType)

Moves the specified shape in front of or behind other shapes in the collection (that is, changes the shape's position in the z-order).

void ZOrder(ZOrderType zOrderType)

Parameters

zOrderType ZOrderType

Required GrapeCity.Documents.Excel.Drawing.ZOrderType. Specifies where to move the specified shape relative to the other shapes.