ASPxSpreadsheet Members

A spreadsheet control.

Constructors

Name Description
ASPxSpreadsheet()

Initializes a new instance of the ASPxSpreadsheet class.

Properties

Name Description
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl)
ActiveTabIndex

Gets or sets the index of the active ribbon tab within the ASPxSpreadsheet control.

Adapter Gets the browser-specific adapter for the control.
(Inherited from Control)
AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control)
AssociatedRibbonID

Specifies the ID of an ASPxRibbon control, used as an external toolbar.

Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl)
AutoSaveMode

Gets or sets the auto-saving mode.

AutoSaveTimeout

Gets or sets the timeout for auto-saving.

BackColor Gets or sets the background color of the Web server control.
(Inherited from WebControl)
BackgroundImage

Gets the web control's background image.

(Inherited from ASPxWebControl)
BackwardCompatibility static

Provides access to the control's backward compatibility settings.

(Inherited from ASPxWebControl)
Border

Gets the web control's border settings.

(Inherited from ASPxWebControl)
BorderBottom

Gets the settings of the web control's bottom border.

(Inherited from ASPxWebControl)
BorderColor

Gets or sets the border color of the web control. Use the BorderWrapper.BorderColor property instead.

(Inherited from ASPxWebControl)
BorderLeft

Gets the settings of the web control's left border.

(Inherited from ASPxWebControl)
BorderRight

Gets the settings of the web control's right border.

(Inherited from ASPxWebControl)
BorderStyle

Gets or sets the border style of the web control. Use the BorderWrapper.BorderStyle property instead.

(Inherited from ASPxWebControl)
BorderTop

Gets the settings of the web control's top border.

(Inherited from ASPxWebControl)
BorderWidth

Gets or sets the border width of the web control. Use the BorderWrapper.BorderWidth property instead.

(Inherited from ASPxWebControl)
ChildControlsCreated Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control)
ClientID

Gets the control's identifier generated by ASP.NET.

(Inherited from ASPxWebControlBase)
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property.
(Inherited from Control)
ClientIDSeparator Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control)
ClientInstanceName

Gets or sets the ASPxSpreadsheet's client programmatic identifier.

ClientSideEvents

Gets an object that lists the client-side events specific to the ASPxSpreadsheet.

ConfirmOnLosingChanges

Gets or sets the text of the confirmation message that is displayed when any unsaved data changes are going to be lost.

Context Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control)
ControlStyle Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl)
ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
(Inherited from WebControl)
Controls

Gets the web control's collection of child controls.

(Inherited from ASPxWebControlBase)
CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from WebControl)
CssFilePath

Gets or sets the path to a CSS file that defines the web control's appearance.

(Inherited from ASPxWebControl)
CssPostfix

Gets or sets a CSS class name postfix that identifies style settings to be applied to the control.

(Inherited from ASPxWebControl)
Cursor

Gets or sets the type of cursor to display when the mouse pointer is over the web control.

(Inherited from ASPxWebControl)
DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer.
(Inherited from Control)
DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl.
(Inherited from Control)
DisabledCssClass static Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled.
(Inherited from WebControl)
DisabledStyle

Gets the style settings which define a control's appearance in the disabled state.

(Inherited from ASPxWebControl)
Document

Provides access to a workbook loaded into the control.

DocumentId

Gets or sets the document's unique identifier.

EmptyImage static

Obsolete. Gets the settings of an image which is displayed by the control if the control's value is null.

(Inherited from ASPxWebControl)
EnableClientSideAPI

Gets or sets a value that specifies whether the ASPxSpreadsheet can be manipulated on the client side in code.

EnableDefaultAppearance

Obsolete. Specifies whether to enable the control's default appearance.

(Inherited from ASPxWebControl)
EnableTheming Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl)
EnableViewState Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from Control)
Enabled

This member is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools.

EncodeHtml

