Back to Devexpress

SpreadsheetControl.ShapeInserted Event

windowsforms-devexpress-dot-xtraspreadsheet-dot-spreadsheetcontrol-aab79c98.md

latest2.8 KB
Original Source

SpreadsheetControl.ShapeInserted Event

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

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.XtraSpreadsheet.v25.2.dll

NuGet Package : DevExpress.Win.Spreadsheet

Declaration

csharp
public event ShapeChangedEventHandler ShapeInserted
vb
Public Event ShapeInserted As ShapeChangedEventHandler

Event Data

The ShapeInserted 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 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

ShapeRemoved

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.XtraSpreadsheet Namespace