ASPxClientSpreadsheet Members

A client-side equivalent of the ASPxSpreadsheet object.

Properties

Name Description
name Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

Methods

Name Description
AdjustControl Modifies the control's size against the control's container. Inherited from ASPxClientControl.
AdjustControls Modifies the controls size within the specified container. Inherited from ASPxClientControl.
ApplyCellEdit Applies a value stored within the editor to the active cell
CancelCellEdit Cancels editing of the active cell.
Cast(obj) static Converts the specified object to the ASPxClientSpreadsheet type.
Focus Sets input focus to the Spreadsheet.
GetActiveCellValue Gets the value of the currently active cell.
GetActiveSheetName Gets a name of the worksheet that is currently displayed within the spreadsheet.
GetCellBounds(colModelIndex, rowModelIndex) Gets the specified cell's bounds.
GetCellComment(colModelIndex, rowModelIndex) Returns the comment associated with the specified data cell.
GetCellValue(colModelIndex, rowModelIndex) Gets the value of the specified cell.
GetClientVisible Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetControlCollection Returns a collection of client web control objects. Inherited from ASPxClientControl.
GetEditMode Returns the type of the element currently being edited in the Spreadsheet control.
GetHeight Returns the control's height. Inherited from ASPxClientControl.
GetMainElement Returns an HTML element that is the root of the control's hierarchy. Inherited from ASPxClientControlBase.
GetParentControl Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetRibbon Gets access to the client ribbon object.
GetSelection Returns the current selection made in a Spreadsheet.
GetViewMode Returns the control's view mode.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidth Returns the control's width. Inherited from ASPxClientControl.
HasUnsavedChanges Indicates whether any unsaved changes are contained in the current document.
InCallback Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
PerformCallback(parameter) Sends a callback to the server and generates the server-side ASPxSpreadsheet.Callback event, passing it the specified argument.
PerformDocumentCallback(parameter) Obsolete. Sends a callback to the server and generates the server-side ASPxSpreadsheet.DocumentCallback event, passing it the specified argument.
Print(target) Invokes the browser print dialog to print the sheet content.
ReconnectToExternalRibbon Reconnects the Spreadsheet to an external ribbon.
SendMessageToAssistiveTechnology(message) Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetCellEditorText(text) Specifies the editor's value of the edited cell.
SetClientVisible(visible) Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetFullscreenMode(fullscreen) Enables you to switch the full-screen mode of the Spreadsheet.
SetHeight(height) Specifies the control's height. Note that this method is not in effect for some controls. Inherited from ASPxClientControl.
SetViewMode(mode) Specifies the control's view mode.
SetVisible(visible) Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetWidth(width) Specifies the control's width in pixels. Inherited from ASPxClientControl.

Events

Name Description
BeginCallback Occurs when a callback for server-side processing is initiated.
BeginSynchronization Fires after a client change has been made to the document and the client-server synchronization starts to apply the change on the server.
CallbackError Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientSpreadsheet.
CellBeginEdit Occurs before the cell editor is opened.
CellCancelEdit Occurs before the active cell's editor is closed and the entered value is rolled back.
CellEndEdit Occurs before the cell editor is closed and the entered value is committed.
CustomCommandExecuted Occurs after a custom command has been executed on the client side.
DocumentChanged Fires if any change is made to the Spreadsheet's document on the client.
EndCallback Occurs on the client side after a callback's server-side processing has been completed.
EndSynchronization Fires after a document change has been applied to the server and server and client document models have been synchronized.
HyperlinkClick Occurs on the client side after a hyperlink is clicked within the Spreadsheet's document.
Init Occurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
PopupMenuShowing Occurs before the context menu is displayed and allows menu customization.
ProtectionWarning Occurs when attempting to edit a locked cell in a protected worksheet.
SelectionChanged Occurs on the client when a selection is changed in the ASPxSpreadsheet.
ViewModeChanged Occurs when the control's view mode is changed.
See Also