Gets or sets a value that specifies whether the web control's value and element content are rendered as pure HTML, or HTML markers are stripped out.

(Inherited from ASPxWebControl)
Events Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control)
Font Gets the font properties associated with the Web server control.
(Inherited from WebControl)
ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl)
FullscreenMode

Gets or sets a value specifying whether the ASPxSpreadsheet is used in full-screen mode.

GlobalAccessibilityCompliant static

Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site.

(Inherited from ASPxWebControl)
GlobalCheckReferencesToExternalScripts static

Gets or sets whether the availability and correctness of references to external client scripts (such as jQuery, jQuery UI, Knockout, etc.), which are used by certain DevExpress web controls, are checked.

(Inherited from ASPxWebControl)
GlobalEmbedRequiredClientLibraries static

Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources.

(Inherited from ASPxWebControl)
GlobalRightToLeft static

Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site.

(Inherited from ASPxWebControl)
GlobalStyleSheetTheme static

Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site.

(Inherited from ASPxWebControl)
GlobalTheme static

Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site.

(Inherited from ASPxWebControl)
GlobalThemeBaseColor static

Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site.

(Inherited from ASPxWebControl)
GlobalThemeFont static

Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site.

(Inherited from ASPxWebControl)
HasAttributes Gets a value indicating whether the control has attributes set.
(Inherited from WebControl)
HasChildViewState Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control)
Height

Gets or sets the height of the web server control.

(Inherited from ASPxWebControl)
IControlBuilderAccessor.ControlBuilder For a description of this member, see ControlBuilder.
(Inherited from Control)
IControlDesignerAccessor.UserData For a description of this member, see UserData.
(Inherited from Control)
ID Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control)
IDataBindingsAccessor.DataBindings For a description of this member, see DataBindings.
(Inherited from Control)
IDataBindingsAccessor.HasDataBindings For a description of this member, see HasDataBindings.
(Inherited from Control)
IExpressionsAccessor.Expressions For a description of this member, see Expressions.
(Inherited from Control)
IExpressionsAccessor.HasExpressions For a description of this member, see HasExpressions.
(Inherited from Control)
IdSeparator Gets the character used to separate control identifiers.
(Inherited from Control)
Images

Provides access to the settings that define images displayed within the ASPxSpreadsheet.

ImagesFileManager

Provides access to the settings that define images displayed within the FileManager used within some built-in dialogs.

Initialized

Gets a value indicating whether the web control has been initialized.

(Inherited from ASPxWebControlBase)
IsCallback

Gets a value indicating whether the request is the result of a callback sent by the control.

(Inherited from ASPxWebControl)
IsChildControlStateCleared Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control)
IsTrackingViewState Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control)
IsViewStateEnabled Gets a value indicating whether view state is enabled for this control.
(Inherited from Control)
JSProperties

Enables you to supply any server data that can then be parsed on the client.

LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control)
Loaded

Indicates whether a web control has been loaded into the Page object.

(Inherited from ASPxWebControlBase)
NamingContainer Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
(Inherited from Control)
Page Gets a reference to the Page instance that contains the server control.
(Inherited from Control)
Parent Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control)
ParentImages

This property is not in effect for the ASPxWebControl class.

(Inherited from ASPxWebControl)
ParentStyles

This property is not in effect for the ASPxWebControl class.

(Inherited from ASPxWebControl)
RaiseEventsOnModificationsViaAPI static

Gets or sets whether to raise the ASPxSpreadsheet.CellValueChanged event when changes are made via an API. Normally, these event is fired only when the document is modified by using the control UI.

ReadOnly

Gets or sets a value indicating whether an end-user can change the Spreadsheet's contents at runtime.

RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control)
RibbonContextTabCategories

Gets the collection of ribbon context tab categories.

RibbonKeyboardSupport

Gets or sets a value that specifies whether keyboard navigation is available in the Spreadsheet's ribbon.

RibbonMode

Specifies the type of the ASPxSpreadsheet toolbar.

