Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

Charts and Graphics in Spreadsheet Documents

  • 5 minutes to read

This document contains information about embedded drawing objects - shapes, pictures, and charts.

#Create a Drawing Object

The Shape interface is a base interface for all drawing objects. These objects are stored in the ShapeCollection collection, accessible using the Worksheet.Shapes property.

Note

Pictures and charts are contained in two collections: ShapeCollection and PictureCollection or ChartCollection, respectively.

Use the Shape.ShapeType property to determine a drawing object’s type in ShapeCollection.

The table below lists the supported drawing object types and methods used to create them.

Drawing Object Method
Shape ShapeCollection.AddShape
Shape Group ShapeCollection.GroupShapes
Text Box ShapeCollection.AddTextBox
Shape Connector ShapeCollection.AddConnector
Picture PictureCollection.AddPicture
Chart ChartCollection.Add

#Move and Position a Drawing Object

Use an API from the table below to define a drawing object’s location.

Property Description
FloatingObject.Move Moves a floating object by a specified offset.
FloatingObject.Left Gets or sets the distance from the left edge of the worksheet to the top left corner of the drawing object.
FloatingObject.OffsetX Specifies a distance between the top left corner of the floating object and the left edge of the cell where the top left corner of the floating object is located.
FloatingObject.Top Defines the distance between the top edge of the worksheet and the top left corner of the floating object.
FloatingObject.OffsetY Gets a distance between the top left corner of the floating object to the top edge of the cell where the top left corner of the floating object is located.
FloatingObject.TopLeftCell Specifies a cell where the top left corner of a floating object is located.
FloatingObject.BottomRightCell Gets or sets a cell where the bottom right corner of a floating object is located.
Shape.ZOrderPosition Retrieves the position of the current drawing object in the Z-order. The default shapes’ Z-order value is equal to their numerical order in the ShapeCollection.
ShapeCollection.NormalizeZOrder Resets the shapes’ Z-order.

The image below illustrates the distances this API specifies.

Shape_Distances

#Resize and Rotate a Drawing Object

You can specify the drawing object’s size and rotation angle using the following properties.

Users can resize or rotate a drawing object with the handles, which are visible for selected objects.

Shape_Rotation

The FloatingObject.Placement property determines whether the drawing object moves and/or resizes together with underlying cells. For example, set the Placement property to Placement.MoveAndSize to make the drawing object move and resize with cells, as shown below.

You can embed a hyperlink to the drawing object. When an user clicks the drawing object, the link navigates to a certain location on the Internet, or to a file, to a place in a workbook, or it sends an email. Use the Shape.InsertHyperlink method to specify a hyperlink for a drawing object, and use the Shape.RemoveHyperlink method to delete a hyperlink. Refer to the following topic for a code example: How to: Add a Hyperlink to a Picture

#Specify Drawing Object Accessibility Settings

You can specify the following accessibility settings for a shape, picture or a chart:

Shape.AlternativeText
Sets the alternative, text-based representation of a drawing object content. Alternative text helps people that use screen readers to understand the document content.
Shape.Decorative
Specifies that the drawing object does not contain meaningful content to a document and is purely decorative. This options helps screen readers ignore these images and prevent unnecessary distractions for users with visual impairments. Decorative images are marked as artifacts when you export a workbook as an PDF/UA document.

Tip

You can use the AI-powered “Generate Image Description” extension to generate the image description from the User Interface. Refer to the following article for more information: Generate Image Description

#Delete a Drawing Object

The following methods allow you to remove a drawing object.

Remove the element at the specified index
Deletes a drawing object
Shape.Delete

#Implement End-User Restrictions

The SpreadsheetControl allows you to prevent users from modifying drawing objects embedded in a worksheet. Use the following properties to implement user restrictions.

#SpreadsheetControl.Document.Options.DocumentCapabilities

Property Description
WorkbookCapabilitiesOptions.Pictures Specifies whether users can load, insert, and export pictures.
WorkbookCapabilitiesOptions.Charts Specifies whether users can load, insert, and export charts.
WorkbookCapabilitiesOptions.Shapes Specifies whether users can load and export shapes.

#SpreadsheetControl.Options.Behavior.Drawing

Property Description
SpreadsheetDrawingBehaviorOptions.Move Specifies whether end-users can change the position of drawing objects.
SpreadsheetDrawingBehaviorOptions.Resize Specifies whether end-users can change the size of drawing objects.
SpreadsheetDrawingBehaviorOptions.Rotate Specifies whether end-users can rotate drawing objects.
SpreadsheetDrawingBehaviorOptions.ChangeZOrder Specifies whether end-users can change the order of drawing objects in a worksheet.

Set the desired property to DocumentCapability.Disabled or DocumentCapability.Hidden to make the operation unavailable, and disable or hide the corresponding commands in the SpreadsheetControl’s ribbon UI and popup menu.

See Also