Back to Devexpress

ASPxSpreadsheet Properties

aspnet-devexpress-dot-web-dot-aspxspreadsheet-dot-aspxspreadsheet-dot-underscore-properties.md

latest37.5 KB
Original Source

ASPxSpreadsheet Properties

A spreadsheet control.

NameDescription
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
ActiveTabIndexGets or sets the index of the active ribbon tab within the ASPxSpreadsheet control.
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AssociatedRibbonIDSpecifies the ID of an ASPxRibbon control, used as an external toolbar.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
AutoSaveModeSpecifies whether the autosave mode is enabled.
AutoSaveTimeoutGets or sets the timeout for auto-saving.
BackColorGets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImageGets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility staticProvides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BorderGets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottomGets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeftGets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRightGets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTopGets the settings of the web control’s top border. Inherited from ASPxWebControl.
ChildControlsCreated protectedGets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientIDGets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protectedGets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceNameGets or sets the ASPxSpreadsheet‘s client programmatic identifier.
ClientSideEventsGets an object that lists the client-side events specific to the ASPxSpreadsheet.
ConfirmOnLosingChangesGets or sets the text of the confirmation message that is displayed when any unsaved data changes are going to be lost.
Context protectedGets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ControlsGets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreatedGets 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.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePathGets or sets the path to a CSS file that defines the web control’s appearance. Inherited from ASPxWebControl.
CssPostfixGets or sets a CSS class name postfix that identifies style settings to be applied to the control. Inherited from ASPxWebControl.
CursorGets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyleGets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl.
DocumentProvides access to a workbook loaded into the control.
DocumentIdSpecifies the unique identifier of the active document.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableClientSideAPIGets or sets a value that specifies whether the ASPxSpreadsheet can be manipulated on the client side in code.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableThemingGets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewStateGets 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.
EncodeHtmlGets or sets whether to encode editor value and content. Inherited from ASPxWebControl.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FontGets the font properties associated with the Web server control. Inherited from WebControl.
ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
FullscreenModeSpecifies whether or not the ASPxSpreadsheet control is used in full-screen mode.
GlobalAccessibilityCompliant staticGets 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 staticGets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries staticObsolete. 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 staticGets 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 staticGets 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 staticGets 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 staticGets 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 staticGets 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.
HasAttributesGets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protectedGets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
HeightGets or sets the height of the web server control. Inherited from ASPxWebControl.
IDGets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protectedGets the character used to separate control identifiers. Inherited from Control.
ImagesProvides access to the settings that define images displayed within the ASPxSpreadsheet.
ImagesFileManagerProvides access to the settings that define images displayed within the FileManager used within some built-in dialogs.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallbackGets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protectedGets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
JSPropertiesEnables you to supply any server data that can then be parsed on the client.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
NamingContainerGets 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.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
ParentGets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImagesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStylesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
RaiseEventsOnModificationsViaAPI staticGets 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.
ReadOnlyGets or sets a value indicating whether an end-user can change the Spreadsheet’s contents at runtime.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RibbonContextTabCategoriesGets the collection of ribbon context tab categories.
RibbonModeSpecifies the type of the ASPxSpreadsheet toolbar.
RibbonTabsProvides access to the collection of Ribbon tabs.
SettingsProvides access to the ASPxSpreadsheet‘s main settings.
SettingsDialogFormObsolete. Provides access to the settings that relate to customization of dialog form elements.
SettingsDialogsGets settings concerning customization of dialog form elements.
SettingsDocumentSelectorProvides access to settings that are related to the FileManager used within some built-in dialogs dialog.
SettingsLoadingPanelProvides access to the loading panel’s settings.
SettingsViewProvides access to settings allowing you to manipulate the Spreadsheet’s view mode.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
ShowConfirmOnLosingChangesGets 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.
ShowFormulaBarGets or sets a value that specifies the Formula Bar’s visibility.
ShowSheetTabsGets or sets a value specifying the sheet tab selector‘s visibility.
SiteGets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinIDGets or sets the skin to apply to the control. Inherited from WebControl.
StyleGets 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.
StylesProvides access to the style settings that control the appearance of the ASPxSpreadsheet elements.
StylesButtonProvides access to the style settings that define the appearance of button elements used by the ASPxSpreadsheet control (within dialog forms, for instance).
StylesEditorsProvides access to the style settings that define the appearance of editor elements used by the ASPxSpreadsheet control (for instance, within dialog forms).
StylesFileManagerProvides 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).
StylesFormulaAutoCompeteGets the settings defining the appearance of elements used by the Spreadsheet’s Formula AutoComplete feature.
StylesFormulaBarGets the settings that define the appearance of elements used within the Spreadsheet’s Formula Bar.
StylesPopupMenuProvides access to the style settings that define the appearance of the ASPxSpreadsheet‘s context menu.
StylesRibbonProvides access to the style settings that define the appearance of the ASPxSpreadsheet‘s ribbon toolbar elements.
StylesTabControlProvides access to the style settings defining the appearance of tab control elements used in the ASPxSpreadsheet.
SupportsDisabledAttributeGets 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.
IControlBuilderAccessor.ControlBuilderFor a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserDataFor a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindingsFor a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindingsFor a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.ExpressionsFor a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressionsFor a description of this member, see HasExpressions. Inherited from Control.
TabIndexGets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protectedGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protectedGets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControlGets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
TemporaryFolderObsolete. Gets or sets the temporary folder path.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
UniqueIDGets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protectedGets 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 protectedGets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateModeGets or sets the view-state mode of this control. Inherited from Control.
VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.
WorkDirectorySpecifies the work directory.
WorksheetDisplayAreaProvides access to an object enabling you to specify a worksheet area that is visible in the Spreadsheet and allows end-user input.

See Also

ASPxSpreadsheet Class

ASPxSpreadsheet Members

DevExpress.Web.ASPxSpreadsheet Namespace