RibbonTabs

Provides access to the collection of Ribbon tabs.

Settings

Provides access to the ASPxSpreadsheet's main settings.

SettingsDialogForm

Obsolete. Provides access to the settings that relate to customization of dialog form elements.

SettingsDialogs

Gets settings concerning customization of dialog form elements.

SettingsDocumentSelector

Provides access to settings that are related to the FileManager used within some built-in dialogs dialog.

SettingsForms

Gets the settings allowing you to specify paths to dialog forms (UserControls) stored within a web site.

SettingsLoadingPanel

Provides access to the loading panel's settings.

SettingsView

Provides access to settings allowing you to manipulate the Spreadsheet's view mode.

ShadowImage static

Obsolete. Gets the shadow image properties.

(Inherited from ASPxWebControl)
ShowConfirmOnLosingChanges

Gets or sets a value that specifies whether a confirmation alert should be displayed when any unsaved changes are going to be lost due to an end-user action.

ShowFormulaBar

Gets or sets a value that specifies the Formula Bar's visibility.

ShowSheetTabs

Gets or sets a value specifying the sheet tab selector's visibility.

Site Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control)
SkinID Gets or sets the skin to apply to the control.
(Inherited from WebControl)
Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from WebControl)
Styles

Provides access to the style settings that control the appearance of the ASPxSpreadsheet elements.

StylesButton

Provides access to the style settings that define the appearance of button elements used by the ASPxSpreadsheet control (within dialog forms, for instance).

StylesEditors

Provides access to the style settings that define the appearance of editor elements used by the ASPxSpreadsheet control (for instance, within dialog forms).

StylesFileManager

Provides access to the style settings that define the appearance of File Manager elements used by the ASPxSpreadsheet control (for instance, within the File Open dialog).

StylesFormulaAutoCompete

Gets the settings defining the appearance of elements used by the Spreadsheet's Formula AutoComplete feature.

StylesFormulaBar

Gets the settings that define the appearance of elements used within the Spreadsheet's Formula Bar.

StylesPopupMenu

Provides access to the style settings that define the appearance of the ASPxSpreadsheet's context menu.

StylesRibbon

Provides access to the style settings that define the appearance of the ASPxSpreadsheet's ribbon toolbar elements.

StylesTabControl

Provides access to the style settings defining the appearance of tab control elements used in the ASPxSpreadsheet.

SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.
(Inherited from WebControl)
TabIndex Gets or sets the tab index of the Web server control.
(Inherited from WebControl)
TagKey Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl)
TagName Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl)
TemplateControl Gets or sets a reference to the template that contains this control.
(Inherited from Control)
TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control)
TemporaryFolder

Obsolete. Gets or sets the temporary folder path.

Theme

Gets or sets the name of the Theme to be applied to the control.

(Inherited from ASPxWebControl)
ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl)
UniqueID Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control)
ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.
(Inherited from Control)
ViewState Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from Control)
ViewStateIgnoresCase Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control)
ViewStateMode Gets or sets the view-state mode of this control.
(Inherited from Control)
Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control)
Width

Gets or sets the width of the web server control.

(Inherited from ASPxWebControl)
WorkDirectory

Gets or sets the working directory path.

WorksheetDisplayArea

Provides access to an object enabling you to specify a worksheet area that is visible in the Spreadsheet and allows end-user input.

Methods

Name Description
AddAttributesToRender(HtmlTextWriter) Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl)
AddImage(Stream, String)

Adds an image specified by its file name.

AddParsedSubObject(Object) Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control)
AddedControl(Control, Int32) Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control)
ApplyStyle(Style) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from WebControl)
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control.
(Inherited from Control)
BeginRenderTracing(TextWriter, Object) Begins design-time tracing of rendering data.
(Inherited from Control)
BuildProfileTree(String, Boolean) Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(Inherited from Control)
ClearCachedClientID() Sets the cached ClientID value to null.
(Inherited from Control)
ClearChildControlState() Deletes the control-state information for the server control's child controls.
(Inherited from Control)
ClearChildState() Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control)
ClearChildViewState() Deletes the view-state information for all the server control's child controls.
(Inherited from Control)
ClearEffectiveClientIDMode() Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
(Inherited from Control)
Close()

