Back to Devexpress

ASPxClientSpreadsheet Members

aspnet-js-aspxclientspreadsheet-dot-underscore-members.md

latest9.7 KB
Original Source

ASPxClientSpreadsheet Members

A client-side equivalent of the ASPxSpreadsheet object.

Properties

NameDescription
nameGets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

Methods

NameDescription
AdjustControlModifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls staticModifies the controls size within the specified container. Inherited from ASPxClientControl.
ApplyCellEditApplies a value stored within the editor to the active cell
CancelCellEditCancels editing of the active cell.
Cast(obj) staticConverts the specified object to the ASPxClientSpreadsheet type.
FocusSets input focus to the Spreadsheet.
GetActiveCellValueGets the value of the currently active cell.
GetActiveSheetNameGets 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.
GetClientVisibleObsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetControlCollection staticReturns a collection of client web control objects. Inherited from ASPxClientControl.
GetEditModeReturns the type of the element currently being edited in the Spreadsheet control.
GetHeightReturns the control’s height. Inherited from ASPxClientControl.
GetMainElementReturns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetParentControlReturns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetRibbonGets access to the client ribbon object.
GetSelectionReturns the current selection made in a Spreadsheet.
GetViewModeReturns the control’s view mode.
GetVisibleReturns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidthReturns the control’s width. Inherited from ASPxClientControl.
HasUnsavedChangesIndicates whether any unsaved changes are contained in the current document.
InCallbackReturns 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.Callback event, passing it the specified argument.
Print(target)Invokes the browser print dialog to print the sheet content.
ReconnectToExternalRibbonReconnects 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

NameDescription
BeforeSendOccurs before a web request is sent to the server.
BeginCallbackOccurs when a callback for server-side processing is initiated.
BeginSynchronizationFires after a client change has been made to the document and the client-server synchronization starts to apply the change on the server.
CallbackErrorFires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientSpreadsheet.
CellBeginEditOccurs before the cell editor is opened.
CellCancelEditOccurs before the active cell’s editor is closed and the entered value is rolled back.
CellEndEditOccurs before the cell editor is closed and the entered value is committed.
CustomCommandExecutedOccurs after a custom command has been executed on the client side.
DocumentChangedFires if any change is made to the Spreadsheet’s document on the client.
EndCallbackOccurs on the client side after a callback’s server-side processing has been completed.
EndSynchronizationFires after a document change has been applied to the server and server and client document models have been synchronized.
HyperlinkClickOccurs on the client side after a hyperlink is clicked within the Spreadsheet’s document.
InitOccurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
PopupMenuShowingOccurs before the context menu is displayed and allows menu customization.
ProtectionWarningOccurs when attempting to edit a locked cell in a protected worksheet.
SelectionChangedOccurs on the client when a selection is changed in the ASPxSpreadsheet.
ViewModeChangedOccurs when the control’s view mode is changed.

See Also

ASPxClientSpreadsheet Class