Skip to main content

Spreadsheet Shapes

  • 2 minutes to read

The Spreadsheet Document API library allows you to add shapes to a worksheet, adjust their fill and outline settings, connect and group shapes, create a shape text, or remove shapes from a document. You can print and export documents that contain shapes to PDF/HTML. All shape types are supported: from simple lines and rectangles, to 3-D shapes with advanced effects.

Spreadsheet_Shapes_Diagram

Warning

The Shapes feature is unavailable in applications that use the System.Drawing.Common package v7 and higher in non-Windows environments. The API that uses members from the System.Drawing.Common package throws the PlatformNotSupportedException exception.

Shape API

An individual shape (Shape) is a member of the Worksheet.Shapes collection. The ShapeCollection collection stores all drawing objects embedded in a worksheet (shapes, pictures, and charts). You can access an existing shape by its index in the shape collection or using the ShapeCollection.GetShapeById method. The Shape.ShapeType property allows you to distinguish between different drawing object types within a worksheet.

The ShapeCollection and Shape interfaces provide methods and properties designed to manipulate shapes in a document.

Member Description Example
ShapeCollection.AddShape Creates a shape. How to: Create a Shape
ShapeCollection.AddTextBox Creates a text box. How to: Add Text to a Shape
Shape.ShapeGeometry Specifies a shape’s geometry. How to: Create a Shape
ShapeCollection.GroupShapes Creates a group of shapes. How to: Create a Shape Group
ShapeCollection.UngroupShapes Splits a shape group into individual shapes. How to: Create a Shape Group
ShapeCollection.AddConnector Creates a connector. How to: Create a Shape Connector
Shape.ConnectorFormat Provides access to connector settings. How to: Create a Shape Connector
Shape.ShapeText Provides access to a shape’s text format settings. How to: Add Text to a Shape
ShapeText.Characters Allows you to add text to a shape and specify its font characteristics and paragraph properties. How to: Add Text to a Shape
ShapeFormatBase.Fill Provides access to a shape’s fill options. How to: Change Shape’s Fill and Outline Color
ShapeFormatBase.Outline Provides access to options used to format a shape’s outline. How to: Change Shape’s Fill and Outline Color
ShapeCollection.RemoveAt
Shape.Delete
Removes a shape from a worksheet. How to: Remove a Shape
See Also