Obsolete. Closes the workbook currently loaded into ASPxSpreadsheet and accessed via the ASPxSpreadsheet.Document property.

CopyBaseAttributes(WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from WebControl)
CreateControlCollection() Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control)
CreateDefaultRibbonTabs(Boolean)

Creates a collection of default Ribbon tabs, specifying what to do with tabs that already exist within the ASPxSpreadsheet.RibbonTabs collection.

DataBind()

Binds the data source to the invoked server control.

(Inherited from ASPxWebControl)
DataBind(Boolean) Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
(Inherited from Control)
DataBindChildren() Binds a data source to the server control's child controls.
(Inherited from Control)
Dispose() Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control)
EndRenderTracing(TextWriter, Object) Ends design-time tracing of rendering data.
(Inherited from Control)
EnsureID() Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control)
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
FindControl(String) Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control)
FindControl(String, Int32) Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.
(Inherited from Control)
Focus()

Sets input focus to the web control.

(Inherited from ASPxWebControl)
GetCallbackErrorMessage() static

Obtains the error info while processing the redirection page.

(Inherited from ASPxWebControl)
GetClientSideEventHandler(String)

Returns the specified client event's handler.

(Inherited from ASPxWebControl)
GetCssClassNamePrefix()

For internal use only.

(Inherited from ASPxWebControl)
GetCssClassNamePrefix(String)

For internal use only.

(Inherited from ASPxWebControl)
GetCurrentDocumentPath()

Gets the path of the currently opened document.

GetDefaultBooleanProperty(String, DefaultBoolean)

For internal use only.

(Inherited from ASPxWebControl)
GetDesignModeState() Gets design-time data for a control.
(Inherited from Control)
GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetImageDirectory()

Gets the image directory path.

GetResourceUrl(Page, String) static

Returns a URL reference to an embedded resource in an assembly.

(Inherited from ASPxWebControl)
GetResourceUrl(Page, Type, String) static

Returns a URL reference to an embedded resource in an assembly.

(Inherited from ASPxWebControl)
GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters.
(Inherited from Control)
GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters.
(Inherited from Control)
GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control)
GetType() Gets the Type of the current instance.
(Inherited from Object)
GetUniqueIDRelativeTo(Control) Returns the prefixed portion of the UniqueID property of the specified control.
(Inherited from Control)
GetWorkDirectory()

Returns the path to the working directory.

HasControls() Determines if the server control contains any child controls.
(Inherited from Control)
HasEvents() Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control)
HtmlEncode(String)

For internal use only.

(Inherited from ASPxWebControl)
HtmlEncode(String, Boolean)

For internal use only.

(Inherited from ASPxWebControl)
IAttributeAccessor.GetAttribute(String) Gets an attribute of the Web control with the specified name.
(Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String) Sets an attribute of the Web control to the specified name and value.
(Inherited from WebControl)
IControlDesignerAccessor.GetDesignModeState() For a description of this member, see GetDesignModeState().
(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary) For a description of this member, see SetDesignModeState(IDictionary).
(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control) For a description of this member, see SetOwnerControl(Control).
(Inherited from Control)
IParserAccessor.AddParsedSubObject(Object) For a description of this member, see AddParsedSubObject(Object).
(Inherited from Control)
IsAccessibilityCompliantRender()

Returns a value that indicates whether the control's accessible html code is rendered.

(Inherited from ASPxWebControl)
IsAccessibilityCompliantRender(Boolean)

Returns a value that indicates whether the control's accessible html code is rendered.

(Inherited from ASPxWebControl)
IsClientSideAPIEnabled()

Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side.

