Back to Devexpress

ASPxGridView Properties

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

latest43.3 KB
Original Source

ASPxGridView Properties

A grid control.

NameDescription
AccessibilityCompliantEnables accessibility support. Inherited from ASPxGridBase.
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
AllColumnsGets the collection of all columns within the ASPxGridView control.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
AutoGenerateColumnsGets or sets whether columns are automatically created for all fields in the underlying data source.
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.
BoundGets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
CaptionGets or sets the text to render in an HTML caption element in an ASPxGridView.
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 control’s client programmatic identifier. Inherited from ASPxGridBase.
ClientSideEventsGets an object that lists the client-side events specific to the GridView.
ClientVisibleGets or sets a value that specifies the initial visibility state of a web control on the client. Inherited from ASPxGridBase.
ColumnsProvides access to a GridView’s column collection.
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.
CssFilePathThis 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. Inherited from ASPxGridBase.
CssPostfixThis 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. Inherited from ASPxGridBase.
CursorGets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
DataColumnsGets the collection of all data columns within the ASPxGridView control.
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.
DataMemberGets or sets the name of the list of data that the data-bound control binds to, in instances where the data source contains more than one distinct list of data items. Inherited from ASPxDataWebControl.
DataSourceSpecifies the object from which the data-bound control retrieves its data items. Inherited from ASPxDataWebControlBase.
DataSourceForceStandardPagingSpecifies whether standard data source paging is used. Inherited from ASPxGridBase.
DataSourceIDSpecifies the control’s data source ID. Inherited from ASPxDataWebControl.
DetailRowsGets the ASPxGridView’s detail rows.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
EditFormLayoutPropertiesProvides access to the edit form layout settings.
EditingRowVisibleIndexGets the index of the data row currently being edited.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when a control’s content is updated via a callback. Inherited from ASPxGridBase.
EnableCallbackCompressionGets or sets whether callback compression is enabled. Inherited from ASPxGridBase.
EnableCallBacksGets or sets a value that specifies whether callback or postback technology is used to manage round trips to the server. Inherited from ASPxGridBase.
EnabledGets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnablePagingCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when changing pages. Inherited from ASPxGridBase.
EnablePagingGesturesGets or sets a value specifying whether an end-user can switch pages with a swipe gesture. Inherited from ASPxGridBase.
EnableRowsCacheSpecifies whether the control caches its data.
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.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FilterEnabledGets or sets whether the current filter is enabled. Inherited from ASPxGridBase.
FilterExpressionGets or sets the filter criterion which is applied to the grid. Inherited from ASPxGridBase.
FixedColumnCountGets the number of fixed columns currently displayed within the ASPxGridView.
FocusedRowIndexSpecifies the index of the focused row.
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.
FormatConditionsProvides access to a collection of format condition rules.
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.
GroupCountGets the number of grouped columns.
GroupSummaryProvides access to group summary items.
GroupSummarySortInfoAllows you to access a ASPxGroupSummarySortInfoCollection object to sort group rows by summary values.
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.
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 GridView’s elements.
ImagesEditorsProvides access to the settings that define images displayed within the ASPxGridView’s editors.
ImagesFilterControlProvides access to the settings that define images displayed in the filter control. Inherited from ASPxGridBase.
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.
IsEditingIndicates whether the ASPxGridView is in edit mode.
IsFilterControlVisibleIndicates whether the filter control is displayed. Inherited from ASPxGridBase.
IsLockUpdateIndicates whether the grid is immediately rendered in response to changing its appearance and/or functionality. Inherited from ASPxGridBase.
IsNewRowEditingIndicates whether a new row is being edited.
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 with data that can then be parsed on the client. Inherited from ASPxGridBase.
KeyboardSupportSpecifies whether keyboard navigation is available in the ASPxGridView control.
KeyFieldNameGets or sets the name of the data source key field. Inherited from ASPxGridBase.
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.
PaddingsGets the padding settings of a grid control. Inherited from ASPxGridBase.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
PageCountGets the number of pages displayed in the grid. Inherited from ASPxGridBase.
PageIndexGets or sets the index of the page currently being selected. Inherited from ASPxGridBase.
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.
PreviewEncodeHtmlGets or sets whether to encode preview row content.
PreviewFieldNameGets or sets the name of the data source field whose values are displayed within the preview rows.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RightToLeftSpecifies whether to apply right-to-left representation to the control. Inherited from ASPxGridBase.
ScrollToVisibleIndexOnClientScrolls the view to the specified data item (row, card or record). Inherited from ASPxGridBase.
SearchPanelFilterGets or sets the filter criterion that is applied to the grid using the search panel. Inherited from ASPxGridBase.
SelectionGets an object that allows you to access row selection methods.
SettingsProvides access to the GridView’s display options.
SettingsAdaptivityProvides access to the grid layout adaptivity settings.
SettingsBehaviorProvides access to the GridView’s behavior settings.
SettingsCommandButtonGets the settings of the ASPxGridView’s command buttons.
SettingsContextMenuProvides access to the GridView’s context menu settings.
SettingsCookiesProvides access to the ASPxGridView cookie and layout settings.
SettingsCustomizationDialogProvides access to the Customization Dialog‘s settings.
SettingsCustomizationWindowObsolete. Provides access to the Customization Window‘s settings.
SettingsDataSecuritySecurity settings that allow you to disable data operations in the ASPxGridView.
SettingsDetailProvides access to the ASPxGridView’s master-detail options.
SettingsEditingProvides access to the ASPxGridView‘s editing settings.
SettingsExportProvides access to the ASPxGridView’s export settings.
SettingsFilterControlProvides access to the filter control‘s settings.
SettingsLoadingPanelProvides access to the loading panel‘s settings.
SettingsPagerProvides access to the Pager‘s settings.
SettingsPopupProvides access to the settings of different grid popup elements.
SettingsResizingProvides access to the GridView’s resizing settings.
SettingsSearchPanelProvides access to the search panel‘s settings.
SettingsTextProvides access to the GridView’s text settings.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
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.
SortCountGets the number of sorted columns (rows for ASPxVerticalGrid). Inherited from ASPxGridBase.
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 ASPxGridView elements.
StylesContextMenuProvides access to the style settings that control the appearance of the context menu displayed within the ASPxGridView.
StylesEditorsProvides access to style settings used to paint ASPxGridView’s editors.
StylesExportProvides access to the style settings defining the appearance of the exported document.
StylesFilterControlGets style settings defining the appearance of the filter control. Inherited from ASPxGridBase.
StylesPagerProvides access to the style settings that control the appearance of the Pager displayed within the ASPxGridView.
StylesPopupProvides access to the style settings defining the appearance of different popup elements within a grid.
StylesToolbarProvides access to the style settings that define the appearance of toolbars. Inherited from ASPxGridBase.
SummaryTextGets or sets a value that describes the ASPxGridView’s contents.
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.
TemplatesProvides access to the templates used to display the ASPxGridView’s elements (cells, rows, etc.).
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolbarsGets the collection of toolbars in the ASPxGridView control.
ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
TotalSummaryProvides access to total summary items.
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.
VisibleColumnsGets a collection of visible columns within the ASPxGridView.
VisibleRowCountGets the number of visible rows within the ASPxGridView.
VisibleStartIndexGets the visible index of the first data item (row, card or record) displayed within the active page. Inherited from ASPxGridBase.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.

See Also

ASPxGridView Class

ASPxGridView Members

DevExpress.Web Namespace