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

SpreadsheetControl.ShapeInserted Event

Occurs after a drawing object has been inserted into a worksheet.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.2.dll

NuGet Package: DevExpress.Win.Spreadsheet

#Declaration

public event ShapeChangedEventHandler ShapeInserted

#Event Data

The ShapeInserted event's data class is ShapeChangedEventArgs. The following properties provide information specific to this event:

Property Description
ShapeId Gets the ID value of the drawing object that has been inserted or removed.
ShapeName Gets the name of the drawing object that has been inserted or removed.
ShapeType Gets the type of the drawing object that has been inserted or removed.

#Remarks

Handle the ShapeInserted event to perform specific actions each time an end-user inserts a drawing object into a worksheet via the SpreadsheetControl‘s UI. To obtain the type of the inserted drawing object, use the ShapeType parameter.

After a drawing object has been deleted from a worksheet, the SpreadsheetControl.ShapeRemoved event is raised.

Note

By default, the ShapeInserted event does not occur when inserting a new drawing object in code. However, this event will also be triggered by changes made via an API if you set the WorkbookEventOptions.RaiseOnModificationsViaAPI property (accessible via the SpreadsheetControl.Options.Events.RaiseOnModificationsViaAPI notation) to true.

See Also