(Inherited from ASPxWebControl)
IsEnabled()

Returns a value that specifies whether a web control is enabled.

(Inherited from ASPxWebControlBase)
IsInternalServiceCallback()

Gets a value indicating whether an internal service callback is being currently processed.

IsLiteralContent() Determines if the server control holds only literal content.
(Inherited from Control)
IsLoading()

This member supports the internal infrastructure and is not intended to be used directly from your code.

(Inherited from ASPxWebControl)
IsVisible()

Returns a value that specifies whether the current web control is displayed.

(Inherited from ASPxWebControlBase)
LoadControlState(Object) Restores control-state information from a previous page request that was saved by the SaveControlState() method.
(Inherited from Control)
MakeResponseCompressed() static

Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client.

(Inherited from ASPxWebControl)
MakeResponseCompressed(Boolean) static

Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6.

(Inherited from ASPxWebControl)
MapPathSecure(String) Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control)
MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
MergeStyle(Style) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from WebControl)
New()

Creates a new empty document within the ASPxSpreadsheet.

OnBubbleEvent(Object, EventArgs) Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control)
OnDataBinding(EventArgs) Raises the DataBinding event.
(Inherited from Control)
OnUnload(EventArgs) Raises the Unload event.
(Inherited from Control)
Open(SpreadsheetDocumentInfo)

Opens the specified document.

Open(String)

Opens a document by the specified path.

Open(String, DocumentFormat)

Opens the specified document.

Open(String, DocumentFormat, Func<Byte[]>)

Opens a document specified by an array of bytes.

Open(String, DocumentFormat, Func<Stream>)

Opens a document specified by a stream.

Open(String, Func<Byte[]>)

Opens a document specified by an array of bytes.

Open(String, Func<Stream>)

Opens a document specified by a stream.

OpenFile(String) Gets a Stream used to read a file.
(Inherited from Control)
RaiseBubbleEvent(Object, EventArgs) Assigns any sources of the event and its information to the control's parent.
(Inherited from Control)
RaiseDocumentSelectorCloudProviderRequest(FileManagerCloudProviderRequestEventArgs)

This member supports the internal infrastructure and is not intended to be used directly from your code.

RaiseDocumentSelectorFileUploading(FileManagerFileUploadEventArgs)

This member supports the internal infrastructure and is not intended to be used directly from your code.

RaiseDocumentSelectorFolderCreating(FileManagerFolderCreateEventArgs)

This member supports the internal infrastructure and is not intended to be used directly from your code.

RaiseDocumentSelectorItemCopying(FileManagerItemCopyEventArgs)

This member supports the internal infrastructure and is not intended to be used directly from your code.

RaiseDocumentSelectorItemDeleting(FileManagerItemDeleteEventArgs)

This member supports the internal infrastructure and is not intended to be used directly from your code.

RaiseDocumentSelectorItemMoving(FileManagerItemMoveEventArgs)

This member supports the internal infrastructure and is not intended to be used directly from your code.

RaiseDocumentSelectorItemRenaming(FileManagerItemRenameEventArgs)

This member supports the internal infrastructure and is not intended to be used directly from your code.

RedirectOnCallback(String) static

Redirects a client to a new URL while processing a callback.

(Inherited from ASPxWebControl)
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RegisterBaseScript(Page) static

Registers base scripts, required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RegisterBaseScript(Page, Boolean) static

Registers base scripts required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RegisterGlobalCustomFunction(ICustomFunction) static

Registers the specified global custom function.

RegisterUtilsScript(Page) static

Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RemovedControl(Control) Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control)
RenderBeginTag(HtmlTextWriter) Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RenderChildren(HtmlTextWriter) Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control)
RenderContents(HtmlTextWriter) Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RenderControl(HtmlTextWriter) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter) Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control)
RenderEndTag(HtmlTextWriter) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RequireClientLibrariesRegistering() static

Specifies whether client library registration is required.

(Inherited from ASPxWebControl)
ResolveAdapter() Gets the control adapter responsible for rendering the specified control.
(Inherited from Control)
ResolveClientUrl(String)

Gets a URL that can be used by the browser.

(Inherited from ASPxWebControlBase)
ResolveUrl(String) Converts a URL into one that is usable on the requesting client.
(Inherited from Control)
Save()

Saves a document in its original format at its original location.

SaveControlState() Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control)
SaveCopy(DocumentFormat)

Saves a document copy using the specified settings.

SaveCopy(Stream, DocumentFormat)

Saves a document copy using the specified settings.

SaveCopy(String)

Saves a document copy using the specified settings.

SetCallbackErrorMessage(String) static

Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred.

(Inherited from ASPxWebControl)
SetClientSideEventHandler(String, String)

Defines a handler for the specified client event.

(Inherited from ASPxWebControl)
SetDefaultBooleanProperty(String, DefaultBoolean, DefaultBoolean)

For internal use only.

(Inherited from ASPxWebControl)
SetDesignModeState(IDictionary) Sets design-time data for a control.
(Inherited from Control)
SetIECompatibilityMode(Int32) static

Switches all DevExpress controls on a page to use the specified IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityMode(Int32, Control) static

Obsolete. Switches all DevExpress controls on the specified page to use the specified IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityModeEdge() static

Switches all DevExpress controls on a page to use the latest IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityModeEdge(Control) static

Obsolete. Switches all DevExpress controls on the specified page to use the latest IE version.

(Inherited from ASPxWebControl)
SetRenderMethodDelegate(RenderMethod) Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control)
SetTraceData(Object, Object) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.
(Inherited from Control)
SetTraceData(Object, Object, Object) Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.
(Inherited from Control)
ToString() Returns a string that represents the current object.
(Inherited from Object)

Events

Name Description
Callback

Fires when a round trip to the server has been initiated either manually (by a call to the client ASPxClientSpreadsheet.PerformCallback method) or automatically by the ASPxSpreadsheet (an internal service callback).

CallbackError static

Allows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control.

(Inherited from ASPxWebControl)
CellValueChanged static

Occurs after the cell content has been changed via the ASPxSpreadsheet UI.

CustomJSProperties

Enables you to supply any server data that can then be parsed on the client.

DataBinding Occurs when the server control binds to a data source.
(Inherited from Control)
Disposed Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from Control)
DocumentCallback

Obsolete. Fires when a round trip to the server has been initiated by the loaded document.

DocumentSelectorCloudProviderRequest

Fires when a cloud provider used in the Document Selector sends a request to a cloud service.

DocumentSelectorFileUploading

Fires before a file is uploaded to the Document Selector and allows you to cancel the action.

DocumentSelectorFolderCreating

Fires on the server side before a folder is created within the FileManager embedded into built-in dialogs, and allows you to cancel the action.

DocumentSelectorItemCopying

Fires before an item is copied within the Document Selector, and allows you to cancel the action.

DocumentSelectorItemDeleting

Fires before an item is deleted within the FileManager embedded into built-in dialogs, and allows you to cancel the action.

DocumentSelectorItemMoving

Fires before an item is moved within the FileManager embedded into built-in dialogs, and allows you to cancel the action.

DocumentSelectorItemRenaming

Fires before an item is renamed within the FileManager embedded into built-in dialogs, and allows you to cancel the action.

Init Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control)
InitializeDocument static

Occurs before a document is loaded. Handle this event to set initial document settings.

Load Occurs when the server control is loaded into the Page object.
(Inherited from Control)
PreRender Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control)
Saving

Allows the current spreadsheet document to be processed before it is saved to the server.

Unload Occurs when the server control is unloaded from memory.
(Inherited from Control)
ViewModeChanging

Fires before the control's view mode is changed and allows you to cancel the action.

See Also