Back to Devexpress

Workbook.ShapeRemoved Event

officefileapi-devexpress-dot-spreadsheet-dot-workbook-80b28c57.md

latest2.8 KB
Original Source

Workbook.ShapeRemoved Event

Occurs after a drawing object has been removed from a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public event ShapeChangedEventHandler ShapeRemoved
vb
Public Event ShapeRemoved As ShapeChangedEventHandler

Event Data

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

PropertyDescription
ShapeIdGets the ID value of the drawing object that has been inserted or removed.
ShapeNameGets the name of the drawing object that has been inserted or removed.
ShapeTypeGets the type of the drawing object that has been inserted or removed.

Remarks

Handle the ShapeRemoved event to perform specific actions each time a drawing object is removed from a worksheet. To obtain the type of the removed drawing object, use the ShapeType parameter.

To prevent a drawing object from being removed, use the Workbook.ShapeRemoving event that is raised before a drawing object is deleted.

Note

By default, the ShapeRemoved event does not occur when removing a 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 Workbook.Options.Events.RaiseOnModificationsViaAPI notation) to true.

Implements

ShapeRemoved

See Also

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace