Back to Devexpress

SpreadsheetControl Events

windowsforms-devexpress-dot-xtraspreadsheet-dot-spreadsheetcontrol-dot-underscore-events.md

latest44.0 KB
Original Source

SpreadsheetControl Events

Emulates the Microsoft® Excel® appearance and allows you to create, load, edit, save and print spreadsheet documents.

NameDescription
ActiveSheetChangedOccurs after an active worksheet has been changed via the SpreadsheetControl‘s UI.
ActiveSheetChangingOccurs when an active worksheet is about to be changed via the SpreadsheetControl‘s UI.
AfterDropRangeOccurs after a user dropped the selected cell range in a new location.
AfterFillRangeOccurs after a cell range was automatically filled with data based on values in the source range.
AfterGroupProcessingFires after the expand/collapse operation is executed for row or column groups in a worksheet.
AfterOutlineButtonClickFires after a user clicks an outline button for row or column groups.
AutoSizeChangedThis event is not relevant for this class. Inherited from Control.
BackColorChangedOccurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChangedOccurs when the value of the BackgroundImage property changes. Inherited from Control.
BackgroundImageLayoutChangedOccurs when the BackgroundImageLayout property changes. Inherited from Control.
BeforeDisposeOccurs before the SpreadsheetControl control is released from memory.
BeforeDragRangeOccurs when a user starts to drag the selected cell range.
BeforeDropRangeOccurs when a user is about to drop the selected cell range in a new location.
BeforeEncodingDetectionOccurs before detecting the encoding of the loaded CSV or TXT data.
BeforeExportOccurs before the document is saved (exported to a certain format).
BeforeFillRangeOccurs when a user drags the fill handle to populate cells with data based on values in the source range.
BeforeGroupProcessingFires before the expand/collapse operation is executed for row or column groups in a worksheet.
BeforeImportOccurs before a document is loaded (imported from an external source).
BeforeOutlineButtonClickFires before a user clicks an outline button for row or column groups.
BeforePrintSheetProvides the capability to prevent printing of the required worksheets in a workbook.
BindingContextChangedOccurs when the value of the BindingContext property changes. Inherited from Control.
CausesValidationChangedOccurs when the value of the CausesValidation property changes. Inherited from Control.
CellBeginEditOccurs before a cell editor is opened.
CellCancelEditOccurs before the cell editor is closed and the entered value is rolled back.
CellEditorOpenedOccurs after a cell editor was activated by a user.
CellEndEditOccurs before a cell editor is closed and the entered value is committed.
CellValueChangedOccurs after the cell content was changed via the SpreadsheetControl UI.
ChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
ClickOccurs when the control is clicked. Inherited from Control.
ClientSizeChangedOccurs when the value of the ClientSize property changes. Inherited from Control.
ClipboardDataObtainedOccurs after data on the clipboard is obtained and recognized, but before data is pasted.
ClipboardDataPastedOccurs after data was pasted from the clipboard onto a worksheet.
ClipboardDataPastingOccurs before data is pasted into destination cells.
ColumnsInsertedOccurs after new columns have been added to a worksheet via the SpreadsheetControl‘s UI.
ColumnsInsertingOccurs when new columns are about to be inserted into a worksheet.
ColumnsRemovedOccurs after columns have been deleted from a worksheet via the SpreadsheetControl‘s UI.
ColumnsRemovingOccurs when columns are about to be deleted from a worksheet.
ColumnWidthChangedOccurs after the column width was changed.
CommentInsertedOccurs when a comment is inserted.
CommentInsertingOccurs before inserting a comment.
CommentRemovedOccurs when a comment is deleted.
CommentRemovingOccurs before deleting a comment.
ContentChangedOccurs when the document content is changed.
ContextMenuChangedOccurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAddedOccurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemovedOccurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CopiedRangePastedOccurs after the range content has been pasted into target cells.
CopiedRangePastingOccurs before the range content is pasted into target cells.
CursorChangedOccurs when the value of the Cursor property changes. Inherited from Control.
CustomAssemblyLoadingOccurs before a custom assembly is loaded for use as the Entity Framework data source during mail merge and allows you to cancel the operation.
CustomCellEditAllows you to assign a custom in-place editor to a cell.
CustomDrawCellAllows you to paint cell content.
CustomDrawCellBackgroundPerforms custom painting of the cell background.
CustomDrawColumnHeaderEnables the column header to be painted manually.
CustomDrawColumnHeaderBackgroundEnables the column header background to be painted manually.
CustomDrawCommentIndicatorAllows you to customize comment indicators.
CustomDrawFrozenPaneBorderEnables frozen pane borders to be painted manually.
CustomDrawRowHeaderEnables the row header to be painted manually.
CustomDrawRowHeaderBackgroundEnables the row header background to be painted manually.
DataBindingWarningOccurs before a data binding warning dialog is shown in the SpreadsheetControl.
DefinedNameAddedOccurs after the defined name is created.
DefinedNameConflictResolvingOccurs when a formula or sheet being moved or copied contains a defined name that already exists in the destination worksheet or workbook.
DefinedNameDeletedOccurs after the defined name is deleted.
DefinedNameDeletingOccurs before a Defined Name is deleted.
DefinedNameEditedOccurs after the defined name parameters were changed.
DefinedNameEditingOccurs before a Defined Name is being edited.
DefinedNameValidatingOccurs when a new Defined Name is created before it is added to a collection.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChangedOccurs when the value of the Dock property changes. Inherited from Control.
DocumentClosingOccurs when a document that has not yet been saved is about to be closed.
DocumentLoadedOccurs after a document is loaded into the Spreadsheet control.
DocumentPropertiesChangedOccurs after one of the DocumentProperties is changed.
DocumentSavedOccurs after a document has been saved.
DoubleClickOccurs when the control is double-clicked. Inherited from Control.
DragDropOccurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnterOccurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeaveOccurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragOverOccurs when an object is dragged over the control’s bounds. Inherited from Control.
EmptyDocumentCreatedOccurs when a new document is created in the SpreadsheetControl.
EnabledChangedOccurs when the Enabled property value has changed. Inherited from Control.
EncryptedFileIntegrityCheckFailedOccurs when the encrypted file does not pass data integrity verification.
EncryptedFilePasswordCheckFailedOccurs when the encryption password is empty or invalid.
EncryptedFilePasswordRequestOccurs when the WorkbookImportOptions.Password property is not set or contains the wrong password.
EnterOccurs when the control is entered. Inherited from Control.
FontChangedOccurs when the Font property value changes. Inherited from Control.
ForeColorChangedOccurs when the ForeColor property value changes. Inherited from Control.
GiveFeedbackOccurs during a drag operation. Inherited from Control.
GotFocusOccurs when the control receives focus. Inherited from Control.
GroupStateChangedFires after row or column groups are expanded or collapsed.
GroupStateChangingFires before row or column groups are expanded or collapsed.
HandleCreatedOccurs when a handle is created for the control. Inherited from Control.
HandleDestroyedOccurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequestedOccurs when the user requests help for a control. Inherited from Control.
HyperlinkClickOccurs when an end-user activates the hyperlink before navigating to the referenced location.
ImeModeChangedOccurs when the ImeMode property has changed. Inherited from Control.
InitializeDocumentOccurs before a document is loaded. Handle this event to set the initial document settings.
InvalidatedOccurs when a control’s display requires redrawing. Inherited from Control.
InvalidFormatExceptionFires when the supplied data could not be recognized as data in the assumed format for import.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from Control.
KeyPressOccurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUpOccurs when a key is released while the control has focus. Inherited from Control.
LayoutOccurs when a control should reposition its child controls. Inherited from Control.
LeaveOccurs when the input focus leaves the control. Inherited from Control.
LocationChangedOccurs when the Location property value has changed. Inherited from Control.
LostFocusOccurs when the control loses focus. Inherited from Control.
MarginChangedOccurs when the control’s margin changes. Inherited from Control.
ModifiedChangedOccurs when the value of the SpreadsheetControl.Modified property is changed.
MouseCaptureChangedOccurs when the control loses mouse capture. Inherited from Control.
MouseClickOccurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClickOccurs when the control is double clicked by the mouse. Inherited from Control.
MouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnterOccurs when the mouse pointer enters the control. Inherited from Control.
MouseHoverOccurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeaveOccurs when the mouse pointer leaves the control. Inherited from Control.
MouseMoveOccurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUpOccurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheelOccurs when the mouse wheel moves while the control has focus. Inherited from Control.
MoveOccurs when the control is moved. Inherited from Control.
PaddingChangedOccurs when the control’s padding changes. Inherited from Control.
PaintOccurs when the control is redrawn. Inherited from Control.
PanesFrozenOccurs after a worksheet area has been frozen via the SpreadsheetControl‘s UI.
PanesUnfrozenOccurs after a frozen worksheet area has been unlocked via the SpreadsheetControl‘s UI.
ParentChangedOccurs when the Parent property value changes. Inherited from Control.
PopupMenuShowingOccurs when a popup menu is about to be displayed for the SpreadsheetControl‘s visual elements.
PreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
PropertyChangedOccurs every time any of the SpreadsheetControl class properties has changed its value.
ProtectionWarningOccurs when attempting to edit a locked cell in a protected worksheet.
QueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
RangeCopiedOccurs after the range content has been copied.
RangeCopyingOccurs before a cell range is copied in a worksheet.
ReadOnlyChangedOccurs when the SpreadsheetControl‘s read-only state is changed.
RegionChangedOccurs when the value of the Region property changes. Inherited from Control.
ResizeOccurs when the control is resized. Inherited from Control.
RightToLeftChangedOccurs when the RightToLeft property value changes. Inherited from Control.
RowHeightChangedOccurs after the row height was changed.
RowsInsertedOccurs after new rows have been added to a worksheet via the SpreadsheetControl‘s UI.
RowsInsertingOccurs when new rows are about to be inserted into a worksheet.
RowsRemovedOccurs after rows have been deleted from a worksheet via the SpreadsheetControl‘s UI.
RowsRemovingOccurs when rows are about to be deleted from a worksheet.
ScrollPositionChangedOccurs when a worksheet is being scrolled in the SpreadsheetControl‘s UI.
SelectionChangedFires when the selection changes in an active worksheet.
ShapeInsertedOccurs after a drawing object has been inserted into a worksheet.
ShapeRemovedOccurs after a drawing object has been removed from a worksheet.
ShapeRemovingOccurs before a drawing object is removed from a worksheet.
ShapesCopyingOccurs before a drawing object is copied.
SheetInsertedOccurs after a new worksheet has been added into a workbook via the SpreadsheetControl‘s UI.
SheetRemovedOccurs after a worksheet has been removed from a workbook via the SpreadsheetControl‘s UI.
SheetRemovingOccurs when a worksheet is about to be removed from a workbook.
SheetRenamedOccurs after a worksheet has been renamed via the SpreadsheetControl‘s UI.
SheetRenamingOccurs when a worksheet is about to be renamed via the SpreadsheetControl‘s UI.
SizeChangedOccurs when the Size property value changes. Inherited from Control.
StyleChangedOccurs when the control style changes. Inherited from Control.
SystemColorsChangedOccurs when the system colors change. Inherited from Control.
TabIndexChangedOccurs when the TabIndex property value changes. Inherited from Control.
TabStopChangedOccurs when the TabStop property value changes. Inherited from Control.
TextChangedOccurs when the Text property value changes. Inherited from Control.
UnhandledExceptionThis event is raised when an exception, unhandled by the SpreadsheetControl, occurs.
UnitChangedFires after a unit of measurement used in the workbook is changed.
UnitChangingFires before a unit of measurement used within the workbook is changed.
UpdateUIRaised when changes occur which may affect the control’s UI.
ValidateCustomSqlQueryAllows validation of the custom SQL query created using the Data Source Wizard.
ValidatedOccurs when the control is finished validating. Inherited from Control.
ValidatingOccurs when the control is validating. Inherited from Control.
VisibleChangedOccurs when the Visible property value changes. Inherited from Control.
VisibleRangeChangedOccurs after the visible cell range was changed in the Spreadsheet control.
ZoomChangedOccurs when the current zoom level of the active worksheet has been changed via the SpreadsheetControl‘s UI.

See Also

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.XtraSpreadsheet Namespace