You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32026 lines
1.2 MiB
32026 lines
1.2 MiB
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>DevExpress.XtraGrid.v12.2</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:DevExpress.XtraGrid.GridSplitContainer">
|
|
|
|
<summary>
|
|
<para>Allows a Grid Control to be split horizontally or vertically.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSplitContainer.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridSplitContainer class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.BorderStyle">
|
|
<summary>
|
|
<para>This property is not supported by the GridSplitContainer class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.Collapsed">
|
|
<summary>
|
|
<para>This property is not supported by the GridSplitContainer class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.CollapsePanel">
|
|
<summary>
|
|
<para>This property is not supported by the GridSplitContainer class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.FixedPanel">
|
|
<summary>
|
|
<para>Gets or sets the fixed panel.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.SplitFixedPanel"/> enumeration value which specifies the fixed panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.Grid">
|
|
<summary>
|
|
<para>Gets or sets the Grid to be split. If the Split View is already active, the property specifies the grid displayed in the first view region.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridControl"/> displayed (or to be displayed) in the first view region.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSplitContainer.HideSplitView">
|
|
<summary>
|
|
<para>Removes the splitter and the second grid control.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.Horizontal">
|
|
<summary>
|
|
<para>Gets or sets whether a splitter divides the container into two horizontally or vertically arranged regions.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a splitter divides the container into two horizontally arranged regions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSplitContainer.Initialize">
|
|
<summary>
|
|
<para>Creates and initializes an internal <see cref="T:DevExpress.XtraGrid.GridControl"/>, ensuring that it is ready for further customization.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.IsSplitViewVisible">
|
|
<summary>
|
|
<para>Gets whether the Split Container is currently divided into two regions by a splitter.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Split Container is currently divided into two regions by a splitter; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.PanelVisibility">
|
|
<summary>
|
|
<para>This property is not supported by the GridSplitContainer class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSplitContainer.ShowSplitView">
|
|
<summary>
|
|
<para>Displays a splitter that divides the container into two regions, each displaying a Grid Control.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.SplitChildGrid">
|
|
<summary>
|
|
<para>Gets the grid control displayed in the container's second region.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridControl"/> displayed in the container's second region. <b>null</b> if the Split View is not active (the second region is hidden).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.SplitChildView">
|
|
<summary>
|
|
<para>Gets the main View (<see cref="P:DevExpress.XtraGrid.GridControl.MainView"/>) of the <see cref="P:DevExpress.XtraGrid.GridSplitContainer.SplitChildGrid"/> object.
|
|
</para>
|
|
</summary>
|
|
<value>The main View of the <see cref="P:DevExpress.XtraGrid.GridSplitContainer.SplitChildGrid"/> object. <b>null</b> if the <see cref="P:DevExpress.XtraGrid.GridSplitContainer.SplitChildGrid"/> object is set to <b>null</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.SplitterPosition">
|
|
<summary>
|
|
<para>Gets or sets the splitter's location.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the splitter's current location in pixels
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridSplitContainer.SplitViewCreated">
|
|
<summary>
|
|
<para>Fires before a Split View is displayed or before its orientation is changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridSplitContainer.SplitViewHidden">
|
|
<summary>
|
|
<para>Fires after the current Split View has been destroyed or when the Split View's orientation is changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridSplitContainer.SplitViewShown">
|
|
<summary>
|
|
<para>Fires after a Split View has been displayed or after its orientation has been changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.SynchronizeExpandCollapse">
|
|
<summary>
|
|
<para>Gets or sets whether group expansion states are in sync between two grid controls being split.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if group expansion states are in sync between two grid controls being split.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.SynchronizeFocusedRow">
|
|
<summary>
|
|
<para>Gets or sets whether focus is automatically moved in one Grid Control, when an end-user moves focus in another grid control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if the row focus is synchronized between two grid controls.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.SynchronizeScrolling">
|
|
<summary>
|
|
<para>Gets or sets whether scrolling positions are in sync between two grid controls.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if scrolling positions are in sync between two grid controls.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.SynchronizeViews">
|
|
<summary>
|
|
<para>Gets or sets whether appearance, view, sort, group and filter settings are synchronized between two grid controls.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if corresponding settings are in sync between two grid controls.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSplitContainer.View">
|
|
<summary>
|
|
<para>Gets the main View (<see cref="P:DevExpress.XtraGrid.GridControl.MainView"/>) of the <see cref="P:DevExpress.XtraGrid.GridSplitContainer.Grid"/> object.
|
|
</para>
|
|
</summary>
|
|
<value>The main View of the <see cref="P:DevExpress.XtraGrid.GridSplitContainer.Grid"/> object. <b>null</b> if the <see cref="P:DevExpress.XtraGrid.GridSplitContainer.Grid"/> object is set to <b>null</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomRowCellEditEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomRowCellEdit"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomRowCellEditEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraEditors.Repository.RepositoryItem)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewCustomRowCellEditEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the current card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that identifies the current card field. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="repositoryItem">
|
|
A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> descendant that specifies the editor to be assigned to the current cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs.RepositoryItem"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardLayout"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardLayout"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.PopupMenuShowing"/> event.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.PopupMenuShowing"/> event.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. This parameter identifies the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> which raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs"/> object which contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.PopupMenuShowing"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.#ctor(DevExpress.XtraGrid.Menu.GridViewMenu,DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo)">
|
|
<summary>
|
|
<para>Initializes a new instance of the PopupMenuShowingEventArgs class with the specified menu and hit information.
|
|
</para>
|
|
</summary>
|
|
<param name="menu">
|
|
A <see cref="T:DevExpress.XtraGrid.Menu.GridViewMenu"/> object specifying the popup menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Menu"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="hitInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object specifying information on a clicked element. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.HitInfo"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.#ctor(DevExpress.XtraGrid.Views.Grid.GridMenuType,DevExpress.XtraGrid.Menu.GridViewMenu,DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the PopupMenuShowingEventArgs class with the specified menu type, menu object, hit information and a value indicating whether or not a popup menu should be shown.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="menuType">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value specifying the type of the popup menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.MenuType"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="menu">
|
|
A <see cref="T:DevExpress.XtraGrid.Menu.GridViewMenu"/> object specifying the popup menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Menu"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="hitInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object specifying information on a clicked element. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.HitInfo"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="allow">
|
|
<b>true</b> if a popup menu is enabled; otherwise, <b>false</b>. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Allow"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.#ctor(DevExpress.XtraGrid.Views.Grid.GridMenuType,DevExpress.XtraGrid.Menu.GridViewMenu,System.Drawing.Point,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the PopupMenuShowingEventArgs class with the specified menu type, menu object, menu position and a value indicating whether or not a popup menu should be shown.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="menuType">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value specifying the type of the popup menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.MenuType"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="menu">
|
|
A <see cref="T:DevExpress.XtraGrid.Menu.GridViewMenu"/> object specifying the popup menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Menu"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="point">
|
|
A <b>Point</b> object specifying the popup menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Point"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="allow">
|
|
<b>true</b> if a popup menu is enabled; otherwise, <b>false</b>. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Allow"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Allow">
|
|
<summary>
|
|
<para>Gets or sets whether to enable the Grid's popup menu.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a popup menu is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.HitInfo">
|
|
<summary>
|
|
<para>Gets an object that identifies a clicked element.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object or its descendant that identifies a clicked element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Menu">
|
|
<summary>
|
|
<para>Gets or sets the Grid's popup menu that will be shown.
|
|
</para>
|
|
</summary>
|
|
<value>A GridViewMenu object that is the menu that will be shown.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.MenuType">
|
|
<summary>
|
|
<para>Gets the type of the Grid View's menu to be invoked.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value that specifies the type of the Grid View's menu to be invoked.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.PopupMenuShowingEventArgs.Point">
|
|
<summary>
|
|
<para>Gets the position where the menu is to be invoked.
|
|
</para>
|
|
</summary>
|
|
<value>A Point value that specifies the position where the menu is to be invoked.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ValidateRowEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ValidateRow"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ValidateRowEventArgs.#ctor(System.Int32,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ValidateRowEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row being validated. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="row">
|
|
An object representing the row being validated. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowObjectEventArgs.Row"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ValidateRowEventArgs.ErrorText">
|
|
<summary>
|
|
<para>Gets or sets the error description.
|
|
</para>
|
|
</summary>
|
|
<value>A string representing the error description.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ValidateRowEventArgs.Valid">
|
|
<summary>
|
|
<para>Gets or sets whether the row validation succeeds.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to accept row cell values; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardLayout"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewCustomCardLayoutEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the current card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="differences">
|
|
A <b>LayoutViewCardDifferences</b> object that specifies differences made in the current card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventArgs.CardDifferences"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventArgs.CardDifferences">
|
|
<summary>
|
|
<para>Gets or sets an object that summarizes all <i>difference</i> records for the current card, which specify how the layout settings of the card fields differ from the default settings.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomCardLayoutEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets or sets the handle of the currently processed card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the handle of the currently processed card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomFieldCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomFieldCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.FindMode">
|
|
|
|
<summary>
|
|
<para>Contains values that specify how data searching is initiated within specific controls.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.FindMode.Always">
|
|
<summary>
|
|
<para>A control starts searching data automatically, after a small delay.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.FindMode.Default">
|
|
<summary>
|
|
<para>A search for data is started automatically, or must be started manually, depending on the underlying data source.
|
|
|
|
<para>
|
|
Automatic searching is enabled in the following cases: 1) a control functions in regular binding mode and the number of data source records is less than 10,000; 2) a control functions in Instant Feedback mode.
|
|
</para>
|
|
<para>
|
|
Manual searching is enabled in the following cases: 1) a control functions in regular binding mode and the number of data source records is greater than 10,000; 2) a control functions in regular server mode.
|
|
</para>
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.FindMode.FindClick">
|
|
<summary>
|
|
<para>A control starts searching data on clicking the Find button or pressing ENTER.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind">
|
|
|
|
<summary>
|
|
<para>Provides access to options controlling the view and behavior settings of the Find Panel.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ColumnViewOptionsFind class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.AllowFindPanel">
|
|
<summary>
|
|
<para>Gets or sets whether the Find Panel can be invoked by an end-user.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Find Panel can be invoked by an end-user; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.AlwaysVisible">
|
|
<summary>
|
|
<para>Gets or sets whether the Find Panel is always visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Find Panel is always visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings of the options object passed as this method's parameter to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.ClearFindOnClose">
|
|
<summary>
|
|
<para>Gets or sets whether the Find Panel's search (filter) string is cleared when the Find Panel is hidden.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Find Panel's search string is cleared on hiding the control; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.FindDelay">
|
|
<summary>
|
|
<para>Gets or sets the delay in milliseconds, after which a data search is initiated (if automatic search mode is active).
|
|
</para>
|
|
</summary>
|
|
<value>An integer that specifies the delay in milliseconds, after which a data search is initiated.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.FindFilterColumns">
|
|
<summary>
|
|
<para>Gets or sets the field names against which searches are performed by the Find Panel.
|
|
</para>
|
|
</summary>
|
|
<value>A string specifying the field names against which searches are performed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.FindMode">
|
|
<summary>
|
|
<para>Gets or sets whether data searching starts automatically, or must be started manually.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.FindMode"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.HighlightFindResults">
|
|
<summary>
|
|
<para>Gets or sets whether the search string is highlighted within located records.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the search string is highlighted within located records; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.ShowClearButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Clear button is displayed within the Find Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Clear button is displayed within the Find Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.ShowCloseButton">
|
|
<summary>
|
|
<para>Gets or sets whether the close ('x') button is displayed within the Find Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the close ('x') button is displayed within the Find Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.ShowFindButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Find button is displayed within the Find Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Find button is displayed within the Find Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomFieldCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewFieldCaptionImageEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the current card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that identifies the current column (field). This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="list">
|
|
An object that represents an image list. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.ImageList"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs.Column">
|
|
<summary>
|
|
<para>Gets or sets the column object that identifes the currently processed card field.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object identifying the current field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs.ImageAlignment">
|
|
<summary>
|
|
<para>Gets or sets the alignment of the image within the field's caption.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.ContentAlignment"/> enumeration value that specifies the alignment of the image within the field's caption.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewFieldCaptionImageEventArgs.ImageToTextDistance">
|
|
<summary>
|
|
<para>Gets or sets the distance between the field's label and image.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the distance between the field's label and image, in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit">
|
|
|
|
<summary>
|
|
<para>Contains settings specific to the <see cref="T:DevExpress.XtraEditors.SearchLookUpEdit"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the RepositoryItemSearchLookUpEdit class.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.AddNewValue">
|
|
<summary>
|
|
<para>Fires when the "Add New" button is clicked, and allows you to add new records to the dropdown data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.Assign(DevExpress.XtraEditors.Repository.RepositoryItem)">
|
|
<summary>
|
|
<para>Copies settings of the specified repository item.
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> object or its descendant that represents the source of the operation.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.EditorTypeName">
|
|
<summary>
|
|
<para>Gets the class name of the current editor.
|
|
</para>
|
|
</summary>
|
|
<value>The string identifying the class name of the current editor.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.GetDisplayText(DevExpress.Utils.FormatInfo,System.Object)">
|
|
<summary>
|
|
<para>Returns the text representation of the specified value, formatted according to the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="format">
|
|
A <see cref="T:DevExpress.Utils.FormatInfo"/> object that specifies formatting settings.
|
|
|
|
</param>
|
|
<param name="editValue">
|
|
A value to be formatted.
|
|
|
|
</param>
|
|
<returns>A string that specifies the value's formatted text representation.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.GetDisplayTextByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns the text representation of the <b>DisplayMember</b> field value of the row that contains the specified <b>ValueMember</b> field value.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <b>ValueMember</b> field for the row to locate.
|
|
|
|
</param>
|
|
<returns>The text representation of the <b>DisplayMember</b> field value for the row located.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.GetDisplayValueByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns a value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field of the row containing the specified <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field value.
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field for the row to locate.
|
|
|
|
</param>
|
|
<returns>The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field for the row located.
|
|
<b>null</b> if no record with the specified value was found (<b>System.DBNull.Value</b> and the data source is a <see cref="T:System.Data.DataView"/> object).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.GetDisplayValueByKeyValueEx(System.Object,DevExpress.Data.OperationCompleted[])">
|
|
<summary>
|
|
<para>Returns a value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field of the row containing the specified <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field value. Allows you to get values in Instant Feedback Mode.
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field for the row to locate.
|
|
|
|
</param>
|
|
<param name="completed">
|
|
A <b>DevExpress.Data.OperationCompleted</b> method that will be called when the requested display value is ready to be returned.
|
|
|
|
</param>
|
|
<returns>The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field for the row located.
|
|
<b>null</b> if no record with the specified value was found (<b>System.DBNull.Value</b> and the data source is a <see cref="T:System.Data.DataView"/> object).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.GetIndexByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns the index of the row that contains the specified value in the <b>ValueMember</b> field.
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <b>ValueMember</b> field for the row to locate.
|
|
|
|
</param>
|
|
<returns>An integer that specifies the index of the required row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.ImmediatePopup">
|
|
<summary>
|
|
<para>This property is not supported by the RepositoryItemSearchLookUpEdit class.
|
|
</para>
|
|
</summary>
|
|
<value>False.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.OwnerEdit">
|
|
<summary>
|
|
<para>Gets the editor which owns the current repository item object.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.SearchLookUpEdit"/> control owning the current repository item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.PopupFindMode">
|
|
<summary>
|
|
<para>Gets or sets whether data searching starts automatically, or should be started manually.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.FindMode"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.ProcessNewValue">
|
|
<summary>
|
|
<para>This event is not supported by the RepositoryItemSearchLookUpEdit class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.RegisterSearchLookUpEdit">
|
|
<summary>
|
|
<para>Registers the <see cref="T:DevExpress.XtraEditors.SearchLookUpEdit"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.ShowAddNewButton">
|
|
<summary>
|
|
<para>Gets or sets whether the "Add New" button is displayed within the editor's dropdown.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the "Add New" button is displayed within the editor's dropdown; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.ShowClearButton">
|
|
<summary>
|
|
<para>Gets or sets whether the "Clear" button is displayed within the editor's dropdown.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the "Clear" button is displayed within the editor's dropdown; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit.TextEditStyle">
|
|
<summary>
|
|
<para>Gets or sets the style in which text is displayed and edited in the editor.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Controls.TextEditStyles"/> value determining the editing style.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase">
|
|
|
|
<summary>
|
|
<para>Contains settings specific to the <see cref="T:DevExpress.XtraEditors.GridLookUpEditBase"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the RepositoryItemGridLookUpEditBase class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.Assign(DevExpress.XtraEditors.Repository.RepositoryItem)">
|
|
<summary>
|
|
<para>Copies settings of the specified repository item.
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> object or its descendant that represents the source of the operation.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.BeginInit">
|
|
<summary>
|
|
<para>Starts the control's runtime initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.EndInit">
|
|
<summary>
|
|
<para>Ends the control's runtime initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.GetDisplayValueByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns a value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field of the row containing the specified <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field value.
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field for the row to locate.
|
|
|
|
</param>
|
|
<returns>The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field for the row located.
|
|
<b>null</b> if no record with the specified value was found (<b>System.DBNull.Value</b> and the data source is a <see cref="T:System.Data.DataView"/> object).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.OwnerEdit">
|
|
<summary>
|
|
<para>Gets the editor which owns the current repository item object.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.GridLookUpEditBase"/> control owning the current repository item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.PopulateViewColumns">
|
|
<summary>
|
|
<para>Creates columns for all fields in the bound data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.PopupFilterMode">
|
|
<summary>
|
|
<para>Gets or sets how records in the dropdown window are filtered when typing text within the edit box.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.PopupFilterMode"/> value that specifies the editor's popup filter mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.RepositoryItems">
|
|
<summary>
|
|
<para>Returns the collection of repository items (inplace editors) owned by the embedded grid control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemCollection"/> object that stores the embedded grid's repository items.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.RequireDisplayTextSorting">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure, and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>Always <b>true</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.ResetEvents">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure, and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.View">
|
|
<summary>
|
|
<para>Gets or sets the View used to represent data in the dropdown.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> object or its descendant that is currently used to represent data in the dropdown.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase.ViewType">
|
|
<summary>
|
|
<para>Gets or sets the type of View used to represent data in the dropdown.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.GridLookUpViewType"/> value that specifies the type of the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.GridLookUpEditBase">
|
|
|
|
<summary>
|
|
<para>Represents the base class for grid look up editors.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.GridLookUpEditBase.ForceInitialize">
|
|
<summary>
|
|
<para>Performs the control's initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.GridLookUpEditBase.Properties">
|
|
<summary>
|
|
<para>Specifies settings specific to the current editor.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEditBase"/> object containing settings for the editor.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.GridLookUpEditBase.ShowPopup">
|
|
<summary>
|
|
<para>Opens the popup window.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.SearchLookUpEdit">
|
|
|
|
<summary>
|
|
<para>An editor that provides lookup functionality using a dropdown <see cref="T:DevExpress.XtraGrid.GridControl"/> control, and contains the Find edit box, allowing end-users to quickly filter dropdown rows.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.SearchLookUpEdit.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the SearchLookUpEdit class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraEditors.SearchLookUpEdit.AddNewValue">
|
|
<summary>
|
|
<para>Fires when the "Add New" button is clicked, and allows you to add new records to the dropdown data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.SearchLookUpEdit.EditorContainsFocus">
|
|
<summary>
|
|
<para>Gets whether the editor or its popup has input focus.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the editor or its popup window has focus; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.SearchLookUpEdit.EditorTypeName">
|
|
<summary>
|
|
<para>Gets the class name of the current editor.
|
|
</para>
|
|
</summary>
|
|
<value>A string giving the class name of the current editor.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.SearchLookUpEdit.GetSelectedDataRow">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure, and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<returns>@nbsp;
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.SearchLookUpEdit.Properties">
|
|
<summary>
|
|
<para>Specifies settings specific to the current editor.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemSearchLookUpEdit"/> object containing settings for the editor.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.VisibleRecordIndexChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.VisibleRecordIndexChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.VisibleRecordIndexChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewVisibleRecordIndexChangedEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="visibleRecordIndex">
|
|
An integer value that specifies the index of the currently visible card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs.VisibleRecordIndex"/> property.
|
|
|
|
</param>
|
|
<param name="prevVisibleRecordIndex">
|
|
An integer value that specifies the index of the previous visible card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs.PrevVisibleRecordIndex"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs.PrevVisibleRecordIndex">
|
|
<summary>
|
|
<para>Gets the index of the previously visible card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the index of the previously visible card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewVisibleRecordIndexChangedEventArgs.VisibleRecordIndex">
|
|
<summary>
|
|
<para>Gets the index of the current visible card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the index of the current visible card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo">
|
|
|
|
<summary>
|
|
<para>Contains information about a specific point within a Layout View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewHitInfo class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.Clear">
|
|
<summary>
|
|
<para>Sets the LayoutViewHitInfo class' properties to their default values.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.Column">
|
|
<summary>
|
|
<para>Gets a column object located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that contains the test point. <b>null</b> (<b>Nothing</b> in Visual Basic) if the test point is over a visual element that does not belong to any column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.HitCard">
|
|
<summary>
|
|
<para>Gets a card object located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewCard"/> object that contains the test point. <b>null</b> (<b>Nothing</b> in Visual Basic) if the test point doesn't belong to any card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.HitField">
|
|
<summary>
|
|
<para>Gets a card field object located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewField"/> object located under the test point. <b>null</b> (<b>Nothing</b> in Visual Basic) if the test point doesn't belong to any card field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.HitRect">
|
|
<summary>
|
|
<para>Gets the bounds of the current object identified by the <see cref="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.HitTest"/> property.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Rectangle"/> structure that specifies the bounds of an object identified by the <see cref="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.HitTest"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.HitTest">
|
|
<summary>
|
|
<para>Gets a value identifying the type of visual element located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest"/> enumeration value identifying the type of visual element located under the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InBounds">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Layout View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Layout View; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InCard">
|
|
<summary>
|
|
<para>Gets whether the test point is within a Card.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a Card; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InCardCaption">
|
|
<summary>
|
|
<para>Gets whether the test point is within a Card Caption.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a Card Caption; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InCardExpandButton">
|
|
<summary>
|
|
<para>Gets whether the test point is within a Card Expand Button.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a Card Expand Button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InCardsArea">
|
|
<summary>
|
|
<para>Gets whether the test point is within a View's area where cards can be arranged.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a View's area; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InCarouselModeButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "Carousel View" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "Carousel View" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InClientArea">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value><para>@nbsp;</para>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InCloseZoomButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a View's Zoom Button.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a View's Zoom Button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InColumnModeButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "One Column" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "One Column" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InCustomizeButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "Customize" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "Customize" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InField">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Card Field.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Card Field; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InFieldCaption">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Card Field Caption.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Card Field Caption; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InFieldFilterButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Field Filter Button.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Field Filter Button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InFieldPopupActionArea">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Field Filter Button or Field Sort Button.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Field Filter or Sort Button; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InFieldSortButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Field Sort Button.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Field Sort Button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InFieldValue">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Card Field Value.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Card Field Value; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InFilterPanel">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to a Filter Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to a Filter Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InFooterArea">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InHeaderArea">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InHeaderButtons">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to any button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to any button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InLayoutItem">
|
|
<summary>
|
|
<para>Gets whether the test point is within any card's item, except card fields.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a test point is within any card's item, except card fields; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InMultiColumnModeButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "Multiple Columns" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "Multiple Columns" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InMultiRowModeButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "Multiple Rows" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "Multiple Rows" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InPanButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "Panning" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "Panning" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InRowModeButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "One Row" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "One Row" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InSingleModeButton">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the "One Card" button within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the "One Card" button within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.InViewCaption">
|
|
<summary>
|
|
<para>Gets whether the test point belongs to the View Caption.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point belongs to the View Caption; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.IsEquals(DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo)">
|
|
<summary>
|
|
<para>Indicates whether the specified object is equal to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="hitInfo">
|
|
A LayoutViewHitInfo object to be compared with the current object.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified object equals the current object; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.LayoutItem">
|
|
<summary>
|
|
<para>Gets a card layout item located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraLayout.BaseLayoutItem"/> descendant located under the test point. <b>null</b> (<b>Nothing</b> in Visual Basic) if the test point doesn't belong to any layout item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.RowHandle">
|
|
<summary>
|
|
<para>Gets a row handle that identifies the card containing the test point.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that represents the row handle identifying the current card. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value, if the test point doesn't belong to any card.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.VisibleIndex">
|
|
<summary>
|
|
<para>Gets the visual position of the card that contains the test point.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the card's visual position within the View's visible area.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsItemText">
|
|
|
|
<summary>
|
|
<para>Contains options that control the display of card fields' text labels
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsItemText.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsItemText class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object that will own the created object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsItemText.AlignMode">
|
|
<summary>
|
|
<para>Gets or sets the alignment mode for fields' text labels.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.FieldTextAlignMode"/> value that specifies the current alignment mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsItemText.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsItemText.TextToControlDistance">
|
|
<summary>
|
|
<para>Gets or sets the default distance between card fields' text labels and corresponding edit boxes.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that represents the distance between text labels and corresponding edit boxes
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode">
|
|
|
|
<summary>
|
|
<para>Contains display options of a Layout View in the <see cref="F:DevExpress.XtraGrid.Views.Layout.LayoutViewMode.Carousel"/> view mode.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsCarouselMode class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object that will own the created object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.BottomCardAlphaLevel">
|
|
<summary>
|
|
<para>Gets or sets the transparency level for background cards.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Single"/> value that specifies the transparency level, in the range between 0(transparent) and 1(opaque).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.BottomCardFading">
|
|
<summary>
|
|
<para>Gets or sets the fading factor for background cards.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Single"/> value that specifies the fading factor for background cards, in the range between 0(no fading out) and 1(the bottommost card is invisible).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.BottomCardScale">
|
|
<summary>
|
|
<para>Gets or sets the scaling factor for background cards.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Single"/> value that specifies the scaling factor for background cards, ranging between 0(smallest) to 1(no scale).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.CardCount">
|
|
<summary>
|
|
<para>Gets or sets the number of cards constituting the ellipse.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the number of cards in the ellipse.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.CenterOffset">
|
|
<summary>
|
|
<para>Gets or sets the coordinates of the ellipse, in pixels.
|
|
</para>
|
|
</summary>
|
|
<value>A Point structure that specifies the coordinates of the ellipse, in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.FrameCount">
|
|
<summary>
|
|
<para>Gets or sets the number of frames in the card scrolling animation effect.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the number of frames in the animation.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.FrameDelay">
|
|
<summary>
|
|
<para>Gets or sets the delay between frames in the card scrolling animation effect, in system timer ticks.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the delay between frames in the card scrolling animation effect, in system timer ticks.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.InterpolationMode">
|
|
<summary>
|
|
<para>Gets or sets the interpolation mode used to render background cards.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Drawing2D"/> value that specifies the interpolation mode.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.PitchAngle">
|
|
<summary>
|
|
<para>Gets or sets the pitch angle, in radians, ranging from 0 to @pi;.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Single"/> value that specifies the pitch angle, in radians, ranging from 0 to @pi;.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.Radius">
|
|
<summary>
|
|
<para>Gets or sets the longest radius of the ellipse, in pixels.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the longest radius of the ellipse, in pixels. <b>0</b> if the radius is calculated automatically depending on the View's size.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.RollAngle">
|
|
<summary>
|
|
<para>Gets or sets the roll angle, in radians, ranging from 0 to 2@pi;.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Single"/> value that specifies the roll angle, in radians, ranging from 0 to 2@pi;.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.StretchCardToViewHeight">
|
|
<summary>
|
|
<para>Gets or sets whether the active card is stretched to the LayoutView's height.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the active card is stretched to the LayoutView's height; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode.StretchCardToViewWidth">
|
|
<summary>
|
|
<para>Gets or sets whether the active card is stretched to the LayoutView's width.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the active card is stretched to the LayoutView's width; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel">
|
|
|
|
<summary>
|
|
<para>Contains options controlling the appearance and functionality provided by the Header Panel.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsHeaderPanel class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object that will own the created object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnableCarouselModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Carousel view mode can be enabled via the corresponding button within the Header Panel and keyboard shortcut (ALT+6).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the Carousel view mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnableColumnModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the One Column view mode can be enabled via the corresponding button within the Header Panel and keyboard shortcut (ALT+3).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the One Column view mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnableCustomizeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Customization Form can be enabled via the Customize button within the Header Panel and keyboard shortcut (F6).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the Customization Form; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnableMultiColumnModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Multiple Columns view mode can be enabled via the corresponding button within the Header Panel and keyboard shortcut (ALT+5).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the Multiple Columns view mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnableMultiRowModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Multiple Rows view mode can be enabled via the corresponding button within the Header Panel and keyboard shortcut (ALT+4).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the Multiple Rows view mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnablePanButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Panning mode can be enabled via the corresponding button within the Header Panel and keyboard shortcut (F10).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the Panning mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnableRowModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the One Row view mode can be enabled via the corresponding button within the Header Panel and keyboard shortcut (ALT+2).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the One Row view mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.EnableSingleModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the One Card view mode can be enabled via the corresponding button within the Header Panel and keyboard shortcut (ALT+1).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can enable the One Card view mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowCarouselModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Carousel Mode button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Carousel Mode button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowColumnModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the One Column button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the One Column button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowCustomizeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Customize button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Customize button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowMultiColumnModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Multiple Columns button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Multiple Columns button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowMultiRowModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Multiple Rows button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Multiple Rows button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowPanButton">
|
|
<summary>
|
|
<para>Gets or sets whether the Panning button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Panning button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowRowModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the One Row button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the One Row button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel.ShowSingleModeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the One Card button is displayed within the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the One Card button is displayed within the Header Panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization">
|
|
|
|
<summary>
|
|
<para>Provides options that determine which operations are available for end-users in a Layout View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsCustomization class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object that will own the created object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.AllowFilter">
|
|
<summary>
|
|
<para>Gets or sets a value which specifies whether end-users can filter data in the View.
|
|
</para>
|
|
</summary>
|
|
<value>A Boolean value that specifies whether the data can be filtered by end-users.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.AllowSort">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether end-users can sort data.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can sort data; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupCardCaptions">
|
|
<summary>
|
|
<para>Gets or sets whether the Captions group of edit controls is displayed within the Template Card tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupCardIndents">
|
|
<summary>
|
|
<para>Gets or sets whether the Indents group of edit controls is displayed within the Template Card tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupCards">
|
|
<summary>
|
|
<para>Gets or sets whether the Cards group of edit controls is displayed within the View Layout tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupFields">
|
|
<summary>
|
|
<para>Gets or sets whether the Fields group of edit controls is displayed within the View Layout tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupHiddenItems">
|
|
<summary>
|
|
<para>Gets or sets whether the Hidden Items list is displayed within the Template Card tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupLayout">
|
|
<summary>
|
|
<para>Gets or sets whether the Layout group of edit controls is displayed within the View Layout tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupLayoutTreeView">
|
|
<summary>
|
|
<para>Gets or sets whether the Layout Tree View is displayed within the Template Card tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowGroupView">
|
|
<summary>
|
|
<para>Gets or sets whether the View group of edit controls is displayed within the View Layout tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the corresponding group of edit controls is displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowResetShrinkButtons">
|
|
<summary>
|
|
<para>Gets or sets whether the Reset Template Card and Shrink Template Card buttons are displayed within the Template Card tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if these buttons are displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.ShowSaveLoadLayoutButtons">
|
|
<summary>
|
|
<para>Gets or sets whether the Load Layout and Save Layout buttons are displayed within the View Layout tab in the Customization Form in advanced customization mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if these buttons are displayed in advanced customization mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization.UseAdvancedRuntimeCustomization">
|
|
<summary>
|
|
<para>Gets or sets whether additional edit controls providing advanced customization capabilities can be displayed within the LayoutView's Customization Form.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if advanced customization edit controls are enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection">
|
|
|
|
<summary>
|
|
<para>Represents a collection of columns in a Layout View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewColumnCollection class with default settings.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object representing the View that will own the new column collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.Add">
|
|
<summary>
|
|
<para>Adds a new column (card field) to the current collection.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> object that represents the newly added column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.AddField(System.String)">
|
|
<summary>
|
|
<para>Creates a new column (card field) which is bound to the specified field and appends it to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value that specifies the name of the data field to which the created column is bound.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> object which represents the new column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.AddRange(DevExpress.XtraGrid.Columns.LayoutViewColumn[])">
|
|
<summary>
|
|
<para>Adds an array of columns to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="columns">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> objects.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.ColumnByFieldName(System.String)">
|
|
<summary>
|
|
<para>Returns a column by the name of the field to which it is bound.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value specifying the field name.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> object representing a column bound to the data source field with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column is found.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.ColumnByName(System.String)">
|
|
<summary>
|
|
<para>Returns a column by its name.
|
|
</para>
|
|
</summary>
|
|
<param name="columnName">
|
|
A <see cref="T:System.String"/> value specifying the column name.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> object representing a column with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column is found.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual columns.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
A zero-based integer specifying the desired column's position within the collection. If negative or exceeds the last available index, an exception is raised.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> object representing the column at the specified position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.Item(System.String)">
|
|
<summary>
|
|
<para>Gets the column specified by the bound field name.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string value specifying the column's bound field name.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> object representing the column at the specified position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns the current collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object that owns the current collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.LayoutViewColumn">
|
|
|
|
<summary>
|
|
<para>Represents a column in a Layout View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.LayoutViewColumn.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewColumn class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.AllowHotTrack">
|
|
<summary>
|
|
<para>Gets whether column hot-tracking is allowed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if column hot-tracking is allowed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.ImageAlignment">
|
|
<summary>
|
|
<para>Gets or sets the alignment of an image within the field's caption. This member is not supported. Use the <b>LayoutViewField.ImageAlignment</b> property instead.
|
|
</para>
|
|
</summary>
|
|
<value>A System.Drawing.StringAlignment enumeration member specifying the image alignment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.ImageIndex">
|
|
<summary>
|
|
<para>Gets or sets the index of an image in the <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnView.Images"/> collection that will be displayed within the field's caption.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the he index of an image in the <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnView.Images"/> collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.LayoutViewField">
|
|
<summary>
|
|
<para>Gets the layout field that corresponds to the current column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewField"/> object that corresponds to the current column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.MaxWidth">
|
|
<summary>
|
|
<para>This property is not supported by the LayoutViewColumn class.
|
|
</para>
|
|
</summary>
|
|
<value>0
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.MinWidth">
|
|
<summary>
|
|
<para>This property is not supported by the LayoutViewColumn class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.OptionsField">
|
|
<summary>
|
|
<para>Contains options that control the display of a field's sort and filter buttons.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <b>OptionsField</b> object that contains corresponding options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.ToolTip">
|
|
<summary>
|
|
<para>Gets or sets a custom tooltip for the current card field. This member is not supported by the LayoutViewColumn class.
|
|
</para>
|
|
</summary>
|
|
<value>A string value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.View">
|
|
<summary>
|
|
<para>Gets the View which owns the current column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object which owns the current column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.Visible">
|
|
<summary>
|
|
<para>Gets or sets whether the card field is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the card field is visible; otherwise. <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.VisibleIndex">
|
|
<summary>
|
|
<para>This property is not supported by the LayoutViewColumn class.
|
|
</para>
|
|
</summary>
|
|
<value>Always <b>-1</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.LayoutViewColumn.Width">
|
|
<summary>
|
|
<para>This property is not supported by the LayoutViewColumn class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewMode">
|
|
|
|
<summary>
|
|
<para>Enumerates card display modes.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewMode.Carousel">
|
|
<summary>
|
|
<para>Cards are arranged in an ellipse using a transparency effect. Use the <see cref="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsCarouselMode"/> property to customize related display options.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewMode.Column">
|
|
<summary>
|
|
<para>Cards are arranged in a single column.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewMode.MultiColumn">
|
|
<summary>
|
|
<para>Cards are arranged in multiple columns.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewMode.MultiRow">
|
|
<summary>
|
|
<para>Cards are arranged in multiple rows.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewMode.Row">
|
|
<summary>
|
|
<para>Cards are arranged in a single row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewMode.SingleRecord">
|
|
<summary>
|
|
<para>A single card is displayed at one time.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint">
|
|
|
|
<summary>
|
|
<para>Provides print/export options for a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsPrint class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.MaxCardColumns">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of columns in the print/export output. This option is in effect when cards are arranged in multiple columns (the <see cref="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.PrintMode"/> property is set to <b>MultiColumn</b>).
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the maximum number of columns in the print/export output.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.MaxCardRows">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of rows in the print/export output. This option is in effect when cards are arranged in multiple rows (the <see cref="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.PrintMode"/> property is set to <b>MultiRow</b>).
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the maximum number of rows displayed in the print/export output.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.PrintCardCaption">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether card captions are displayed in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if card captions are printed/exported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.PrintFilterInfo">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the filter panel is displayed in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the filter panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.PrintMode">
|
|
<summary>
|
|
<para>Gets or sets the card layout when the View is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode"/> value that specifies the card layout in the print/export output.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.PrintSelectedCardOnly">
|
|
<summary>
|
|
<para>Gets or sets whether to print/export only the selected card or all cards within the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the selected card only; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.PrintSelectedCardsOnly">
|
|
<summary>
|
|
<para>Gets or sets whether only the focused/selected cards are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if only only the focused/selected cards are printed/exported; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.ToString">
|
|
<summary>
|
|
<para>Returns the layout view options' textual representation.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:System.String"/> representing the textual representation of the current view options.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint.UsePrintStyles">
|
|
<summary>
|
|
<para>Gets or sets whether print styles or the View's appearance settings are used when printing/exporting the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to use print styles for printing/exporting the View; <b>false</b>, to use View styles.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutCardArrangeRule">
|
|
|
|
<summary>
|
|
<para>List the values that specify how cards can be displayed in a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View: whole cards or partial cards.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutCardArrangeRule.AllowPartialCards">
|
|
<summary>
|
|
<para>Allow cards to be partially displayed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutCardArrangeRule.ShowWholeCards">
|
|
<summary>
|
|
<para>Whole cards only are displayed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewField">
|
|
|
|
<summary>
|
|
<para>Represents a data field within cards in a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewField.#ctor(DevExpress.XtraEditors.Repository.RepositoryItem)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewField class with the specified repository item.
|
|
</para>
|
|
</summary>
|
|
<param name="editor">
|
|
A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> class descendant which identifies the type of editor to be used for data editing in the created field.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewField.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewField class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.AllowHide">
|
|
<summary>
|
|
<para>This property is not supported by the LayoutViewField class. Use the <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowShowHide"/> property instead.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.Column">
|
|
<summary>
|
|
<para>Returns the column corresponding to the current LayoutViewField object.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumn"/> object corresponding to the current field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.ColumnName">
|
|
<summary>
|
|
<para>Gets the name of the column to which the current LayoutViewField object corresponds.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies the corresponding column's name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.Control">
|
|
<summary>
|
|
<para>This member is not supported by the LayoutViewField class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.ControlAlignment">
|
|
<summary>
|
|
<para>This member is not supported by the LayoutViewField class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.ControlMaxSize">
|
|
<summary>
|
|
<para>This member is not supported by the LayoutViewField class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.ControlMinSize">
|
|
<summary>
|
|
<para>This member is not supported by the LayoutViewField class.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.CustomizationFormText">
|
|
<summary>
|
|
<para>Gets or sets the field's caption when it's displayed within the Customization Form.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies the field's caption when it's displayed within the Customization Form.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.FieldName">
|
|
<summary>
|
|
<para>Gets or sets the name of the field represented by the current LayoutViewField object.
|
|
</para>
|
|
</summary>
|
|
<value>A string that represents the name of a corresponding data field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.Images">
|
|
<summary>
|
|
<para>Gets an image collection whose images can be displayed within the current field.
|
|
</para>
|
|
</summary>
|
|
<value>An object that represents the image source.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.RepositoryItem">
|
|
<summary>
|
|
<para>Gets the repository item specifying the editor used to edit the current field's cell values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> descendant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.ShowInCustomizationForm">
|
|
<summary>
|
|
<para>Gets whether the field's header can be displayed within the Customization Form.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the field's header can be displayed within the Customization Form; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.Text">
|
|
<summary>
|
|
<para>Gets or sets the field's caption.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies the field's caption.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewField.TypeName">
|
|
<summary>
|
|
<para>Gets the name of the current object's type.
|
|
</para>
|
|
</summary>
|
|
<value>The "LayoutViewField" string.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutView">
|
|
|
|
<summary>
|
|
<para>Represents the View which allows records to be represented as cards using various layouts.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.#ctor(DevExpress.XtraGrid.GridControl)">
|
|
<summary>
|
|
<para>Creates a new LayoutView object with the specified owner control.
|
|
</para>
|
|
</summary>
|
|
<param name="ownerGrid">
|
|
A <see cref="T:DevExpress.XtraGrid.GridControl"/> object that will own the new View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.GridControl"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutView class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.Appearance">
|
|
<summary>
|
|
<para>Provides access to the properties that allow the appearance of the View's elements to be customized.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances"/> object providing appearance settings for View elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.AppearancePrint">
|
|
<summary>
|
|
<para>Provides access to properties that allow the print/export appearance of the View's elements to be customized.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintAppearances"/> object that provides print/export appearance settings for the View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.Assign(DevExpress.XtraGrid.Views.Base.BaseView,System.Boolean)">
|
|
<summary>
|
|
<para>Copies property values and, optionally, event handlers from the View specified as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="v">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose settings should be copied to the current View.
|
|
|
|
</param>
|
|
<param name="copyEvents">
|
|
<b>true</b> to copy event handlers; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.BeginInit">
|
|
<summary>
|
|
<para>Starts the View's runtime initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.CalcHitInfo(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns information about the View elements located at the specified point.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="x">
|
|
An integer representing the X coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<param name="y">
|
|
An integer representing the Y coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo"/> object that contains information on the View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.CalcHitInfo(System.Drawing.Point)">
|
|
<summary>
|
|
<para>Returns information about the View elements located at the specified point.
|
|
</para>
|
|
</summary>
|
|
<param name="pt">
|
|
A <see cref="T:System.Drawing.Point"/> structure specifying the test point coordinates relative to the grid control's top-left corner.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo"/> object that contains information on the View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.CardCaptionFormat">
|
|
<summary>
|
|
<para>Gets or sets card caption text patterns.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the card caption's text pattern.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CardCollapsed">
|
|
<summary>
|
|
<para>Fires immediately after a card has been collapsed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CardCollapsing">
|
|
<summary>
|
|
<para>Provides the ability to prevent particular cards from being collapsed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CardExpanded">
|
|
<summary>
|
|
<para>Fires immediately after a card has been expanded.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CardExpanding">
|
|
<summary>
|
|
<para>Provides the ability to prevent particular cards from being expanded.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.CardHorzInterval">
|
|
<summary>
|
|
<para>Gets or sets the minimum horizontal interval between adjacent cards.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the minimum horizontal interval between cards, in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.CardMinSize">
|
|
<summary>
|
|
<para>Gets or sets the minimum size of a card within the current LayoutView.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Size"/> structure that specifies a card's minimum size.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.CardVertInterval">
|
|
<summary>
|
|
<para>Gets or sets the minimum vertical interval between adjacent cards displayed.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the minimum vertical interval between cards, in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.CollapseCard(System.Int32)">
|
|
<summary>
|
|
<para>Collapses the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that identifies the card by its handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.Columns">
|
|
<summary>
|
|
<para>Provides access to the View's column collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.LayoutViewColumnCollection"/> object that contains the View's columns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.CreateExportLink(DevExpress.XtraExport.IExportProvider)">
|
|
<summary>
|
|
<para>This method is not supported by the LayoutView class.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object that implements the <b>DevExpress.XtraExport.IExportProvider</b> interface, that exports data to a particular format.
|
|
|
|
|
|
</param>
|
|
<returns><b>null</b>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardCaptionImage">
|
|
<summary>
|
|
<para>Enables custom images to be shown in card captions.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardLayout">
|
|
<summary>
|
|
<para>Allows you to dynamically customize the layout of fields within specific cards.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardStyle">
|
|
<summary>
|
|
<para>Allows you to customize the appearance of a card's caption and border.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomDrawCardCaption">
|
|
<summary>
|
|
<para>Enables card captions to be custom painted.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomDrawCardFieldCaption">
|
|
<summary>
|
|
<para>Enables card field captions to be custom painted.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomDrawCardFieldValue">
|
|
<summary>
|
|
<para>Enables you to custom paint card field value cells
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomFieldCaptionImage">
|
|
<summary>
|
|
<para>Allows you to dynamically display images in field captions.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomFieldCaptionStyle">
|
|
<summary>
|
|
<para>Allows you to customize the appearance of field captions in cards.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomFieldEditingValueStyle">
|
|
<summary>
|
|
<para>Allows you to customize the appearance of field value regions in edit mode.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomFieldValueStyle">
|
|
<summary>
|
|
<para>Allows you to customize the appearance of field value regions in display mode.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomRowCellEdit">
|
|
<summary>
|
|
<para>Enables you to assign editors to individual cells.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomSeparatorStyle">
|
|
<summary>
|
|
<para>Enables you to change the separator's width and customize its appearance.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.DeleteSelectedRows">
|
|
<summary>
|
|
<para>Deletes the selected rows/cards in multiple selection mode or focused row/card in single selection mode.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.DetailAutoHeight">
|
|
<summary>
|
|
<para>Gets or sets whether a detail auto height feature is enabled. This property is applied to Layout Views when they serve as detail Views.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a detail auto height feature is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.EndInit">
|
|
<summary>
|
|
<para>Ends the View's runtime initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.ExpandCard(System.Int32)">
|
|
<summary>
|
|
<para>Expands the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that identifies the card by its handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.FieldCaptionFormat">
|
|
<summary>
|
|
<para>Gets or sets the pattern used to generate field captions.
|
|
</para>
|
|
</summary>
|
|
<value>A string that represents the pattern used to generate field captions.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.FocusedColumn">
|
|
<summary>
|
|
<para>Gets or sets the focused card field.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing the currently focused card field.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.GetCardCaption(System.Int32)">
|
|
<summary>
|
|
<para>Returns the specified card's caption text.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card by its row handle.
|
|
|
|
</param>
|
|
<returns>A string value representing the specified card's caption text.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.GetCardCollapsed(System.Int32)">
|
|
<summary>
|
|
<para>Gets whether the specified card is collapsed.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card's handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the card is collapsed; <b>false</b> if the card is expanded.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.GetFieldCaption(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns a column's actual display caption.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object
|
|
|
|
</param>
|
|
<returns>A string representing the specified column's display caption.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.GetVisibleIndex(System.Int32)">
|
|
<summary>
|
|
<para>Gets the specified card's visible index.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the card to inspect.
|
|
|
|
</param>
|
|
<returns>An integer value representing the card's visible index. <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> if there isn't any card with the specified handle.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.GetVisibleRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Returns the handle of the card displayed at the specified position.
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value representing the card's visible index.
|
|
|
|
</param>
|
|
<returns>An integer value representing the card's handle. <see cref="F:DevExpress.XtraGrid.GridControl.NewItemRowHandle"/>, if no card is found or the specified index corresponds to a newly added card which is currently being edited.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.HiddenItems">
|
|
<summary>
|
|
<para>Provides access to a card's hidden items (card fields, empty regions, etc).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraLayout.HiddenItemsCollection"/> object containing hidden items.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.HideCustomization">
|
|
<summary>
|
|
<para>Fires after the Customization Form has been hidden.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.HideCustomizationForm">
|
|
<summary>
|
|
<para>Hides the Customization Form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.HideEditor">
|
|
<summary>
|
|
<para>Closes the currently active inplace editor, discarding changes made to the edited value.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.InvalidateCard(System.Int32)">
|
|
<summary>
|
|
<para>Invalidates the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card by its row handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.InvalidateCard(DevExpress.XtraGrid.Views.Layout.LayoutViewCard)">
|
|
<summary>
|
|
<para>Invalidates the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="card">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewCard"/> object that represents the card to be invalidated.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.InvalidateCardCaption(System.Int32)">
|
|
<summary>
|
|
<para>Invalidates the specified card's caption.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card by its row handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.InvalidateCardField(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Invalidates the specified card field.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card by its row handle.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that identifies the card field.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.InvalidateHitObject(DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo)">
|
|
<summary>
|
|
<para>Invalidates the View element located at the point specified by the hit information object.
|
|
</para>
|
|
</summary>
|
|
<param name="hitInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/> descendant containing hit information.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.IsCardVisible(System.Int32)">
|
|
<summary>
|
|
<para>Returns whether the specified card is visible.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that represents the row handle identifying the card.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified card is visible; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.IsCustomizationMode">
|
|
<summary>
|
|
<para>Gets whether the Layout View's runtime customization is active.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Layout View's runtime customization is active; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.IsDefaultState">
|
|
<summary>
|
|
<para>Gets a value indicating whether the View is in its normal state.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if no specific operation is performed within the View; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.IsEditing">
|
|
<summary>
|
|
<para>Gets a value indicating whether a cell editor is presently active.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is in edit mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.IsSizingState">
|
|
<summary>
|
|
<para>Gets a value indicating whether the end-user is presently resizing cards.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the end-user is dragging a card separator; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.IsVisible">
|
|
<summary>
|
|
<para>Gets a value indicating whether the View is visible on screen.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is visible on screen; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.Items">
|
|
<summary>
|
|
<para>Provides access to a card's visible and hidden layout items (card fields, empty regions, etc).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraLayout.Utils.ReadOnlyItemCollection"/> collection containing a card's items.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.LayoutChanged">
|
|
<summary>
|
|
<para>Updates the current View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsBehavior">
|
|
<summary>
|
|
<para>Provides access to the View's behavior options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior"/> object containing the View's behavior options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsCarouselMode">
|
|
<summary>
|
|
<para>Provides access to options controlling the appearance of the Layout View in <b>Carousel</b> mode.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCarouselMode"/> object that contains corresponding options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsCustomization">
|
|
<summary>
|
|
<para>Provides access to the View's customization options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsCustomization"/> object containing the View's customization options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsHeaderPanel">
|
|
<summary>
|
|
<para>Provides access to options that control which actions are available via the Header Panel to end-users
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsHeaderPanel"/> object providing corresponding options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsItemText">
|
|
<summary>
|
|
<para>Contains options that control the display of card fields' text labels.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsItemText"/> object that contains corresponding options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsMultiRecordMode">
|
|
<summary>
|
|
<para>Provides options that control the layout of cards when a multiple record display mode is enabled.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode"/> object providing corresponding options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsPrint">
|
|
<summary>
|
|
<para>Provides options that control how the View is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsPrint"/> object containing the View's print and export options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsSingleRecordMode">
|
|
<summary>
|
|
<para>Provides access to a card's display options applied in single card display mode.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode"/> object providing corresponding options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.OptionsView">
|
|
<summary>
|
|
<para>Provides access to the View's appearance options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView"/> object containing the View's appearance options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.PaintAppearance">
|
|
<summary>
|
|
<para>Returns actual appearance settings currently used to paint the View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances"/> object which provides the appearance settings currently used to paint the View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.PanModeActive">
|
|
<summary>
|
|
<para>Gets whether the card panning feature is active.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if card panning is active; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.PanModeSwitch">
|
|
<summary>
|
|
<para>Enables and disables the card panning mode.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.PopulateColumns">
|
|
<summary>
|
|
<para>Creates card fields for all fields in the bound data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.RecordCount">
|
|
<summary>
|
|
<para>Gets the number of visible cards within the View, taking into account the current filter settings.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the number of visible cards within the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.Refresh">
|
|
<summary>
|
|
<para>Recalculates all the display information and updates the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.RefreshData">
|
|
<summary>
|
|
<para>Reloads data into View from the data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.RowCount">
|
|
<summary>
|
|
<para>Gets the number of visible cards within the View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the number of visible cards within the View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.SetCardCollapsed(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Collapses or expands the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the card's handle.
|
|
|
|
</param>
|
|
<param name="collapsed">
|
|
<b>true</b> to collapse the specified card; <b>false</b> to expand the specified card.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.ShowCustomization">
|
|
<summary>
|
|
<para>Fires before the Customization Form is opened.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.ShowCustomizationForm">
|
|
<summary>
|
|
<para>Displays the Customization Form modally.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.ShowEditor">
|
|
<summary>
|
|
<para>Invokes the editor for the focused card field.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.ShowFilterPopup(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Displays a Filter DropDown for the specified column (card field).
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column for which the filter popup must be invoked.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.State">
|
|
<summary>
|
|
<para>Obtains the View's current state.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewState"/> enumeration member indicating the View's current state.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutView.SynchronizeVisual(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes a View's visual settings with the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose visual settings should be copied to the current View.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.TemplateCard">
|
|
<summary>
|
|
<para>Represents the card that serves as a template for all cards displayed within the View at runtime.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewCard"/> object that represents the template card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.ViewRect">
|
|
<summary>
|
|
<para>Gets the bounding rectangle of the View's visible area.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Rectangle"/> structure representing the View's bounding rectangle. Coordinates are specified relative to the grid control's top-left corner.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutView.VisibleRecordIndex">
|
|
<summary>
|
|
<para>Gets or sets the visible index of the current card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the visible index of the current card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Layout.LayoutView.VisibleRecordIndexChanged">
|
|
<summary>
|
|
<para>Fires on scrolling the Layout View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest">
|
|
|
|
<summary>
|
|
<para>Lists values identifying visual elements in a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.Bounds">
|
|
<summary>
|
|
<para>The test point belongs to a View's border or scroll bar.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.Card">
|
|
<summary>
|
|
<para>The test point belongs to a card's client area not occupied by field captions and values.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.CardCaption">
|
|
<summary>
|
|
<para>The test point belongs to a card's caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.CardExpandButton">
|
|
<summary>
|
|
<para>The test point belongs to the expand button that resides within the card caption and is used to expand/collapse the card.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.CardsArea">
|
|
<summary>
|
|
<para>The test point belongs to a View's empty area not occupied by cards.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.CarouselModeButton">
|
|
<summary>
|
|
<para>The test point belongs to the "Carousel View" button within the header panel that applies the corresponding display mode to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.ClientArea">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.CloseZoomButton">
|
|
<summary>
|
|
<para>The test point belongs to a View's zoom button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.ColumnModeButton">
|
|
<summary>
|
|
<para>The test point belongs to the "One Column" button within the header panel that applies the single column display mode to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.CustomizeButton">
|
|
<summary>
|
|
<para>The test point belongs to the "Customize" button within the header panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.Field">
|
|
<summary>
|
|
<para>The test point belongs to a card field's area not occupied by the field's caption and value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FieldCaption">
|
|
<summary>
|
|
<para>The test point belongs to a card field's caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FieldFilterButton">
|
|
<summary>
|
|
<para>The test point belongs to a Field Filter Button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FieldPopupActionArea">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FieldSortButton">
|
|
<summary>
|
|
<para>The test point belongs to the Field Sort Button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FieldValue">
|
|
<summary>
|
|
<para>The test point belongs to a card field's value box.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FilterPanel">
|
|
<summary>
|
|
<para>The test point belongs to a View's filter panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FilterPanelActiveButton">
|
|
<summary>
|
|
<para>The test point belongs to the check box in the filter panel used to enable/disable filtering within a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FilterPanelCloseButton">
|
|
<summary>
|
|
<para>The test point belongs to a filter panel close button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FilterPanelCustomizeButton">
|
|
<summary>
|
|
<para>The test point belongs to a filter panel customize button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FilterPanelMRUButton">
|
|
<summary>
|
|
<para>The test point belongs to a button in the filter panel used to display a dropdown window with a list of the most recently used filter criteria.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FilterPanelText">
|
|
<summary>
|
|
<para>The test point belongs to a string in the filter panel which represents the filter criteria applied to a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.FooterArea">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.HeaderArea">
|
|
<summary>
|
|
<para>The test point belongs to a View's header panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.LayoutItem">
|
|
<summary>
|
|
<para>The test point belongs to a card layout item (a group, tabbed group, separator, label or empty space item). See <see cref="P:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitInfo.LayoutItem"/>, to learn more.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.MasterTabPageHeader">
|
|
<summary>
|
|
<para>The test point belongs to the View's master-detail tab.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.MultiColumnModeButton">
|
|
<summary>
|
|
<para>The test point belongs to the "Multiple Columns" button within the header panel that applies the corresponding display mode to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.MultiRowModeButton">
|
|
<summary>
|
|
<para>The test point belongs to the "Multiple Rows" button within the header panel that applies the corresponding display mode to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.None">
|
|
<summary>
|
|
<para>The test point is outside a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.PanButton">
|
|
<summary>
|
|
<para>The test point belongs to the pan button within the header panel that invokes the card panning feature.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.RowModeButton">
|
|
<summary>
|
|
<para>The test point belongs to the "One Row" button within the header panel that applies the single row display mode to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.SingleModeButton">
|
|
<summary>
|
|
<para>The test point belongs to the "One Card" button within the header panel that applies the single card display mode to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.ViewInfo.LayoutViewHitTest.ViewCaption">
|
|
<summary>
|
|
<para>The test point belongs to a View's caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewCard">
|
|
|
|
<summary>
|
|
<para>Represents a card in a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewCard class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.AllowCustomizeChildren">
|
|
<summary>
|
|
<para>Gets or sets whether the layout of fields in the card can be customized using drag and drop. This member is not supported by the LayoutViewCard class,
|
|
</para>
|
|
</summary>
|
|
<value>A Boolean value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.ExpandButtonVisible">
|
|
<summary>
|
|
<para>Gets or sets whether the card's expand/collapse button is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the card's expand/collapse button is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.ExpandOnDoubleClick">
|
|
<summary>
|
|
<para>Gets or sets whether double-clicking on a card's caption toggles the expansion state of the card.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if double-clicking on a card's caption toggles the expansion state of the card; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.GetDefaultText">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<returns>An empty string.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.Invalidate">
|
|
<summary>
|
|
<para>Invalidates the card.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.IsPartiallyVisible">
|
|
<summary>
|
|
<para>Gets whether the card is partially visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the card is partially visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.Location">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.MaxSize">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.MinSize">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.Position">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.RowHandle">
|
|
<summary>
|
|
<para>Gets or sets the row handle that corresponds to the current card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the row handle that corresponds to the current card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.Size">
|
|
<summary>
|
|
<para>Gets or sets the card's size. This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Size"/> structure that defines the card's width and height.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.State">
|
|
<summary>
|
|
<para>Gets the card's state.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.GridRowCellState"/> value that specifies the card's state.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.TypeName">
|
|
<summary>
|
|
<para>Gets the name of the LayoutViewCard type.
|
|
</para>
|
|
</summary>
|
|
<value>A string that represents the name of the LayoutViewCard type.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.Update">
|
|
<summary>
|
|
<para>Invalidates the region occupied by the card.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.ViewInfo">
|
|
<summary>
|
|
<para>Returns the object which contains the internal information used to render the card.
|
|
</para>
|
|
</summary>
|
|
<value>A <b>DevExpress.XtraGrid.Views.Layout.LayoutViewCardViewInfo</b> object which contains the internal information used to render the card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.VisibleColumn">
|
|
<summary>
|
|
<para>Gets the index of the visible column displaying the current card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the index of the visible column displaying the current card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.VisibleIndex">
|
|
<summary>
|
|
<para>Gets or sets the card's visual position within the View's visible area.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the card's visual position within the View's visible area.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCard.VisibleRow">
|
|
<summary>
|
|
<para>Gets the index of the visible row displaying the current card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the index of the visible row displaying the current card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances">
|
|
|
|
<summary>
|
|
<para>Provides appearance settings used to paint the elements in a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewAppearances class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.Card">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the background of cards.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that contains corresponding style settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.CardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint card captions in a LayoutView.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.FieldCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint field captions in a LayoutView's cards.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.FieldEditingValue">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint field values in edit mode.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.FieldValue">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint field values in a LayoutView's cards.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.FocusedCardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint a focused card's caption in a LayoutView.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.HeaderPanel">
|
|
<summary>
|
|
<para>Contains appearance settings used to paint the Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> that contains corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.HideSelectionCardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the captions of selected cards when the grid control is not focused.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.SelectedCardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the captions of selected cards.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.SelectionFrame">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint a marquee selection frame, when selecting multiple cards by a mouse drag.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that specifies corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.SeparatorLine">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint card separators.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing appearance settings for painting card separators.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewAppearances.ViewBackground">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint a LayoutView's background.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior">
|
|
|
|
<summary>
|
|
<para>Provides behavior options for a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsBehavior class with the specified owner.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object whose behavior options are initialized.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.AllowExpandCollapse">
|
|
<summary>
|
|
<para>Gets or sets whether cards can be collapsed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if cards can be collapsed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.AllowPanCards">
|
|
<summary>
|
|
<para>Gets or sets whether the card panning feature can be enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if card panning is supported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.AllowRuntimeCustomization">
|
|
<summary>
|
|
<para>Gets or sets whether an end-user can customize the card layout at runtime via the Customization Form.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the runtime customization feature is supported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.AllowSwitchViewModes">
|
|
<summary>
|
|
<para>Gets or sets whether the view mode can be changed via the <see cref="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ViewMode"/> property.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the view mode can be changed via the <see cref="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ViewMode"/> property; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.AutoFocusCardOnScrolling">
|
|
<summary>
|
|
<para>Gets or sets whether the top visible card is automatically focused when scrolling the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the top visible card is automatically focused when the View is scrolled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.AutoFocusNewCard">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether adding a new record focuses the new card.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to force the View to focus new cards automatically; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.OverrideLayoutControlRestoreBehavior">
|
|
<summary>
|
|
<para>This member is now obsolete. A layout is restored as specified by a View's <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnView.OptionsLayout"/> property.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.ScrollVisibility">
|
|
<summary>
|
|
<para>Gets or sets a value specifying when the scrollbar should be displayed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ScrollVisibility"/> enumeration value specifying when the scrollbar should be displayed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsBehavior.UseTabKey">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the TAB/SHIFT+TAB key combinations move focus within the Layout View, or to the next/previous control in tab order.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if TAB/SHIFT+TAB key combinations are handled by the View; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView">
|
|
|
|
<summary>
|
|
<para>Provides appearance options for a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsView class with the specified owner.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object whose behavior options are initialized.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.AllowHotTrackFields">
|
|
<summary>
|
|
<para>Gets or sets whether card fields are highlighted when hovering over them with the mouse cursor.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if field hot-tracking is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.CardArrangeRule">
|
|
<summary>
|
|
<para>Gets or sets whether only entire cards can be displayed at the same time, or allow cards to be partially displayed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutCardArrangeRule"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.CardsAlignment">
|
|
<summary>
|
|
<para>Gets or sets whether the top, center or bottom of cards are aligned when they have different heights.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.CardsAlignment"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ContentAlignment">
|
|
<summary>
|
|
<para>Gets or sets whether cards are centered within the View, or aligned to its specific edge.
|
|
</para>
|
|
</summary>
|
|
<value>A System.Drawing.ContentAlignment value that specifies the alignment of cards.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.FocusRectStyle">
|
|
<summary>
|
|
<para>Gets or sets how the focus rectangle is painted around fields.
|
|
</para>
|
|
</summary>
|
|
<value>A DevExpress.XtraGrid.Views.Layout.FocusRectStyle enumeration that specifies the focus rectangle display mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.PartialCardWrapThreshold">
|
|
<summary>
|
|
<para>Gets or sets the threshold for partially displayed cards, in pixels.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the threshold for partially displayed cards, in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ShowCardBorderIfCaptionHidden">
|
|
<summary>
|
|
<para>Gets or sets whether a card's border is painted when the card caption is hidden.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a card's border is painted when the card caption is hidden; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ShowCardCaption">
|
|
<summary>
|
|
<para>Gets or sets whether a card's caption bar is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a card's caption is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ShowCardExpandButton">
|
|
<summary>
|
|
<para>Gets or sets whether expand/collapse buttons are displayed within card captions.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if expand/collapse buttons are displayed within card captions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ShowCardFieldBorders">
|
|
<summary>
|
|
<para>Gets or sets whether borders are displayed for card fields.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if borders are displayed for card fields; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ShowCardLines">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether card separators are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if card separators are displayed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ShowFieldHints">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether hints are displayed for card fields with truncated content.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display hints for card fields with truncated content; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ShowHeaderPanel">
|
|
<summary>
|
|
<para>Gets or sets whether the <b>Header Panel</b> is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the <b>Header Panel</b> is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsView.ViewMode">
|
|
<summary>
|
|
<para>Gets or sets the card layout.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewMode"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.CardsAlignment">
|
|
|
|
<summary>
|
|
<para>Contains values that specify how cards in a <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> are aligned.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.CardsAlignment.Center">
|
|
<summary>
|
|
<para>Centers the View's card(s).
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.CardsAlignment.Far">
|
|
<summary>
|
|
<para>Aligns right/bottom edges of cards or displays the current card along the View's right/bottom edge.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.CardsAlignment.Near">
|
|
<summary>
|
|
<para>Aligns left/top edges of cards or displays the current card along the View's left/top edge.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.BeforePrintRow"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.#ctor(DevExpress.XtraPrinting.IPrintingSystem,System.Drawing.Graphics,DevExpress.XtraPrinting.IBrickGraphics,System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the PrintRowEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="ips">
|
|
The PrintingSystem object that provides methods to create bricks in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.PS"/> property.
|
|
|
|
</param>
|
|
<param name="g">
|
|
A Graphics object that represents the grid control's drawing surface.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Graphics"/> property.
|
|
|
|
</param>
|
|
<param name="graph">
|
|
A <see cref="T:DevExpress.XtraPrinting.BrickGraphics"/> object that implements report drawing functions.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.BrickGraphics"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
The handle of the row that has just been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="level">
|
|
The group level of the row that has been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Level"/> property.
|
|
|
|
</param>
|
|
<param name="x">
|
|
The X coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.X"/> property.
|
|
|
|
</param>
|
|
<param name="y">
|
|
The Y coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Y"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.#ctor(DevExpress.XtraPrinting.IPrintingSystem,System.Drawing.Graphics,DevExpress.XtraPrinting.IBrickGraphics,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the PrintRowEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="ips">
|
|
The PrintingSystem object that provides methods to create bricks in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.PS"/> property.
|
|
|
|
</param>
|
|
<param name="g">
|
|
A Graphics object that represents the grid control's drawing surface.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Graphics"/> property.
|
|
|
|
</param>
|
|
<param name="graph">
|
|
A <see cref="T:DevExpress.XtraPrinting.BrickGraphics"/> object that implements report drawing functions.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.BrickGraphics"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
The handle of the row that has just been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="level">
|
|
The group level of the row that has been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Level"/> property.
|
|
|
|
</param>
|
|
<param name="x">
|
|
The X coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.X"/> property.
|
|
|
|
</param>
|
|
<param name="y">
|
|
The Y coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Y"/> property.
|
|
|
|
</param>
|
|
<param name="hasRowFooter">
|
|
Specifies whether the row contains a footer.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.HasFooter"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.BrickGraphics">
|
|
<summary>
|
|
<para>Gets a <see cref="T:DevExpress.XtraPrinting.BrickGraphics"/> object that implements report drawing functions.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraPrinting.BrickGraphics"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Graphics">
|
|
<summary>
|
|
<para>Gets a Graphics object that represents the grid control's drawing surface
|
|
</para>
|
|
</summary>
|
|
<value>A Graphics object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.HasFooter">
|
|
<summary>
|
|
<para>Gets whether the row contains a footer.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the row contains a footer; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Level">
|
|
<summary>
|
|
<para>Gets the group level of the printed row .
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the group level of the printed row .
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.PS">
|
|
<summary>
|
|
<para>Gets the PrintingSystem object that provides methods to create bricks in the printout/export output.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraPrinting.PrintingSystem"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the printed row.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that represents the handle of the printed row.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.X">
|
|
<summary>
|
|
<para>Gets or sets the X coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the X coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Y">
|
|
<summary>
|
|
<para>Gets or sets the Y coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the Y coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.GridRowCellState">
|
|
|
|
<summary>
|
|
<para>Contains row cell states for the GridControl's appearance customization events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.Default">
|
|
<summary>
|
|
<para>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.Dirty">
|
|
<summary>
|
|
<para>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.Even">
|
|
<summary>
|
|
<para>Specifies that the current row has an even row handle.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.Focused">
|
|
<summary>
|
|
<para>Specifies that the current row is focused.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.FocusedAndGridFocused">
|
|
<summary>
|
|
<para>Specifies that the grid control has focus and the grid's row being currently processed is focused.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.FocusedCell">
|
|
<summary>
|
|
<para>Specifies that the cell being currently processed is focused.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.GridFocused">
|
|
<summary>
|
|
<para>Specifies that the grid control is focused.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.Odd">
|
|
<summary>
|
|
<para>Specifies that the current row has an odd row handle.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridRowCellState.Selected">
|
|
<summary>
|
|
<para>Specifies that the row/cell being currently processed is selected.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CalcFieldHeight"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs.#ctor(System.Int32,System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the FieldHeightEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that identifies the card handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="fieldHeight">
|
|
An integer value that specifies the default height for the current card field. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs.FieldHeight"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that identifies the current card field. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that identifies the currently processed field.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that identifies the currently processed field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs.FieldHeight">
|
|
<summary>
|
|
<para>Gets or sets the card field's height.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the card field's height.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle that identifies the currently processed card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the card's handle.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.FieldHeightEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CalcFieldHeight"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.FieldHeightEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CalcFieldHeight"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Card.FieldHeightEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView">
|
|
|
|
<summary>
|
|
<para>Serves as the base for classes which provide View options for Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.AnimationType">
|
|
<summary>
|
|
<para>Gets or sets animation mode, which identifies cells within which animation is enabled.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.GridAnimationType"/> value that represents animation mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings of the options object passed as this method's parameter to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.GetAnimationType">
|
|
<summary>
|
|
<para>Returns the actual animation type.
|
|
</para>
|
|
</summary>
|
|
<returns>If the <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.AnimationType"/> property is set to <b>Default</b>, the <b>AnimateFocusedItem</b> value is returned; Otherwise, the <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.AnimationType"/> property's value is returned.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.ShowFilterPanel">
|
|
<summary>
|
|
<para>Gets or sets whether the filter panel is displayed when data filtering is applied.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the filter panel when data filtering is applied; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.ShowFilterPanelMode">
|
|
<summary>
|
|
<para>Gets or sets a value which specifies when the Filter Panel is shown.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ShowFilterPanelMode"/> enumeration value which specifies when the filter panel is shown.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView.ShowViewCaption">
|
|
<summary>
|
|
<para>Gets or sets whether the View Caption is displayed above the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View Caption is displayed above the View; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit">
|
|
|
|
<summary>
|
|
<para>Contains settings specific to the <see cref="T:DevExpress.XtraEditors.GridLookUpEdit"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the RepositoryItemGridLookUpEdit class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.Assign(DevExpress.XtraEditors.Repository.RepositoryItem)">
|
|
<summary>
|
|
<para>Copies the properties of the source repository item to the current object.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
The source repository item object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.AutoComplete">
|
|
<summary>
|
|
<para>Gets or sets whether the automatic completion feature is enabled
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the automatic completion feature is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.EditorTypeName">
|
|
<summary>
|
|
<para>Gets the class name of the current editor.
|
|
</para>
|
|
</summary>
|
|
<value>The string identifying the class name of the current editor.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetDisplayText(System.Int32)">
|
|
<summary>
|
|
<para>Returns the text representation of the object that is stored in the DisplayMember field in the specified row.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the required row in the dropdown data source.
|
|
|
|
|
|
</param>
|
|
<returns>A string that specifies the display text for the specified row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetDisplayText(DevExpress.Utils.FormatInfo,System.Object)">
|
|
<summary>
|
|
<para>Returns the text representation of the specified value, formatted according to the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="format">
|
|
A <see cref="T:DevExpress.Utils.FormatInfo"/> object that specifies formatting settings.
|
|
|
|
</param>
|
|
<param name="editValue">
|
|
A value to be formatted.
|
|
|
|
</param>
|
|
<returns>A string that specifies the value's formatted text representation.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetDisplayTextByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns the text representation of the <b>DisplayMember</b> field value of the row that contains the specified <b>ValueMember</b> field value.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <b>ValueMember</b> field for the row to locate.
|
|
|
|
</param>
|
|
<returns>The text representation of the <b>DisplayMember</b> field value for the row located.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetDisplayValue(System.Int32)">
|
|
<summary>
|
|
<para>Returns an object that is stored in the <b>DisplayMember</b> field in the specified row.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
A zero-based index of the required row in the dropdown data source.
|
|
|
|
</param>
|
|
<returns>An object stored in the <b>DisplayMember</b> field in the specified row; <b>null</b> if no row exists with the specified index.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetDisplayValueByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns a value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field of the row containing the specified <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field value.
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field for the row to locate.
|
|
|
|
</param>
|
|
<returns>The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/> field for the row located.
|
|
<b>null</b> if no record with the specified value was found (<b>System.DBNull.Value</b> and the data source is a <see cref="T:System.Data.DataView"/> object).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetIndexByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns the index of the row that contains the specified value in the <b>ValueMember</b> field.
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <b>ValueMember</b> field for the row to locate.
|
|
|
|
</param>
|
|
<returns>An integer that specifies the index of the required row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetKeyValue(System.Int32)">
|
|
<summary>
|
|
<para>Returns a value of the <b>ValueMember</b> field from the specified row.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
A zero-based index of the required row.
|
|
|
|
</param>
|
|
<returns>A key value in the specified row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.GetRowByKeyValue(System.Object)">
|
|
<summary>
|
|
<para>Returns a data source row containing the specified value in the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field.
|
|
</para>
|
|
</summary>
|
|
<param name="keyValue">
|
|
The value of the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field for the row to be located.
|
|
|
|
</param>
|
|
<returns>An object representing the data source record containing the specified value. <b>null</b> (<b>Nothing</b> in Visual Basic) if no record with the specified value in the <see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.ValueMember"/> field was found.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.OwnerEdit">
|
|
<summary>
|
|
<para>Gets the editor which owns the current repository item object.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.GridLookUpEdit"/> control owning the current repository item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.RegisterGridLookUpEdit">
|
|
<summary>
|
|
<para>Registers the <see cref="T:DevExpress.XtraEditors.GridLookUpEdit"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.ServerMode">
|
|
<summary>
|
|
<para>Gets or sets whether server mode is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if server mode is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.Repository.GridLookUpViewType">
|
|
|
|
<summary>
|
|
<para>Lists the types of Views that can be used within a <see cref="T:DevExpress.XtraEditors.GridLookUpEdit"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.Repository.GridLookUpViewType.AdvBandedView">
|
|
<summary>
|
|
<para>Corresponds to an <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.Repository.GridLookUpViewType.BandedView">
|
|
<summary>
|
|
<para>Corresponds to a <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.Repository.GridLookUpViewType.Default">
|
|
<summary>
|
|
<para><para>
|
|
The default View is used.
|
|
</para>
|
|
Currently this option is the same as the <b>GridView</b> option
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.Repository.GridLookUpViewType.GridView">
|
|
<summary>
|
|
<para>Corresponds to a <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.GridLookUpEdit">
|
|
|
|
<summary>
|
|
<para>An editor that provides lookup functionality using a dropdown XtraGrid control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.GridLookUpEdit.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridLookUpEdit class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.GridLookUpEdit.EditorTypeName">
|
|
<summary>
|
|
<para>Gets the class name of the current editor.
|
|
</para>
|
|
</summary>
|
|
<value>A string giving the class name of the current editor.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraEditors.GridLookUpEdit.GetSelectedDataRow">
|
|
<summary>
|
|
<para>Returns a data source row corresponding to the currently selected edit value.
|
|
</para>
|
|
</summary>
|
|
<returns>An object that represents a data source row corresponding to the currently selected edit value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraEditors.GridLookUpEdit.Properties">
|
|
<summary>
|
|
<para>Specifies settings specific to the current editor.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit"/> object containing settings for the editor.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode">
|
|
|
|
<summary>
|
|
<para>Contains options that control the layout of cards when a multiple record display mode is enabled.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsMultiRecordMode class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object that will own the created object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.MaxCardColumns">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of columns displayed in the View. This option is in effect when multiple columns are allowed to be displayed (in Row, MultiRow and MultiColumn view modes).
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the maximum number of columns displayed in the View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.MaxCardRows">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of rows displayed in the View. This option is in effect when multiple rows are allowed to be displayed (in Column, MultiColumn and MultiRow view modes).
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the maximum number of rows displayed in the View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.MultiColumnScrollBarOrientation">
|
|
<summary>
|
|
<para>Gets or sets the scroll bar's orientation in multi column display mode.
|
|
</para>
|
|
</summary>
|
|
<value>A ScrollBarOrientation value that specifies the scroll bar's orientation in multi column display mode.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.MultiRowScrollBarOrientation">
|
|
<summary>
|
|
<para>Gets or sets the scroll bar's orientation in multi row display mode.
|
|
</para>
|
|
</summary>
|
|
<value>A ScrollBarOrientation value that specifies the scroll bar's orientation in multi row display mode.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.StretchCardToViewHeight">
|
|
<summary>
|
|
<para>Gets or sets whether cards are stretched vertically to fully fill the View's height. This option is in effect when cards are arranged in rows (in Row and MultiRow view modes).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if cards are stretched vertically to fully fill the View's height; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsMultiRecordMode.StretchCardToViewWidth">
|
|
<summary>
|
|
<para>Gets or sets whether cards are stretched horizontally to fully fill the View's width. This option is in effect when cards are arranged in columns (in Column and MultiColumn view modes).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if cards are stretched horizontally to fully fill the View's width; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.GridCell">
|
|
|
|
<summary>
|
|
<para>Represents an object which corresponds to a data cell.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.GridCell.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which specifies the handle of the row which owns the cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.GridCell.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which represents the column which contains the cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.GridCell.Column"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.GridCell.Column">
|
|
<summary>
|
|
<para>Gets the column which contains the cell.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column which contains the cell.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.GridCell.Equals(DevExpress.XtraGrid.Views.Base.GridCell)">
|
|
<summary>
|
|
<para>Indicates whether the current <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> instance is equal to the specified object.
|
|
</para>
|
|
</summary>
|
|
<param name="anchor">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object to compare with the current object.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified object instance is equal to the current <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> instance; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.GridCell.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row which owns the cell.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value which specifies the handle of the row which owns the cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsSelection">
|
|
|
|
<summary>
|
|
<para>Provides selection options for Advanced Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsSelection.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsSelection"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsSelection.MultiSelectMode">
|
|
<summary>
|
|
<para>Gets or sets whether multiple cells or rows can be selected.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode"/> enumeration value which specifies whether multiple cells or rows can be selected.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowFilterEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomRowFilter"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowFilterEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.RowFilterEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomRowFilter"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. This parameter identifies the View which raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.RowFilterEventArgs"/> object which contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowFilterEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomRowFilter"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowFilterEventArgs.#ctor(System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the RowFilterEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="listSourceRow">
|
|
An integer that identifies the row to be processed. This value is used to initialized the <see cref="P:DevExpress.XtraGrid.Views.Base.RowFilterEventArgs.ListSourceRow"/> parameter.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowFilterEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets whether the event is handled and therefore no default processing is required.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the default actions are not required; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowFilterEventArgs.ListSourceRow">
|
|
<summary>
|
|
<para>Gets the index in the data source of the row currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer that identifies the row's index in the underlying data source.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowFilterEventArgs.Visible">
|
|
<summary>
|
|
<para>Gets or sets whether the current record must be visible in a View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the record must be visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowObjectEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowUpdated"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowObjectEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.RowObjectEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowUpdated"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.RowObjectEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowObjectEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowUpdated"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowObjectEventArgs.#ctor(System.Int32,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.RowObjectEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which represents the row's handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="row">
|
|
An object which represents the processed row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowObjectEventArgs.Row"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowObjectEventArgs.Row">
|
|
<summary>
|
|
<para>Gets the processed row.
|
|
</para>
|
|
</summary>
|
|
<value>An object which represents the processed row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowPreviewCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowPreview"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowPreviewCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,DevExpress.Utils.Drawing.ObjectPainter,DevExpress.XtraGrid.Views.Grid.ViewInfo.GridDataRowInfo)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.RowPreviewCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
An <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> object that provides default painting facilities. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="rowInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridDataRowInfo"/> object which contains the View information about the row being processed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowPreviewCustomDrawEventArgs.Bounds">
|
|
<summary>
|
|
<para>Gets the bounding rectangle of the painted preview section.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Rectangle"/> structure which specifies the boundaries of the preview section.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.DetailExpandButtonMode">
|
|
|
|
<summary>
|
|
<para>Lists the values that specify whether master-detail expand buttons are displayed grayed out when their associated details don't contain any data.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.DetailExpandButtonMode.AlwaysEnabled">
|
|
<summary>
|
|
<para>Master-detail expand buttons are always displayed in black.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.DetailExpandButtonMode.CheckAllDetails">
|
|
<summary>
|
|
<para>Display master-detail expand buttons as grayed out if all details corresponding to a master row are empty.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.DetailExpandButtonMode.CheckDefaultDetail">
|
|
<summary>
|
|
<para>Display master-detail expand buttons as grayed out if the default detail is empty.
|
|
<para>
|
|
The default detail is identified by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridView.DefaultRelationIndex"/> property
|
|
</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.DetailExpandButtonMode.Default">
|
|
<summary>
|
|
<para>The same as the <see cref="F:DevExpress.XtraGrid.Views.Grid.DetailExpandButtonMode.CheckDefaultDetail"/> option.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode">
|
|
|
|
<summary>
|
|
<para>Lists values that specify whether multiple cells or rows can be selected.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode.CellSelect">
|
|
<summary>
|
|
<para><para>Enables individual cells and blocks of cells to be selected. This option is not supported in Advanced Banded Grid Views.</para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode.RowSelect">
|
|
<summary>
|
|
<para><para>Disables cell selection. In this case end-users can select only multiple rows by clicking an indicator cell and dragging the mouse.</para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridColumnSummaryItem">
|
|
|
|
<summary>
|
|
<para>A column's total summary item.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItem.#ctor">
|
|
<summary>
|
|
<para>Initializes a new GridColumnSummaryItem class instance.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItem.#ctor(DevExpress.Data.SummaryItemType,System.String,System.String)">
|
|
<summary>
|
|
<para>Initializes a new GridColumnSummaryItem class instance with the specified summary type, field name and display format.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that specifies a summary's summary type. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value that specifies a summary's field name. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridColumnSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value that specifies a summary's display format. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItem.#ctor(DevExpress.Data.SummaryItemType)">
|
|
<summary>
|
|
<para>Initializes a new GridColumnSummaryItem class instance with the specified summary type.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that specifies a summary's summary type. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItem.#ctor(DevExpress.Data.SummaryItemType,System.String,System.String,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new GridColumnSummaryItem class instance with the specified summary type, field name, display format and tag.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that specifies a summary's type. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value that specifies a summary's field name. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridColumnSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value that specifies a summary's display format. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An object value that specifies a summary's tag. This parameter initializes the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Tag"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridColumnSummaryItem.FieldName">
|
|
<summary>
|
|
<para>Gets or sets a name of the field for which a total summary should be calculated.
|
|
</para>
|
|
</summary>
|
|
<value>A string value that specifies the column's field name for which a total summary should be calculated.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItem.GetDefaultDisplayFormat">
|
|
<summary>
|
|
<para>Returns the default display format for a column's summary item.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that specifies the default display format.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridColumnSummaryItemCollection">
|
|
|
|
<summary>
|
|
<para>A column's total summary collection that can be displayed within the column's footer.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItemCollection.#ctor(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItemCollection"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItemCollection.Add(DevExpress.Data.SummaryItemType,System.String)">
|
|
<summary>
|
|
<para>Adds a new summary item to the current summary collection and initializes its summary type and field name.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that is the new item's summary type. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value that is field's name used to calculate the summary. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridColumnSummaryItem.FieldName"/> property.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItem"/> object that is a new summary item added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItemCollection.Add(DevExpress.Data.SummaryItemType,System.String,System.String)">
|
|
<summary>
|
|
<para>Adds a new summary item to the current summary collection and initializes its summary type, field name and display format.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that is the new item's summary type. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value that is the field's name used to calculate the summary. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridColumnSummaryItem.FieldName"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value that is the display format of the summary. The parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItem"/> object that is a new summary item added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItemCollection.Add(DevExpress.Data.SummaryItemType,System.String,System.String,System.IFormatProvider)">
|
|
<summary>
|
|
<para>Adds a new summary item to the current summary collection and initializes its summary type, field name, display format and format provider.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that is the new item's summary type. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value that is the field's name used to calculate the summary. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridColumnSummaryItem.FieldName"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value that is the display format of the summary. The parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="formatProvider">
|
|
A <see cref="T:System.IFormatProvider"/> value that provides the format of the summary. The parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Format"/> property.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItem"/> object that is a new summary item added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItemCollection.Add">
|
|
<summary>
|
|
<para>Adds a new empty item to the collection.
|
|
</para>
|
|
</summary>
|
|
<returns>A new <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItem"/> object that has been added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridColumnSummaryItemCollection.Add(DevExpress.Data.SummaryItemType)">
|
|
<summary>
|
|
<para>Adds a new summary item to the current summary collection and initializes its summary type.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that is the new item's summary type. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItem"/> object that is a new summary item added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridColumnSummaryItemCollection.Item(System.Object)">
|
|
<summary>
|
|
<para>Gets a summary item by its tag.
|
|
</para>
|
|
</summary>
|
|
<param name="tag">
|
|
An object that is the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Tag"/> property value of a summary item to be returned.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItem"/> object whose <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Tag"/> property matches the <i>tag</i> parameter value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridColumnSummaryItemCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Gets a summary item by its index.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer that is the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Index"/> value of a summary item to be returned.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItem"/> object whose <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Index"/> property matches the <i>index</i> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridColumnSummaryItemCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns the current column, and therefore, the current summary collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant that owns the current column, and therefore, the current summary collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.FilterEditor.ViewFilterColumnCollection">
|
|
|
|
<summary>
|
|
<para>This class is used to retrieve columns from a <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> object and populate a <see cref="T:DevExpress.XtraEditors.FilterControl"/> with these columns via the <see cref="M:DevExpress.XtraEditors.FilterControl.SetFilterColumnsCollection"/> method.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.FilterEditor.ViewFilterColumnCollection.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ViewFilterColumnCollection class with the columns from the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> object whose columns are used to initialize Filter Columns in the current collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.FilterEditor.ViewFilterColumnCollection.GetValueScreenText(DevExpress.Data.Filtering.OperandProperty,System.Object)">
|
|
<summary>
|
|
<para>Returns the display text of the specified value formatted by the specified Filter Column (the <i>property</i> parameter).
|
|
</para>
|
|
</summary>
|
|
<param name="property">
|
|
An <see cref="T:DevExpress.Data.Filtering.OperandProperty"/> value that represents a target Filter Column.
|
|
|
|
</param>
|
|
<param name="value">
|
|
The value to be formatted.
|
|
|
|
</param>
|
|
<returns>A string value that specifies the display text of the specified value formatted by the specified Filter Column (the <i>property</i> parameter).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.FilterEditor.ViewFilterColumnCollection.View">
|
|
<summary>
|
|
<para>Gets the View whose columns are used to initialize Filter Columns in the current collection.
|
|
</para>
|
|
</summary>
|
|
<returns> [To be supplied] </returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand">
|
|
|
|
<summary>
|
|
<para>Provides options for bands.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.#ctor">
|
|
<summary>
|
|
<para>Initializes an instance of the OptionsBand class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.AllowHotTrack">
|
|
<summary>
|
|
<para>Gets or sets whether the band header's appearance is changed when the mouse hovers over it.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band header's appearance is changed when the mouse hovers over it; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.AllowMove">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can move the band by dragging its header.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band can be moved; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.AllowPress">
|
|
<summary>
|
|
<para>Gets or sets whether the band's header can be pressed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band's header can be pressed; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.AllowSize">
|
|
<summary>
|
|
<para>Gets or sets whether the band can be resized by dragging the right edge of its header.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band can be resized by dragging the right edge of its header; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings from the options object passed as the parameter to the current options object.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.FixedWidth">
|
|
<summary>
|
|
<para>Gets or sets whether the band's width remains fixed when the View's auto width feature is enabled and the View is resized.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band's width remains fixed when the View's auto-width feature is enabled and the View is resized; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.ShowCaption">
|
|
<summary>
|
|
<para>Gets or sets whether the band's caption is displayed within the band header.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band's caption is displayed within the band header; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.ShowInCustomizationForm">
|
|
<summary>
|
|
<para>Gets or sets whether the band's header is displayed within the customization form when the band is invisible.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band header is displayed within the customization form when the band is invisible; otherwise <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnDisplayText"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnDisplayText"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnDisplayText"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CustomColumnDisplayTextEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row currently being processed. This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.RowHandle"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column that contains the currently processed cell. This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
An object representing the value of the currently processed cell. This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column that contains the cell currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column which contains the cell currently being processed.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.DisplayText">
|
|
<summary>
|
|
<para>Gets or sets the display text for the cell currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A string representing the cell's current display text.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.ListSourceRowIndex">
|
|
<summary>
|
|
<para>Gets the index in the data source of the row which contains the cell currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the row's index in the data source.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row that contains the cell being processed.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the visual position of the row within the View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs.Value">
|
|
<summary>
|
|
<para>Gets the edit value of the cell currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the edit value of the cell currently being processed.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomUnboundColumnData"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomUnboundColumnData"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomUnboundColumnData"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,System.Int32,System.Object,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CustomColumnDataEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the unbound column. This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="listSourceRow">
|
|
An integer value identifying the index in the data source of the row containing the currently processed cell. This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.ListSourceRowIndex"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="_value">
|
|
An object representing the currently processed cell's value. This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.Value"/> property.
|
|
|
|
</param>
|
|
<param name="isGetAction">
|
|
A Boolean value specifying whether the cell's value must be obtained from or saved to a data source. This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.IsGetData"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the unbound column currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the unbound column currently being processed.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.IsGetData">
|
|
<summary>
|
|
<para>Gets a Boolean value which indicates whether you should provide data for the currently processed cell.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if you need to provide data for the currently processed cell, <b>false</b> otherwise.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.IsSetData">
|
|
<summary>
|
|
<para>Gets whether the current cell's value should be stored in a custom data source.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current cell's value needs to be saved in a custom data source.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.ListSourceRowIndex">
|
|
<summary>
|
|
<para>Gets the current row's index in the data source.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value identifying the current row's index in the data source.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.Row">
|
|
<summary>
|
|
<para>Gets the currently processed row.
|
|
</para>
|
|
</summary>
|
|
<value>An object that is the currently processed row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the row's visual position within the View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs.Value">
|
|
<summary>
|
|
<para>Gets or sets the value of the cell currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the value of the cell currently being processed.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.ColumnWidthChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.ColumnEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.ColumnWidthChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.ColumnWidthChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ColumnEventArgs class with the specified band.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object referring to the column that will be processed. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column being processed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column being processed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.BandWidthChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.BandedGrid.BandEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.BandWidthChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.BandWidthChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandEventArgs.#ctor(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Initializes a new instance of the BandEventArgs class with the specified band.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object referring to the band that will be processed. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.BandEventArgs.Band"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandEventArgs.Band">
|
|
<summary>
|
|
<para>Gets the band currently being processed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band currently being processed.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection">
|
|
|
|
<summary>
|
|
<para>Represents a collection which contains the information required to sort the group rows by summary values.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.#ctor(DevExpress.XtraGrid.Views.Grid.GridView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> object or descendant representing the View that will own the collection. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.View"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.Add(DevExpress.XtraGrid.Columns.GroupSummarySortInfo)">
|
|
<summary>
|
|
<para>Appends a <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object to add to the collection. If <b>null</b> (<b>Nothing</b> in Visual Basic) an exception is raised.
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object which was added to the collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if it couldn't be added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.Add(DevExpress.XtraGrid.GridSummaryItem,DevExpress.Data.ColumnSortOrder,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> class with the specified parameters and appends it to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="summary">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object representing a summary item used to calculate summary values for groups of rows. If <b>null</b> (<b>Nothing</b> in Visual Basic) an exception is raised.
|
|
|
|
</param>
|
|
<param name="sortOrder">
|
|
A <see cref="T:DevExpress.Data.ColumnSortOrder"/> enumeration value specifying the sort order.
|
|
|
|
</param>
|
|
<param name="groupColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which defines the nesting level of the group whose rows will be sorted by the summary values.
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object added to the collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if the View is not grouped by the specified column's values.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.Add(DevExpress.XtraGrid.GridSummaryItem,DevExpress.Data.ColumnSortOrder)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> class with the specified sort order and appends it to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="summary">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object representing a summary item used to calculate summary values for groups of rows. If <b>null</b> (<b>Nothing</b> in Visual Basic) an exception is raised.
|
|
|
|
</param>
|
|
<param name="sortOrder">
|
|
A <see cref="T:DevExpress.Data.ColumnSortOrder"/> enumeration value specifying the sort order.
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object added to the collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if the View is not grouped.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.AddRange(DevExpress.XtraGrid.Columns.GroupSummarySortInfo[])">
|
|
<summary>
|
|
<para>Appends an array of <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> objects to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="sortInfos">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> objects to add to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.BeginUpdate">
|
|
<summary>
|
|
<para>Locks the GroupSummarySortInfoCollection by preventing change notifications from being fired, preventing visual updates until the <b>EndUpdate</b> method is called.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.ClearAndAddRange(DevExpress.XtraGrid.Columns.GroupSummarySortInfo[])">
|
|
<summary>
|
|
<para>Clears the collection and adds an array of <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> objects to it.
|
|
</para>
|
|
</summary>
|
|
<param name="sortInfos">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> objects to add to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.EndUpdate">
|
|
<summary>
|
|
<para>Unlocks the GroupSummarySortInfoCollection object after a call to the <b>BeginUpdate</b> method and causes an immediate visual update.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.IndexOf(DevExpress.XtraGrid.Columns.GroupSummarySortInfo)">
|
|
<summary>
|
|
<para>Returns the position of the specified item within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="info">
|
|
The <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns>A zero-based integer representing the specified item's position within the collection. <b>-1</b> if the collection doesn't contain the specified <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.Item(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Gets a <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object specified by its summary item.
|
|
</para>
|
|
</summary>
|
|
<param name="summary">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object specifying the <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.SummaryItem"/> property of the required collection item.
|
|
|
|
</param>
|
|
<value>The <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object whose <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.SummaryItem"/> property matches the parameter's value. <b>null</b> (<b>Nothing</b> in Visual Basic) if no item is found.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> objects.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
A zero-based integer specifying the index of the required item in the collection. If negative, an exception is raised.
|
|
|
|
</param>
|
|
<value>The <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object at the specified position. <b>null</b> (<b>Nothing</b> in Visual Basic) if the <i>index</i> parameter exceeds the last available index.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.Remove(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Removes from the collection the element that refers to the specified summary item.
|
|
</para>
|
|
</summary>
|
|
<param name="summary">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object used to identify which item to remove from the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.Remove(DevExpress.XtraGrid.Columns.GroupSummarySortInfo)">
|
|
<summary>
|
|
<para>Removes the specified <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object from the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> object to remove from the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns the current collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> object or a descendant that represents the View that owns the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo">
|
|
|
|
<summary>
|
|
<para>Represents an element in a <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.#ctor(DevExpress.XtraGrid.GridSummaryItem,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryItem">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object which represents a summary item used to calculate summary values for groups of rows. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.SummaryItem"/> property.
|
|
|
|
</param>
|
|
<param name="groupColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which defines the nesting level of the group whose rows will be sorted by the summary values. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.GroupColumn"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.#ctor(DevExpress.XtraGrid.GridSummaryItem,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Data.ColumnSortOrder)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfo"/> class with the specified sort order.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryItem">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object that represents a summary item used to calculate summary values for groups of rows. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.SummaryItem"/> property.
|
|
|
|
</param>
|
|
<param name="groupColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which defines the nesting level of the group whose rows will be sorted by the summary values. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.GroupColumn"/> property.
|
|
|
|
</param>
|
|
<param name="sortOrder">
|
|
A <see cref="T:DevExpress.Data.ColumnSortOrder"/> enumeration value specifying the sort order. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.SortOrder"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.GroupColumn">
|
|
<summary>
|
|
<para>Gets the grouped column which defines the nesting level of the group whose rows will be sorted by the summary values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which defines the nesting level of the group whose rows will be sorted by the summary values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.SortOrder">
|
|
<summary>
|
|
<para>Gets the order in which group rows are sorted.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.ColumnSortOrder"/> enumeration value specifying the order in which group rows are sorted.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GroupSummarySortInfo.SummaryItem">
|
|
<summary>
|
|
<para>Gets the summary item which is used to calculate summary values for groups of rows.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object which represents the summary item used to calculate summary values for groups of rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridLevelTree">
|
|
|
|
<summary>
|
|
<para>Represents a root node in the tree-like structure that associates master-detail relationships with pattern Views.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelTree.#ctor(DevExpress.XtraGrid.GridControl)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridLevelTree class.
|
|
</para>
|
|
</summary>
|
|
<param name="grid">
|
|
A <see cref="T:DevExpress.XtraGrid.GridControl"/> object which will receive change notifications for the created GridLevelTree object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelTree.GetTemplates">
|
|
<summary>
|
|
<para>Returns an array of the pattern Views assigned to the child nodes of the current node.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>An array of pattern Views assigned to child nodes of the current node.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelTree.IsRootLevel">
|
|
<summary>
|
|
<para>Gets whether the current node is the root node.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelTree.LevelTemplate">
|
|
<summary>
|
|
<para>Gets the main View of the grid control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object representing the grid's main View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelTree.RelationName">
|
|
<summary>
|
|
<para>Gets the string that identifies the root node.
|
|
</para>
|
|
</summary>
|
|
<value>A string that identifies the root node.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridLevelNodeCollection">
|
|
|
|
<summary>
|
|
<para>Represents a collection of <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> objects.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.#ctor(DevExpress.XtraGrid.GridLevelNode)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridLevelNodeCollection class with the specified owner.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="ownerNode">
|
|
A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the node that will own the created collection. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridLevelNodeCollection.OwnerNode"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.Add(System.String,DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Creates a new node and appends it to the current collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="relationName">
|
|
A string specifying the name of the relationship that the new node will represent. This parameter's value is used to initialize the node's <see cref="P:DevExpress.XtraGrid.GridLevelNode.RelationName"/> property.
|
|
|
|
</param>
|
|
<param name="template">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the pattern View to associate with the specified relationship. This parameter's value is used to initialize the node's <see cref="P:DevExpress.XtraGrid.GridLevelNode.LevelTemplate"/> property.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the created node.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.Add(DevExpress.XtraGrid.GridLevelNode)">
|
|
<summary>
|
|
<para>Adds the specified node to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="node">
|
|
A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the node to add to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.AddRange(DevExpress.XtraGrid.GridLevelNode[])">
|
|
<summary>
|
|
<para>Adds an array of nodes to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="nodes">
|
|
An array of <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> objects to add to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.Contains(System.String)">
|
|
<summary>
|
|
<para>Returns a Boolean value indicating whether the current collection contains a node that refers to the specified relationship.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="relationName">
|
|
A string representing the name of the relationship to locate in the collection.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the collection contains a node which refers to the specified relationship; otherwise, <b>false</b>.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.IndexOf(DevExpress.XtraGrid.GridLevelNode)">
|
|
<summary>
|
|
<para>Returns the index of the specified node in the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="node">
|
|
A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the node in the collection whose index is required.
|
|
|
|
|
|
</param>
|
|
<returns>An integer value representing the zero-based index of the specified node in the collection; <b>-1</b> if the node isn't found in the collection.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.Insert(System.Int32,System.String,DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Creates a node and inserts it at a specific point within the collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="position">
|
|
An integer value representing the zero-based index at which the new node should be added.
|
|
|
|
|
|
</param>
|
|
<param name="relationName">
|
|
A string specifying the name of the relationship that the new node will represent. This parameter's value is used to initialize the node's <see cref="P:DevExpress.XtraGrid.GridLevelNode.RelationName"/> property.
|
|
|
|
</param>
|
|
<param name="template">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the pattern View to associate with the specified relationship. This parameter's value is used to initialize the node's <see cref="P:DevExpress.XtraGrid.GridLevelNode.LevelTemplate"/> property.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the created node.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNodeCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to the nodes in the collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the zero-based index of the required collection item.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the node at the specified position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNodeCollection.Item(System.String)">
|
|
<summary>
|
|
<para>Gets a node by the name of the relationship which it represents.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="relationName">
|
|
The name of the relationship to locate.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the collection item whose <see cref="P:DevExpress.XtraGrid.GridLevelTree.RelationName"/> property matches the specified value. <b>null</b> if no item is found.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNodeCollection.OwnerNode">
|
|
<summary>
|
|
<para>Gets the node that owns the current collection.
|
|
</para>
|
|
</summary>
|
|
<value>The <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object that owns the collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNodeCollection.Remove(DevExpress.XtraGrid.GridLevelNode)">
|
|
<summary>
|
|
<para>Removes the specified child node.
|
|
</para>
|
|
</summary>
|
|
<param name="node">
|
|
A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object representing the node to delete from the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridLevelNode">
|
|
|
|
<summary>
|
|
<para>Represents a node in the tree-like structure that associates master-detail relationships with pattern Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNode.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridLevelNode class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNode.#ctor(DevExpress.XtraGrid.GridLevelTree,System.String,DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridLevelNode class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="tree">
|
|
A <see cref="T:DevExpress.XtraGrid.GridLevelTree"/> object representing the root node. A value for this parameter can be obtained via the <see cref="P:DevExpress.XtraGrid.GridControl.LevelTree"/> property.
|
|
|
|
</param>
|
|
<param name="relationName">
|
|
A string specifying the name of the relationship. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridLevelNode.RelationName"/> property.
|
|
|
|
</param>
|
|
<param name="template">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the pattern view associated with the specified relationship. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridLevelNode.LevelTemplate"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNode.Dispose">
|
|
<summary>
|
|
<para>Deletes the current node.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNode.Find(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Searches for the node that refers to the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="template">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the referenced View.
|
|
|
|
|
|
</param>
|
|
<returns>A GridLevelNode object that refers to the specified view; <b>null</b> if no node is found.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridLevelNode.Find(System.String)">
|
|
<summary>
|
|
<para>Searches for the node that refers to the specified relationship.
|
|
</para>
|
|
</summary>
|
|
<param name="relationName">
|
|
A string representing the referenced relationship.
|
|
|
|
|
|
</param>
|
|
<returns>A GridLevelNode object that refers to the specified relationship; <b>null</b> if no node is found.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.HasChildren">
|
|
<summary>
|
|
<para>Gets whether the current node has children
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the node has children; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.IsRootLevel">
|
|
<summary>
|
|
<para>Gets whether the current node is the root node.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current node is the root node; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.Level">
|
|
<summary>
|
|
<para>Gets the nesting level of the current node.
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer representing the nesting level of the node.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.LevelTemplate">
|
|
<summary>
|
|
<para>Gets or sets the pattern view associated with a relationship.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the pattern View associated with a relationship.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.Nodes">
|
|
<summary>
|
|
<para>Provides access to the collection of child nodes.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridLevelNodeCollection"/> object representing the collection of child nodes.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.OwnerCollection">
|
|
<summary>
|
|
<para>Gets the node collection that owns the current node.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridLevelNodeCollection"/> object representing the collection that owns the node.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.Parent">
|
|
<summary>
|
|
<para>Gets the parent node of the current node.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridLevelNode"/> object that refers to the parent node.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridLevelNode.RelationName">
|
|
<summary>
|
|
<para>Gets or sets the name of the relationship for which the current node provides a pattern view.
|
|
</para>
|
|
</summary>
|
|
<value>A string identifying the relationship's name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsView">
|
|
|
|
<summary>
|
|
<para>Provides appearance options for Advanced Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsView.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsView.AllowCellMerge">
|
|
<summary>
|
|
<para>Gets or sets whether neighboring cells with identical values can be merged.
|
|
</para>
|
|
</summary>
|
|
<value><b>false</b> always
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsView.ColumnAutoWidth">
|
|
<summary>
|
|
<para>Gets or sets a value which specifies whether column widths are automatically modified so that the total width of all the columns matches the View's width.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to enable the column auto width feature; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsView.RowAutoHeight">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the height of each data row is automatically adjusted so as to completely display the contents of its cells.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to enable automatic calculation of the heights of data rows; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewPrintAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings used to paint the elements in a Banded Grid View when the grid control is printed/exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedViewPrintAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewPrintAppearances"/> class with the specified owning View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedViewPrintAppearances.BandPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint band headers when the grid control is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewPrintAppearances"/> object that provides the appearance settings used to paint band headers when the grid control is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings used to paint the elements in a Banded Grid View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedViewAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewPrintAppearances"/> class with the specified owning View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedViewAppearances.BandPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint band headers.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint band headers.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedViewAppearances.BandPanelBackground">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the band panel's background.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the band panel's background.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedViewAppearances.HeaderPanelBackground">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the column header panel's background.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the column header panel's background.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnViewPrintAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings which are used to paint the elements that are common to all types of Views when the grid control is printed/exported.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewPrintAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewPrintAppearances"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewPrintAppearances.FilterPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the filter panel when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance settings used to paint the filter panel when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings used to paint the elements in a Grid View when the grid control is printed/exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.EvenRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the even data rows when the grid control is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceOptions"/> object which provides the appearance settings used to paint even data rows when the grid control is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.FooterPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the view footer when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the View footer when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.GroupFooter">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the group footer when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the group footer when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.GroupRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint group rows when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint group rows when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.HeaderPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint column headers when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint column headers when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.Lines">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the horizontal and vertical lines when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the horizontal and vertical lines when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.OddRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint odd data rows when the grid control is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint odd data rows when the grid control is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.Preview">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the preview sections when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the preview sections when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.Row">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the data rows when the grid control is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the data rows when the grid control is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings used to paint the elements in a Card View when the grid control is printed/exported.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant which represents the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances.Card">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint cards when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance settings used to paint cards when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances.CardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint card captions when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance settings used to paint card captions when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances.FieldCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint field captions when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance settings used to paint card field captions when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances.FieldValue">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the field values when the grid is printed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance settings used to paint the field values when the grid is printed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridViewAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings used to paint the elements in a Grid View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridViewAppearances"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.ColumnFilterButton">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint filter buttons.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint column filter buttons.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.ColumnFilterButtonActive">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the filter buttons displayed within columns that are involved in filtering.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the filter buttons displayed within columns that are involved in filtering.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.CustomizationFormHint">
|
|
<summary>
|
|
<para>Gets or sets the appearance of the hint text displayed within an empty Customization Form.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that contains corresponding style settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.DetailTip">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the detail tooltips.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the detail tooltips.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.Empty">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the View's empty space.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the View's empty space.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.EvenRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint even data rows.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint even data rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.FixedLine">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the fixed lines.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing the appearance settings used to paint the fixed lines.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.FocusedCell">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the currently focused row cell.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the currently focused row cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.FocusedRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the currently focused row.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the currently focused row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.FooterPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the view footer.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the View footer.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.GroupButton">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint group expand buttons.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint group expand buttons.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.GroupFooter">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the group footer.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the group footer.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.GroupPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the group panel.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the group panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.GroupRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint group rows (and the corresponding indents).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint group rows and the corresponding indents.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.HeaderPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint column headers and row indicator panel.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint column headers.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.HideSelectionRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the selected row(s) when the grid control is not focused.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the selected row(s) when the grid control is not focused.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.HorzLine">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the horizontal lines.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the horizontal lines.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.OddRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint odd data rows.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint odd data rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.Preview">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the preview sections.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the preview sections.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.Row">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the data rows.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the data rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.RowSeparator">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the row separators.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the row separators.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.SelectedRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the selected data rows.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the selected data rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.TopNewRow">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the new item row when it is displayed at the top of a View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the new item row when it is displayed at the top of a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.VertLine">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the vertical lines.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the vertical lines.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowStyleEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowStyleEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event sender. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Views.Base.GridRowCellState,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which specifies the handle of the processed row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridRowCellState"/> enumeration value which specifies the current state of the processed row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs.State"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the processed row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs.Appearance">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the cells within the row currently being processed.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the row currently being processed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs.CombineAppearance(DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Copies the activated settings of the appearance object passed as the parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that represents the source of the operation.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs.HighPriority">
|
|
<summary>
|
|
<para>Gets or sets whether the appearance settings provided by the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowStyle"/> event have a higher priority than the appearances specified by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.EvenRow"/> and <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.OddRow"/> properties.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the appearance settings provided by the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowStyle"/> event have a higher priority; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowStyleEventArgs.State">
|
|
<summary>
|
|
<para>Gets the current state of the processed row.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.GridRowCellState"/> enumeration value which specifies the current state of the processed row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.InitNewRowEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.InitNewRow"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.InitNewRowEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.InitNewRowEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.InitNewRow"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event sender. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.InitNewRowEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.InitNewRowEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.InitNewRow"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.InitNewRowEventArgs.#ctor(System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.InitNewRowEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the added row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.InitNewRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.InitNewRowEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the added row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the handle of the added row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CellMergeEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CellMerge"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CellMergeEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CellMerge"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CellMerge"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.#ctor(System.Int32,System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CellMergeEventArgs class with the specified rows and column.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle1">
|
|
The handle of the first row which contains the value to be merged. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.RowHandle1"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle2">
|
|
The handle of the second row which contains the value to be merged. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.RowHandle2"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> that represents the column containing the cells to be merged. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.CellValue1">
|
|
<summary>
|
|
<para>Gets the value of the first cell being merged.
|
|
</para>
|
|
</summary>
|
|
<value>An object that specifies the value of the first cell being merged.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.CellValue2">
|
|
<summary>
|
|
<para>Gets the value of the second cell being merged.
|
|
</para>
|
|
</summary>
|
|
<value>An object that specifies the value of the second cell being merged.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column that contains the values to be merged.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> that contains the values to be merged.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets whether the cell merging operation is handled and therefore no default processing is required.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the cell merging operation is handled and no default processing is required; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.Merge">
|
|
<summary>
|
|
<para>Gets or sets whether two cells should be merged.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the cells should be merged; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.RowHandle1">
|
|
<summary>
|
|
<para>Gets the handle of the row which contains the first of two cells that are to be merged.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer representing the handle of the row that contains the first cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CellMergeEventArgs.RowHandle2">
|
|
<summary>
|
|
<para>Gets the handle of the row which contains the second of two cells that are to be merged.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer representing the handle of the row that contains the second cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.AutoFilterCondition">
|
|
|
|
<summary>
|
|
<para>Enumerates the comparison operator types for the filter conditions created for specific columns via the automatic filtering row.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.AutoFilterCondition.Contains">
|
|
<summary>
|
|
<para><para>
|
|
The <b>Contains</b> operator selects records whose values in the corresponding column contain the entered string.
|
|
</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.AutoFilterCondition.Default">
|
|
<summary>
|
|
<para><para>
|
|
For columns being filtered by their display text (see <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.FilterMode"/>), the <b>Default</b> option acts identically to the <b>Like</b> option.
|
|
</para>
|
|
|
|
<para>
|
|
The <b>Default</b> option acts like the <b>Equals</b> option for the columns that have any of the following in-place editors or any of their descendants: <see cref="T:DevExpress.XtraEditors.CheckEdit"/>, <see cref="T:DevExpress.XtraEditors.DateEdit"/>, <see cref="T:DevExpress.XtraEditors.LookUpEditBase"/> or <see cref="T:DevExpress.XtraEditors.ImageComboBoxEdit"/>.
|
|
</para>
|
|
|
|
<para>
|
|
For other columns, the <b>Default</b> option acts identically to the <b>Like</b> option.
|
|
</para>
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.AutoFilterCondition.Equals">
|
|
<summary>
|
|
<para>The <b>Equals</b> comparison operator selects records whose values in the corresponding column match the entered value.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.AutoFilterCondition.Like">
|
|
<summary>
|
|
<para><para>
|
|
The <b>Like</b> comparison operator selects records whose values in the corresponding column start with the entered string.
|
|
</para>
|
|
|
|
For the columns that use <see cref="T:DevExpress.XtraEditors.CheckEdit"/>, <see cref="T:DevExpress.XtraEditors.DateEdit"/>, <see cref="T:DevExpress.XtraEditors.LookUpEditBase"/> or <see cref="T:DevExpress.XtraEditors.ImageComboBoxEdit"/> in-place editors, the <b>Equals</b> operator is always used, unless these columns are filtered by display text (see <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.FilterMode"/>).
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.NewItemRowPosition">
|
|
|
|
<summary>
|
|
<para>Specifies the position of the new item row within the View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.NewItemRowPosition.Bottom">
|
|
<summary>
|
|
<para><para>The new item row is positioned at the bottom of the View.</para>
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.NewItemRowPosition.None">
|
|
<summary>
|
|
<para><para>The new item row is not shown.</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.NewItemRowPosition.Top">
|
|
<summary>
|
|
<para><para>The new item row is positioned at the top of the View.</para>
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GroupDrawMode">
|
|
|
|
<summary>
|
|
<para>Lists values which specify the available styles for group rows.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GroupDrawMode.Default">
|
|
<summary>
|
|
<para>The style of group rows is based upon the paint style applied to the View. If the View is painted in the <b>Office2003</b> style, group rows are painted in an Office 2003 style. Otherwise, group rows are painted in the standard style. To specify the View's paint style, use the <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.PaintStyleName"/> property.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GroupDrawMode.Office2003">
|
|
<summary>
|
|
<para><para>Group rows are painted in the Office 2003 style.</para>
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GroupDrawMode.Standard">
|
|
<summary>
|
|
<para><para>Group rows are painted in the standard style.</para>
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardViewAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings used to paint the elements in a Card View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardViewAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardViewAppearances"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.Card">
|
|
<summary>
|
|
<para>Gets the appearance settings for all the cards within a View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object representing the card's appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.CardButton">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint card buttons.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing the appearance settings used to paint card buttons.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.CardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint card captions.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides appearance settings for painting card captions.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.CardExpandButton">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint card expand buttons.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object which represents the appearance settings used to paint card expand buttons.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.EmptySpace">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the View's empty space.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing appearance settings for painting an empty space.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.FieldCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint field captions.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance settings used to paint card field captions.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.FieldValue">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the field values in a Card View.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing appearance settings for painting field values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.FocusedCardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the caption of the focused card.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing appearance settings for painting the focused card's caption.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.HideSelectionCardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the captions of selected cards when the grid control is not focused.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing appearance settings for painting the captions of selected cards when the grid control is not focused.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.SelectedCardCaption">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the captions of selected cards.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing appearance settings for painting the captions of selected cards.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardViewAppearances.SeparatorLine">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the card separators.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing appearance settings for painting the card separators.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomCardCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomCardCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
An event source identifying the View which raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs"/> object providing data for the event.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomCardCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.#ctor(System.Int32,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which identifies the processed card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="list">
|
|
An object which represents the source of images. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.ImageList"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.Image">
|
|
<summary>
|
|
<para>Gets or sets the image to be displayed within an element.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Image"/> object representing the image to be displayed within an element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.ImageIndex">
|
|
<summary>
|
|
<para>Gets or sets the index of the image to be displayed within a visual element.
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer specifying the image by its index within the source collection. <b>-1</b>, if no image is assigned to a visual element from the source collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.ImageList">
|
|
<summary>
|
|
<para>Gets or sets the source collection of images.
|
|
</para>
|
|
</summary>
|
|
<value>An object which represents the source of the images that can be displayed within visual elements.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the processed card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value identifying the processed card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ViewFilter">
|
|
|
|
<summary>
|
|
<para>Represents a collection of filter conditions applied to a View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ViewFilter class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView,DevExpress.Data.Filtering.CriteriaOperator)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ViewFilter class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> object that represents the View which the filtering is applied to.
|
|
|
|
</param>
|
|
<param name="filter">
|
|
A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> descendant that determines the filter criteria for the specified View.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.Add(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraGrid.Columns.ColumnFilterInfo)">
|
|
<summary>
|
|
<para>Adds the specified filter criteria to the collection and thus applies them to a View.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column which the specified filter condition is applied to.
|
|
|
|
</param>
|
|
<param name="filter">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object specifying the filter condition applied to the column.
|
|
|
|
</param>
|
|
<returns>A zero-based integer specifying the position at which the filter condition was added amongst the other filter conditions within the current collection. <b>-1</b> if the given filter condition's functionality is disabled (its <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Kind"/> property is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.None"/>).
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.Add(DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo)">
|
|
<summary>
|
|
<para>Adds the specified filter criteria to the collection and thus applies them to a View.
|
|
</para>
|
|
</summary>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo"/> object referring to a specific column and the filter condition which will be applied to this column.
|
|
|
|
</param>
|
|
<returns>A zero-based integer specifying the position at which the filter condition was added amongst the other filter conditions within the current collection. <b>-1</b> if the given filter condition's functionality is disabled (its <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Kind"/> property is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.None"/> or column is <b>null</b>).
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.AddRange(DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo[])">
|
|
<summary>
|
|
<para>Adds an array of filter criteria to the collection and thus applies them to a View.
|
|
</para>
|
|
</summary>
|
|
<param name="info">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo"/> objects to be added to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.BeginUpdate">
|
|
<summary>
|
|
<para>Locks the ViewFilter by preventing change notifications from being fired, preventing visual updates until the <b>EndUpdate</b> method is called.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ViewFilter.Changed">
|
|
<summary>
|
|
<para>Occurs when the current collection has been changed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.Clone">
|
|
<summary>
|
|
<para>Creates a copy of the current ViewFilter object.
|
|
</para>
|
|
</summary>
|
|
<returns>A copy of the current ViewFilter object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.Criteria">
|
|
<summary>
|
|
<para>Specifies the View's filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object which specifies the filter criteria.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.DisplayText">
|
|
<summary>
|
|
<para>Gets the textual representation of the entire filter string.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>The textual representation of the entire filter string.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.EndUpdate">
|
|
<summary>
|
|
<para>Unlocks the ViewFilter object after a call to the <b>BeginUpdate</b> method and causes an immediate visual update.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.Expression">
|
|
<summary>
|
|
<para>Gets the total filter expression.
|
|
</para>
|
|
</summary>
|
|
<value>A string value representing the total filter expression. An empty string if there are no elements in the collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.FilterExpression">
|
|
<summary>
|
|
<para>Gets the filter criteria which is applied to a View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> descendant that represents the logical expression to be applied as a View filter.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.IndexOf(DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo)">
|
|
<summary>
|
|
<para>Returns the specified <b>ViewColumnFilterInfo</b> object's position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo"/> object to be located.
|
|
|
|
</param>
|
|
<returns>An integer value representing the specified <b>ViewColumnFilterInfo</b> object's zero-based index. <b>-1</b> if the collection doesn't contain the specified object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.IsEmpty">
|
|
<summary>
|
|
<para>Gets whether the collection of filter conditions is empty.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the collection of filter conditions is empty; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.Item(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Gets the collection's item that represents the filter criteria associated with the specified column.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> identifying the collection's required item.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo"/> object containing the filter condition which is associated with the specified column. <b>null</b> if no such object exists in the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to the items in the collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the zero-based index of the required <see cref="T:DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo"/> object.
|
|
|
|
</param>
|
|
<value>The <see cref="T:DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo"/> object at the specified position within the collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.NonColumnFilter">
|
|
<summary>
|
|
<para>Gets or sets a filter expression that is not associated with any column.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies a filter expression, not associated with any column, which is applied to the current View .
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewFilter.NonColumnFilterCriteria">
|
|
<summary>
|
|
<para>Gets or sets the filter criteria not bound to any column.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object that specifies filter criteria not bound to any column.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.Remove(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Removes the filter criteria from the collection that refers to the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object identifying the filter criteria to be removed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewFilter.Remove(DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo)">
|
|
<summary>
|
|
<para>Removes the specified filter criteria from the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewColumnFilterInfo"/> object to be removed from the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnSort"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomColumnGroup"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnSort"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomColumnGroup"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event sender. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnSort"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomColumnGroup"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,System.Object,System.Object,DevExpress.Data.ColumnSortOrder)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CustomColumnSortEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column that contains the values to compare. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="value1">
|
|
An object representing the first of the two values being compared. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Value1"/> property.
|
|
|
|
</param>
|
|
<param name="value2">
|
|
An object representing the second of the two values being compared. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Value2"/> property.
|
|
|
|
</param>
|
|
<param name="sortOrder">
|
|
A <see cref="T:DevExpress.Data.ColumnSortOrder"/> value representing the sort order applied to the specified column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.SortOrder"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column whose values are being compared.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> whose values are being compared.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets whether a comparison operation is handled and therefore no default processing is required.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a comparison operation is handled; otherwise <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.ListSourceRowIndex1">
|
|
<summary>
|
|
<para>Gets the index in the data source of the first of the two rows being compared.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the index of the first row in the data source.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.ListSourceRowIndex2">
|
|
<summary>
|
|
<para>Gets the index in the data source of the second of the two rows being compared.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the index in the data source of the second row.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Result">
|
|
<summary>
|
|
<para>Gets or sets the result of a custom comparison.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the custom comparison's result.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.RowObject1">
|
|
<summary>
|
|
<para>Gets the first row object being compared.
|
|
</para>
|
|
</summary>
|
|
<value>An object that represents the first row being compared.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.RowObject2">
|
|
<summary>
|
|
<para>Gets the second row object being compared.
|
|
</para>
|
|
</summary>
|
|
<value>An object that represents the second row being compared.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.SortOrder">
|
|
<summary>
|
|
<para>Gets the current sort order applied to the column being processed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.ColumnSortOrder"/> value representing the column's sort order.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Value1">
|
|
<summary>
|
|
<para>Gets the first value being compared.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the first value being compared.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomColumnSortEventArgs.Value2">
|
|
<summary>
|
|
<para>Gets the second value being compared.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the second value being compared.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection">
|
|
|
|
<summary>
|
|
<para>Serves as the base for classes which provide selection options for Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings of the options object passed as this method's parameter to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection.MultiSelect">
|
|
<summary>
|
|
<para>Gets or sets whether multiple rows (cards) can be selected.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to allow multiple row (card) selections; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter">
|
|
|
|
<summary>
|
|
<para>Provides filtering options for Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.AllowColumnMRUFilterList">
|
|
<summary>
|
|
<para>Gets or sets whether recently used filter items are displayed in the Filter dropdowns for columns.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the columns' filter dropdown lists can display recently used filter items; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.AllowFilterEditor">
|
|
<summary>
|
|
<para>Gets or sets whether the Filter Editor can be used to build complex filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to allow using the <b>Filter Editor</b>; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.AllowFilterIncrementalSearch">
|
|
<summary>
|
|
<para>Gets or sets whether incremental searching is supported in columns' Regular and Checked Filter Dropdown Lists.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if incremental searching is supported in columns' Regular and Checked Filter Dropdown Lists; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.AllowMRUFilterList">
|
|
<summary>
|
|
<para>Gets or sets whether the View's MRU Filter List is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the MRU Filter List is enabled; otherwise <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.AllowMultiSelectInCheckedFilterPopup">
|
|
<summary>
|
|
<para>Gets or sets whether multiple items can be simultaneously selected (highlighted) in a Checked Filter Dropdown List.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if multiple items can be simultaneously selected (highlighted) in a Checked Filter Dropdown List; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings of the options object passed as this method's parameter to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.ColumnFilterPopupMaxRecordsCount">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of records whose field values can be displayed within filter dropdowns.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the maximum number of records whose field values can be displayed within filter dropdowns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.ColumnFilterPopupRowCount">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of items that regular filter dropdowns in columns, can display simultaneously.
|
|
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the maximum height of regular filter dropdowns. The height is specified in rows.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.DefaultFilterEditorView">
|
|
<summary>
|
|
<para>Gets or sets how an end-user can edit criteria in the Filter Editor.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.FilterEditorViewMode"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.FilterEditorAggregateEditing">
|
|
<summary>
|
|
<para>Gets or sets whether filters can be created against properties that are List objects.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.FilterControlAllowAggregateEditing"/> value that specifies if filters can be created against properties that are List objects.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.FilterEditorUseMenuForOperandsAndOperators">
|
|
<summary>
|
|
<para>Gets or sets whether a menu or combobox editor is used to select operands and operators in a Filter Editor. This property is not supported when filters are edited in a text form (see <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.DefaultFilterEditorView"/>).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a menu is used to select operands and operators in a Filter Editor; <b>false</b> if a combobox editor is used.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.MaxCheckedListItemCount">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of items in a column's filter dropdown when the items are displayed as a check list.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the maximum number of items in a column's filter dropdown in <b>CheckedList</b> display mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.MRUColumnFilterListCount">
|
|
<summary>
|
|
<para>Gets or sets the capacity of the lists that store the recently used filter items for the View's columns.
|
|
</para>
|
|
</summary>
|
|
<value>An integer specifying the capacity of the lists that store the recently used filter items for the View's columns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.MRUFilterListCount">
|
|
<summary>
|
|
<para>Gets or sets the capacity of the list that stores the recently used filter conditions for the View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer that specifies the maximum number of recently used filter conditions which are stored by the View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.MRUFilterListPopupCount">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of items the View's MRU Filter List can display at once, in effect its height.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that determines the maximum number of items that the View's MRU Filter List can display at once.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.ShowAllTableValuesInCheckedFilterPopup">
|
|
<summary>
|
|
<para>Gets or sets whether checked filter dropdown lists must display unique values from all the records in the View's data source or only from those records that meet the current filter criteria. This option is in effect for checked filter dropdown lists.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if checked filter dropdowns should contain unique values from all the records in the View's data source; <b>false</b> if the checked filter dropdowns of unfiltered columns should contain unique values from only the records that meet the current filter criteria.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.ShowAllTableValuesInFilterPopup">
|
|
<summary>
|
|
<para>Gets or sets whether filter dropdown lists must display unique values from all the records in the View's data source or only from those records that meet the current filter criteria. This option is in effect for regular filter dropdown lists.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if filter dropdowns should contain unique values from all the records in the View's data source; <b>false</b> if the filter dropdowns of unfiltered columns should contain unique values only from the records that meet the current filter criteria.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter.UseNewCustomFilterDialog">
|
|
<summary>
|
|
<para>Gets or sets whether the advanced custom filter dialog is used instead of the standard one.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to use the advanced custom filter dialog; <b>false</b> to use the standard filter dialog.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior">
|
|
|
|
<summary>
|
|
<para>Serves as the base for classes which provide behavior options for Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior"/> class with the specified owning View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> object whose behavior options are initialized.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.AllowAddRows">
|
|
<summary>
|
|
<para>Gets or sets whether the Data Navigator's Append button is enabled for the current View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies whether the Data Navigator's Append button is enabled for the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.AllowDeleteRows">
|
|
<summary>
|
|
<para>Gets or sets whether the Data Navigator's Delete button is enabled for the current View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies whether the Data Navigator's Delete button is enabled for the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings of the options object passed as this method's parameter to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.AutoPopulateColumns">
|
|
<summary>
|
|
<para>Gets or sets whether columns should be created automatically for all fields in the underlying data source when the View doesn't contain any columns.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the columns are created automatically when the View doesn't contain any columns; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.AutoSelectAllInEditor">
|
|
<summary>
|
|
<para>Gets or sets whether activating a cell editor using the ENTER or F2 keys leads to the entire editor's content being selected.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to select the entire cell's content when editing starts; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.CacheValuesOnRowUpdating">
|
|
<summary>
|
|
<para>Gets or sets whether the grid caches data for a row that is about to be saved to a data source.
|
|
</para>
|
|
</summary>
|
|
<value>A DevExpress.Data.CacheRowValesMode value that specifies the caching mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.Editable">
|
|
<summary>
|
|
<para>Gets or sets whether end-users are allowed to invoke cell editors.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users are allowed to invoke cell editors; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.EditorShowMode">
|
|
<summary>
|
|
<para>Gets or sets a value which specifies how a cell editor is activated by the mouse.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.EditorShowMode"/> enumeration value which specifies how a cell editor is activated by the mouse.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.FocusLeaveOnTab">
|
|
<summary>
|
|
<para>Gets or sets whether pressing the TAB key moves focus to the next control in the tab order, if moving focus via the TAB key within the View is prohibited (or cannot be performed).
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to allow focus to be moved away from the grid control when the TAB key is pressed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.ImmediateUpdateRowPosition">
|
|
<summary>
|
|
<para>Gets or sets whether a row's position is immediately updated according to the current sorting, grouping and filtering settings after the row's data has been modified.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a row's position is immediately updated after its data has been modified; <b>false</b> otherwise.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.KeepFocusedRowOnUpdate">
|
|
<summary>
|
|
<para>Gets or sets whether the currently focused row retains focus when data is sorted, grouped or filtered or when records are added to/removed from the underlying data source.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the currently focused row retains focus when data is sorted, grouped or filtered or when records are added to/removed from the underlying data source; <b>false</b> if the focused row handle (visual position) is kept when these actions are performed.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.ReadOnly">
|
|
<summary>
|
|
<para>Gets or sets whether the current View is read-only.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current View is read-only; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.ShowAllTableValuesInFilterPopup">
|
|
<summary>
|
|
<para>Gets or sets whether the filter dropdowns should contain unique values from all the records in the View's data source or only from those records that meet the current filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if filter dropdowns should contain unique values from all the records in the View's data source; <b>false</b> if the filter dropdowns of unfiltered columns should contain unique values only from the records that meet the current filter criteria.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.ShowEditorOnMouseUp">
|
|
<summary>
|
|
<para>Gets or sets whether a cell's editor is activated when the mouse button is released from a click within the cell.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to activate a cell's editor when the mouse button is released from a click within the cell; <b>false</b> to activate a cell's editor when the mouse button is initially pressed within the cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.UseNewCustomFilterDialog">
|
|
<summary>
|
|
<para>Gets or sets whether the advanced custom filter dialog is used instead of the standard one.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to use the advanced custom filter dialog; <b>false</b> to use the standard filter dialog.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnViewAppearances">
|
|
|
|
<summary>
|
|
<para>Provides the appearance settings used to paint elements which are common to all types of View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnViewAppearances.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewAppearances"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewAppearances.FilterCloseButton">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the filter close button.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing the appearance settings used to paint the filter close button.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewAppearances.FilterPanel">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the filter panel.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object providing the appearance settings used to paint the filter panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnViewAppearances.ViewCaption">
|
|
<summary>
|
|
<para>Contains appearance settings used to customize the View Caption.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> that contains corresponding appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.OptionsColumnFilter">
|
|
|
|
<summary>
|
|
<para>Contains filter options for columns.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.OptionsColumnFilter.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the OptionsColumnFilter class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.AllowAutoFilter">
|
|
<summary>
|
|
<para>Gets or sets whether the column's values can be filtered using the auto filter row.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's values can be filtered using the automatic filtering row; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.AllowFilter">
|
|
<summary>
|
|
<para>Gets or sets whether the filter button in Grid Views (field filter button in Layout Views) is displayed within the column header.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's filter button is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.AllowFilterModeChanging">
|
|
<summary>
|
|
<para>Gets or sets whether a dedicated menu item is available in a column header menu that allows an end-user to change the filter mode for columns.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies that a user can change a column's filter mode via a menu item.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.OptionsColumnFilter.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings from the options object passed as the parameter.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.AutoFilterCondition">
|
|
<summary>
|
|
<para>Gets or sets the type of the comparison operator used to create filter conditions for the current column via the auto filter row.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.XtraGrid.Columns.AutoFilterCondition"/> value that determines the type of the comparison operator used to create filter conditions for the current column via the auto filter row.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.FilterBySortField">
|
|
<summary>
|
|
<para>Gets or sets whether the column's Filter Dropdown List displays values of the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.FieldNameSortGroup"/> field or values of the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.FieldName"/> field.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.FilterPopupMode">
|
|
<summary>
|
|
<para>Gets or sets the display mode for the current column's filter dropdown.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.FilterPopupMode"/> value that specifies the display mode for the column's filter dropdown list.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.ImmediateUpdateAutoFilter">
|
|
<summary>
|
|
<para>Gets or sets whether the column's filter condition is updated as soon as an end-user modifies the contents of the Auto Filter Row's cell.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's filter condition is updated each time an end-user modifies the contents of the auto filter row's cell; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.ImmediateUpdatePopupDateFilterOnCheck">
|
|
<summary>
|
|
<para>This option is in effect for date-time columns whose filter dropdown list contains an embedded calendar with check boxes to select common date intervals.
|
|
It specifies whether toggling the check boxes filters grid records immediately.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies whether data is filtered immediately, when toggling the check boxes in the filter dropdown.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.ImmediateUpdatePopupDateFilterOnDateChange">
|
|
<summary>
|
|
<para>This option is in effect for date-time columns whose filter dropdown list contains an embedded calendar with check boxes to select common date intervals.
|
|
It specifies whether selecting a date or date range via the embedded calendar filters grid records immediately.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies whether data is filtered immediately, when selecting a date or date range via the calendar.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumnFilter.ShowEmptyDateFilter">
|
|
<summary>
|
|
<para>Gets or sets whether a Filter Dropdown List has a filter used to select records that contain null values in a date-time column.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a corresponding filter is available; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.OptionsColumn">
|
|
|
|
<summary>
|
|
<para>Provides options for columns.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.OptionsColumn.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.OptionsColumn"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowEdit">
|
|
<summary>
|
|
<para>Gets or sets whether end-users are allowed to invoke editors for the column's cells.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users are allowed to invoke cell editors; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowFocus">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can move focus to the column using either the mouse or keyboard.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can move focus to the column using either the mouse or keyboard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowGroup">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can drag the column's header to the group panel to group data against the column's values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> enumeration value specifying whether end-users can drag the column's header to the group panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowIncrementalSearch">
|
|
<summary>
|
|
<para>Gets or sets whether incremental searches can be performed on the column.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if incremental searches can be performed against the column; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowMerge">
|
|
<summary>
|
|
<para>Gets or sets whether neighboring cells with identical values can be merged within the current column.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> enumeration value which specifies whether neighboring cells with identical values can be merged.
|
|
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowMove">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can drag the column's header.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can drag the column's header; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowShowHide">
|
|
<summary>
|
|
<para>Gets or sets whether the column can be hidden or restored by an end-user.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column can be hidden or restored by an end-user; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowSize">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can drag the column header's right edge to change the column's width.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can change the column's width; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowSort">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can sort data by the column's values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> enumeration value specifying whether end-users can sort data by the column's values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.OptionsColumn.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings from the options object passed as the parameter to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.FixedWidth">
|
|
<summary>
|
|
<para>Gets or sets whether the column's width remains the same when the column's auto width feature is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's width remains the same when the column's auto width feature is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.ReadOnly">
|
|
<summary>
|
|
<para>Gets or sets whether end-users are prevented from editing the column's cell values.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users are prevented from modifying the column's cell values; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.ShowCaption">
|
|
<summary>
|
|
<para>Gets or sets whether the column's caption is displayed within the column header.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's caption is displayed within the column header; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.ShowInCustomizationForm">
|
|
<summary>
|
|
<para>Gets or sets whether the column's header is displayed within the customization form when the column is hidden.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's header is displayed within the customization form when the column is hidden; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.ShowInExpressionEditor">
|
|
<summary>
|
|
<para>Gets or sets whether the current column is available in the field list in the Expression Editor.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current column is available in the field list in the Expression Editor; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.OptionsColumn.TabStop">
|
|
<summary>
|
|
<para>Gets or sets whether the column can be focused via the TAB key.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column can be focused via the TAB key; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection">
|
|
|
|
<summary>
|
|
<para>Represents the collection that maintains the sorted and grouping columns for a grid's View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridColumnSortInfoCollection class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> object representing a View that will be sorted using the information from the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Add(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Data.ColumnSortOrder)">
|
|
<summary>
|
|
<para>Adds a new <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> item to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which will be sorted using the specified sort order. This parameter's value is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.Column"/> property.
|
|
|
|
</param>
|
|
<param name="sortOrder">
|
|
A <see cref="T:DevExpress.Data.ColumnSortOrder"/> value specifying the sort order for the column. This parameter's value is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.SortOrder"/> property.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object representing the new element in the collection; <b>null</b> if the object cannot be added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Add(DevExpress.XtraGrid.Columns.GridColumnSortInfo)">
|
|
<summary>
|
|
<para>Adds the specified <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="columnInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object to add to the collection.
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object that has been added to the collection; <b>null</b> if the object cannot be added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.AddRange(DevExpress.XtraGrid.Columns.GridColumnSortInfo[],System.Int32)">
|
|
<summary>
|
|
<para>Adds an array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> objects to the current collection and sets how many columns are used to group data.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="sortInfos">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> objects to add to the current collection.
|
|
|
|
</param>
|
|
<param name="groupCount">
|
|
An integer value specifying how many columns are used to group data.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.AddRange(DevExpress.XtraGrid.Columns.GridColumnSortInfo[])">
|
|
<summary>
|
|
<para>Adds an array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> objects to the current collection.
|
|
</para>
|
|
</summary>
|
|
<param name="sortInfos">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> objects to add to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.BeginUpdate">
|
|
<summary>
|
|
<para>Locks the GridColumnSortInfoCollection by preventing change notifications from being fired, preventing visual updates until the <b>EndUpdate</b> method is called.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.ClearAndAddRange(DevExpress.XtraGrid.Columns.GridColumnSortInfo[],System.Int32)">
|
|
<summary>
|
|
<para>Clears the collection, then adds the specified objects to it and sets how many columns are used to group data.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="sortInfos">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> objects to add to the collection.
|
|
|
|
</param>
|
|
<param name="groupCount">
|
|
An integer value specifying how many columns are used to group data.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.ClearAndAddRange(DevExpress.XtraGrid.Columns.GridColumnSortInfo[])">
|
|
<summary>
|
|
<para>Clears the collection and then adds the specified objects to it.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="sortInfos">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> objects to add to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.ClearSorting">
|
|
<summary>
|
|
<para>Removes the collection's items which refer to the columns used to sort data (grouping columns are not affected).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.EndUpdate">
|
|
<summary>
|
|
<para>Unlocks the GridColumnSortInfoCollection object after a call to the <b>BeginUpdate</b> method and causes an immediate visual update.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.GroupCount">
|
|
<summary>
|
|
<para>Gets or sets how many of the elements starting from the beginning of the collection refer to columns used to group data.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer specifying the number of grouping columns.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.IndexOf(DevExpress.XtraGrid.Columns.GridColumnSortInfo)">
|
|
<summary>
|
|
<para>Returns the index of the specified item in the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="columnInfo">
|
|
The <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object required.
|
|
|
|
</param>
|
|
<returns>An integer value representing the specified <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object's zero-based index. <b>-1</b> if the collection doesn't contain the specified object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Insert(System.Int32,DevExpress.XtraGrid.Columns.GridColumnSortInfo)">
|
|
<summary>
|
|
<para>Inserts the specified <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object at the specified position.
|
|
</para>
|
|
</summary>
|
|
<param name="position">
|
|
A zero-based index at which to insert the specified object.
|
|
|
|
</param>
|
|
<param name="columnInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object to insert in the collection.
|
|
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object added to the collection; <b>null</b> if the object cannot be added to the collection.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Insert(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Data.ColumnSortOrder)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object and inserts it at the specified position in the collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="position">
|
|
A zero-based index at which to insert the specified object.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> to initialize the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.Column"/> property of the newly created object.
|
|
|
|
|
|
</param>
|
|
<param name="sortOrder">
|
|
A <see cref="T:DevExpress.Data.ColumnSortOrder"/> value to initialize the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.SortOrder"/> property of the newly created object.
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object added to the collection; <b>null</b> if the object cannot be added to the collection.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to the elements in the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the zero-based index of the required <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object representing the item in the collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Item(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Gets the collection's item that refers to the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object identifying the collection's required item.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> object that refers to the specified column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Remove(DevExpress.XtraGrid.Columns.GridColumnSortInfo)">
|
|
<summary>
|
|
<para>Removes the specified element from the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="columnInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo"/> element to remove from the collection.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.Remove(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Removes the element from the collection that refers to the specified column.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object identifying the collection's required item.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection.View">
|
|
<summary>
|
|
<para>Gets the View which obtains its sorting and grouping settings from the current collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> object representing the View that owns the current collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.GridColumnSortInfo">
|
|
|
|
<summary>
|
|
<para>Represents an element in a <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection"/>.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnSortInfo.#ctor(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Data.ColumnSortOrder)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridColumnSortInfo class.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column which will be sorted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.Column"/> property.
|
|
|
|
</param>
|
|
<param name="sortOrder">
|
|
A <see cref="T:DevExpress.Data.ColumnSortOrder"/> value specifying the sorting settings for the column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.SortOrder"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.Column">
|
|
<summary>
|
|
<para>Gets or sets the column which is sorted by the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.SortOrder"/>.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column which is sorted using the sort order specified by the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.SortOrder"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.IsGrouped">
|
|
<summary>
|
|
<para>Indicates whether the column which is referred to by the current GridColumnSortInfo object is a grouping column.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.Column"/> is used to group data; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnSortInfo.SortOrder">
|
|
<summary>
|
|
<para>Gets or sets the column's sort order.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.ColumnSortOrder"/> enumeration value specifying the column's sort order.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.GridAnimationType">
|
|
|
|
<summary>
|
|
<para>Lists the values that identify cells within which animation is enabled.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridAnimationType.AnimateAllContent">
|
|
<summary>
|
|
<para>Animation is enabled within all visible cells of a View object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridAnimationType.AnimateFocusedItem">
|
|
<summary>
|
|
<para>Animation is enabled within a View's focused row/card.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridAnimationType.Default">
|
|
<summary>
|
|
<para>The same value as the <see cref="F:DevExpress.XtraGrid.Views.Base.GridAnimationType.AnimateAllContent"/> option.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.GridAnimationType.NeverAnimate">
|
|
<summary>
|
|
<para>Animation is disabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.PrintInitializeEventHandler">
|
|
|
|
<summary>
|
|
<para>A method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.BaseView.PrintInitialize"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.PrintInitializeEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs)">
|
|
<summary>
|
|
<para>A method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.BaseView.PrintInitialize"/> event.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs">
|
|
|
|
<summary>
|
|
<para>Contains data for the <see cref="E:DevExpress.XtraGrid.Views.Base.BaseView.PrintInitialize"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs.#ctor(DevExpress.XtraPrinting.IPrintingSystem,DevExpress.XtraPrintingLinks.PrintableComponentLinkBase)">
|
|
<summary>
|
|
<para>Initializes a new instance of the PrintInitializeEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="printingSystem">
|
|
An <see cref="T:DevExpress.XtraPrinting.IPrintingSystem"/> object assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs.PrintingSystem"/> object.
|
|
|
|
</param>
|
|
<param name="link">
|
|
A <see cref="T:DevExpress.XtraPrintingLinks.PrintableComponentLinkBase"/> object assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs.Link"/> object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs.Link">
|
|
<summary>
|
|
<para>Gets a <see cref="T:DevExpress.XtraPrintingLinks.PrintableComponentLinkBase"/> object that provides functionality to print the Grid Control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraPrintingLinks.PrintableComponentLinkBase"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.PrintInitializeEventArgs.PrintingSystem">
|
|
<summary>
|
|
<para>Gets a <see cref="T:DevExpress.XtraPrinting.IPrintingSystem"/> object that contains information on the print document.
|
|
</para>
|
|
</summary>
|
|
<value>An object implementing the <see cref="T:DevExpress.XtraPrinting.IPrintingSystem"/> interface.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridViewOptionsFind">
|
|
|
|
<summary>
|
|
<para> Contains options controlling the view and behavior settings of the Find Panel.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridViewOptionsFind.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridViewOptionsFind class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridViewOptionsFind.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all the settings of the options object passed as this method's parameter to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridViewOptionsFind.SearchInPreview">
|
|
<summary>
|
|
<para>Gets or sets whether a search should also be performed against Preview Sections.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a search should also be performed against Preview Sections; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferences">
|
|
|
|
<summary>
|
|
<para>Summarizes differences for a specific card field (layout item) as compared to the card field's default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferences.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutItemDifferences class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferences.IsEqual(DevExpress.XtraGrid.Views.Layout.LayoutItemDifferences)">
|
|
<summary>
|
|
<para>Returns whether the current and specified objects contain identical <i>difference</i> records.
|
|
</para>
|
|
</summary>
|
|
<param name="differences">
|
|
A LayoutItemDifferences object to be compared with the current object.
|
|
|
|
</param>
|
|
<returns><b>true</b> if current and specified objects contain identical <i>difference</i> records; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferences.Item(DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType)">
|
|
<summary>
|
|
<para>Gets or sets a value for a specific item(card field) setting.
|
|
</para>
|
|
</summary>
|
|
<param name="type">
|
|
Identifies the item setting whose value is set or retrieved.
|
|
|
|
</param>
|
|
<value>A value for an item setting. For infromation on values for specific item settings, see the <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType"/> topic.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferences.Pairs">
|
|
<summary>
|
|
<para>Contains <i>difference</i> records for a specific layout item (card field), identifying how the item's settings differ from the default settings.
|
|
</para>
|
|
</summary>
|
|
<value>A Dictionary@lt;<see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType"/>, Object@gt; object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.SortFilterButtonShowMode">
|
|
|
|
<summary>
|
|
<para>Contains values that specify the region where a field's sort and filter buttons are displayed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.SortFilterButtonShowMode.Default">
|
|
<summary>
|
|
<para>The same option as the <see cref="F:DevExpress.XtraGrid.Views.Layout.SortFilterButtonShowMode.InFieldValue"/> option.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.SortFilterButtonShowMode.InFieldCaption">
|
|
<summary>
|
|
<para>Sort and filter buttons are displayed in a field caption region.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.SortFilterButtonShowMode.InFieldValue">
|
|
<summary>
|
|
<para>Sort and filter buttons are displayed in a field value region.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.SortFilterButtonShowMode.Nowhere">
|
|
<summary>
|
|
<para>The buttons are hidden.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupCheckedListBox"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraEditors.Repository.RepositoryItemCheckedComboBoxEdit)">
|
|
<summary>
|
|
<para>Initializes a new instance of the FilterPopupCheckedListBoxEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that refers to the current column displaying the check filter drop-down list. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="comboBox">
|
|
A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemCheckedComboBoxEdit"/> object that contains settings of the check filter drop-down list. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs.CheckedComboBox"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs.CheckedComboBox">
|
|
<summary>
|
|
<para>Gets an object that contains settings of the checked filter dropdown list.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemCheckedComboBoxEdit"/> object that contains settings of the checked filter drop-down list.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column displaying the check filter drop-down list.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object displaying the check filter drop-down list.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences">
|
|
|
|
<summary>
|
|
<para>Summarizes differences for a card's layout, as compared to the default card layout.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutViewCard)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewCardDifferences class.
|
|
</para>
|
|
</summary>
|
|
<param name="card">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutViewCard"/> object whose differences from the default card are collected by the created object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewCardDifferences class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.AddItemDifference(System.String,DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType,System.Object)">
|
|
<summary>
|
|
<para>Adds a <i>difference</i> record, identifying how a layout item's (card field's) settings differ from the default settings.
|
|
</para>
|
|
</summary>
|
|
<param name="itemName">
|
|
A string that identifies the layout item (card field).
|
|
|
|
</param>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType"/> value that specifies the setting to be changed
|
|
|
|
</param>
|
|
<param name="value">
|
|
A new value for the setting.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.ClearDifferences">
|
|
<summary>
|
|
<para>Clear all <i>difference</i> records in the current LayoutViewCardDifferences object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.Differences">
|
|
<summary>
|
|
<para>Contains <i>difference</i> records for a card, identifying how the card field settings differ from the default settings.
|
|
</para>
|
|
</summary>
|
|
<value>A Dictionary@lt;String, LayoutItemDifferences@gt; object that contains <i>difference</i> records for all card fields.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.HasDifferences">
|
|
<summary>
|
|
<para>Gets whether the LayoutViewCardDifferences object has any <i>difference</i> records.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if there are no <i>difference</i> records; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.IsEqual(DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences)">
|
|
<summary>
|
|
<para>Returns whether settings of the current and specified objects are equal.
|
|
</para>
|
|
</summary>
|
|
<param name="d">
|
|
A LayoutViewCardDifferences object whose settings must be compared with the current object.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the settings of the current and specified objects are equal; otherwise, <b>false</b>.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.Item(System.String)">
|
|
<summary>
|
|
<para>Provides access to <i>difference</i> records for a specific layout item (card field).
|
|
</para>
|
|
</summary>
|
|
<param name="name">
|
|
A string that identifies the layout item (card field).
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferences"/> object that summarizes all <i>difference</i> records for a specific layout item (card field).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.RemoveItemDifference(System.String,DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType)">
|
|
<summary>
|
|
<para>Removes the <i>difference</i> record of the specified type for the specified layout item (card field).
|
|
</para>
|
|
</summary>
|
|
<param name="itemName">
|
|
A string that identifies the layout item (card field).
|
|
|
|
</param>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType"/> value that represents the modified setting to be removed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewCardDifferences.RemoveItemDifferences(System.String)">
|
|
<summary>
|
|
<para>Removes all the <i>difference</i> records for the specified layout item (card field).
|
|
</para>
|
|
</summary>
|
|
<param name="itemName">
|
|
A string that identifies the layout item (card field).
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType">
|
|
|
|
<summary>
|
|
<para>Identifies card field settings that can be modified via the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardLayout"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType.GroupExpanded">
|
|
<summary>
|
|
<para>Identifies the group expansion state. A value for this setting must be of the Boolean type, where <b>true</b> indicates that the group is expanded and <b>false</b> indicates the group is collapsed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType.ItemVisibility">
|
|
<summary>
|
|
<para>Identifies the item's visibility. A value for this setting must be of the Boolean type, where <b>true</b> indicates that the item is visible and <b>false</b> indicates that the item is hidden.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutItemDifferenceType.SelectedTabIndex">
|
|
<summary>
|
|
<para>Identifies the selected page index. The value for this setting must be of the Integer type. <b>0</b> corresponds to the first tab, <b>1</b> corresponds to the second tab, etc.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Printing.CancelPrintRowEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.BeforePrintRow"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Printing.CancelPrintRowEventArgs.#ctor(DevExpress.XtraPrinting.IPrintingSystem,System.Drawing.Graphics,DevExpress.XtraPrinting.IBrickGraphics,System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CancelPrintRowEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="ips">
|
|
The PrintingSystem object that provides methods to create bricks in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.PS"/> property.
|
|
|
|
</param>
|
|
<param name="g">
|
|
A Graphics object that represents the grid control's drawing surface.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Graphics"/> property.
|
|
|
|
</param>
|
|
<param name="graph">
|
|
A <see cref="T:DevExpress.XtraPrinting.BrickGraphics"/> object that implements report drawing functions.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.BrickGraphics"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
The handle of the row that has just been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="level">
|
|
The group level of the row that has been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Level"/> property.
|
|
|
|
</param>
|
|
<param name="x">
|
|
The X coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.X"/> property.
|
|
|
|
</param>
|
|
<param name="y">
|
|
The Y coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Y"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Printing.CancelPrintRowEventArgs.#ctor(DevExpress.XtraPrinting.IPrintingSystem,System.Drawing.Graphics,DevExpress.XtraPrinting.IBrickGraphics,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CancelPrintRowEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="ips">
|
|
The PrintingSystem object that provides methods to create bricks in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.PS"/> property.
|
|
|
|
</param>
|
|
<param name="g">
|
|
A Graphics object that represents the grid control's drawing surface.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Graphics"/> property.
|
|
|
|
</param>
|
|
<param name="graph">
|
|
A <see cref="T:DevExpress.XtraPrinting.BrickGraphics"/> object that implements report drawing functions.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.BrickGraphics"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
The handle of the row that has just been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="level">
|
|
The group level of the row that has been printed.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Level"/> property.
|
|
|
|
</param>
|
|
<param name="x">
|
|
The X coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.X"/> property.
|
|
|
|
</param>
|
|
<param name="y">
|
|
The Y coordinate, in pixels, where the next row will be drawn in the printout/export output.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.Y"/> property.
|
|
|
|
</param>
|
|
<param name="hasRowFooter">
|
|
Specifies whether the row contains a footer.
|
|
This value is used to initialize the <see cref="P:DevExpress.XtraGrid.Views.Printing.PrintRowEventArgs.HasFooter"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Printing.CancelPrintRowEventArgs.Cancel">
|
|
<summary>
|
|
<para>Gets or sets whether the current row must not be printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current row must not be printed/exported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupDate"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupDate"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupDate"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,System.Collections.Generic.List`1)">
|
|
<summary>
|
|
<para>Initializes a new instance of the FilterPopupDateEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object whose filter dropdown is to be displayed. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="list">
|
|
A list of filter items. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs.List"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column whose filter dropdown is about to be displayed on-screen.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object whose filter dropdown is about to be displayed on-screen.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FilterPopupDateEventArgs.List">
|
|
<summary>
|
|
<para>Gets the list of filter items represented as check boxes within the filter dropdown window.
|
|
</para>
|
|
</summary>
|
|
<value>A list of filter items.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraEditors.PopupFilterMode">
|
|
|
|
<summary>
|
|
<para>Contains values that specify how records are filtered within a grid lookup editor's popup window.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.PopupFilterMode.Contains">
|
|
<summary>
|
|
<para>Selects records that contain the specified sub-string.
|
|
|
|
<para>
|
|
A search for rows is performed against the column specified by the editor's <b>Properties.DisplayMember</b> property (<see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/>).
|
|
</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.PopupFilterMode.Default">
|
|
<summary>
|
|
<para>For the <see cref="T:DevExpress.XtraEditors.GridLookUpEdit"/> control, this option is equivalent to the Contains option, except in the following cases, where it's equivalent to the StartsWith mode:
|
|
- text editing is disabled (<see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.TextEditStyle"/> is not set to <b>Standard</b>)
|
|
- text editing is enabled and the auto complete feature is active (<see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemGridLookUpEdit.AutoComplete"/>)
|
|
|
|
<para>
|
|
For <see cref="T:DevExpress.XtraEditors.SearchLookUpEdit"/>, this option is equivalent to the Contains option. A search is performed using the search functionality provided by the Find Panel.
|
|
By default, all columns are searched through. If required, you can limit the search columns via the editor's <b>Properties.View.OptionsFind.FindFilterColumns</b> property (<see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind.FindFilterColumns"/>).
|
|
</para>
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraEditors.PopupFilterMode.StartsWith">
|
|
<summary>
|
|
<para>Selects records whose field values start with the specified string.
|
|
|
|
<para>
|
|
A search for rows is performed against the column specified by the editor's <b>Properties.DisplayMember</b> property (<see cref="P:DevExpress.XtraEditors.Repository.RepositoryItemLookUpEditBase.DisplayMember"/>).
|
|
</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowClickEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowClick"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowClickEventArgs.#ctor(DevExpress.Utils.DXMouseEventArgs,System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the RowClickEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.Utils.DXMouseEventArgs"/> object that contains information on the clicked point.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the clicked row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowClickEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowClickEventArgs.HitInfo">
|
|
<summary>
|
|
<para>Gets an object that identifies the clicked element.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object that identifies the clicked element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowClickEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the clicked row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the handle of the clicked row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupCheckedListBox"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupCheckedListBox"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.FilterPopupCheckedListBoxEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowCellClickEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellClick"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowCellClickEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.RowCellClickEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellClick"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.RowCellClickEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowCellClickEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellClick"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowCellClickEventArgs.#ctor(DevExpress.Utils.DXMouseEventArgs,System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Initializes a new instance of the RowCellClickEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.Utils.DXMouseEventArgs"/> object that contains information on the clicked point.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the clicked row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowClickEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that identifies the clicked grid column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowCellClickEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowCellClickEventArgs.CellValue">
|
|
<summary>
|
|
<para>Gets the edit value of the clicked cell.
|
|
</para>
|
|
</summary>
|
|
<value>An object that specifies the edit value of the clicked cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowCellClickEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column that contains the clicked cell.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that specifies the column containing the clicked cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.FilterPopupMode">
|
|
|
|
<summary>
|
|
<para>Contains values that specify the filter dropdown style for grid columns.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FilterPopupMode.CheckedList">
|
|
<summary>
|
|
<para>The filter dropdown is represented as a checked list of filter items. In this mode, an end-user can select more than one item simultaneously. When the dropdown window is closed by clicking the OK button, the View will display those records that contain the checked values:
|
|
|
|
<para>
|
|
|
|
</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FilterPopupMode.Date">
|
|
<summary>
|
|
<para>This mode is in effect for columns displaying date-time values. The filter dropdown contains a calendar, plus check boxes that allow used date intervals to be selected:
|
|
|
|
<para>
|
|
|
|
</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FilterPopupMode.DateAlt">
|
|
<summary>
|
|
<para>This mode is equivalent to DateSmart, but with a different number of filters: Today, This week, This month, Next month, etc.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FilterPopupMode.DateSmart">
|
|
<summary>
|
|
<para>This mode is in effect for columns displaying date-time values. It consists of a calendar, like the Date mode, plus check boxes that allow used date intervals to be selected.
|
|
If there is no underlying data that would fall into a specific date range, the corresponding check box is hidden.
|
|
<para>
|
|
If the data source is empty or if all values in the date-time column are set to <b>null</b>, all check boxes are visible.
|
|
</para>
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FilterPopupMode.Default">
|
|
<summary>
|
|
<para>For columns displaying date-time values, this option is equivalent to the <b>DateSmart</b> option. For other columns, this option is equivalent to the <b>List</b> option.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FilterPopupMode.List">
|
|
<summary>
|
|
<para>The filter dropdown is represented as a regular list of filter items. Clicking an item invokes a corresponding action, and automatically closes the dropdown.
|
|
|
|
<para>
|
|
|
|
</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ViewPrintOptionsBase">
|
|
|
|
<summary>
|
|
<para>Base print and export options for a view.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewPrintOptionsBase.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ViewPrintOptionsBase class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewPrintOptionsBase.AllowCancelPrintExport">
|
|
<summary>
|
|
<para>Gets or sets whether the print/export progress window contains a Cancel button, which allows an end-user to cancel the current print/export operation.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the print/export progress window contains a Cancel button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewPrintOptionsBase.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies settings from the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> object whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewPrintOptionsBase.AutoResetPrintDocument">
|
|
<summary>
|
|
<para>Gets or sets whether a print/export document is automatically cleared and then generated each time it is sent to the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a print/export document is automatically cleared and regenerated before it is sent to the print/export output; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewPrintOptionsBase.ShowPrintExportProgress">
|
|
<summary>
|
|
<para>Gets or sets whether a separate window is used to indicate print/export progress.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a separate window is used to indicate print/export progress; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.OptionsField">
|
|
|
|
<summary>
|
|
<para>Provides access to options that control the display of a field's sort and filter buttons.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.OptionsField.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the OptionsField class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.OptionsField.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.OptionsField.SortFilterButtonLocation">
|
|
<summary>
|
|
<para>Gets or sets the location of sort and filter buttons within the region where these buttons are displayed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.SortFilterButtonLocation"/> value that specifies the location of sort and filter buttons.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.OptionsField.SortFilterButtonShowMode">
|
|
<summary>
|
|
<para>Gets or sets the region where sort and filter buttons are displayed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.SortFilterButtonShowMode"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsPrint">
|
|
|
|
<summary>
|
|
<para>Provides print/export options for Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsPrint.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsPrint"/> object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsPrint.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsPrint.PrintBandHeader">
|
|
<summary>
|
|
<para>Gets or sets whether band headers are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if band headers are printed/exported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo">
|
|
|
|
<summary>
|
|
<para>Serves as the base for classes providing information about a particular View point.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/> object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo.Clear">
|
|
<summary>
|
|
<para>Sets all public properties to their default values.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo.HitPoint">
|
|
<summary>
|
|
<para>Gets or sets the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Point"/> structure representing the test point. The point coordinates are set relative to the grid's top-left corner.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo.IsValid">
|
|
<summary>
|
|
<para>Gets a value indicating whether the hit information supplied by this object is valid.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the hit information is valid; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo.MasterTabRelationIndex">
|
|
<summary>
|
|
<para>Gets or sets the relation index of the master tab that is located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the relation index of the master tab that is located under the test point. <b>-1</b> if the test point doesn't belong to a master tab.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridSummaryItemCollection">
|
|
|
|
<summary>
|
|
<para>Represents a total summary item collection.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridSummaryItemCollection class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItemCollection.ActiveCount">
|
|
<summary>
|
|
<para>Gets the number of summary items participating in summary calculations.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value indicating the number of summary items whose <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property is not set to <see cref="F:DevExpress.Data.SummaryItemType.None"/>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.Add(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Adds the specified summary item to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object (or descendant) to be added to the collection.
|
|
|
|
</param>
|
|
<returns>A zero-based integer representing the new summary item's position within the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.Add">
|
|
<summary>
|
|
<para>Creates a new total summary item and adds it to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object representing the new summary item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.AddRange(DevExpress.XtraGrid.GridSummaryItem[])">
|
|
<summary>
|
|
<para>Adds an array of summary item objects to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="items">
|
|
An array of <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> objects to be added to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.Assign(DevExpress.XtraGrid.GridSummaryItemCollection)">
|
|
<summary>
|
|
<para>Copies items from the collection specified as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="coll">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItemCollection"/> object whose items should be copied to the current collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.BeginUpdate">
|
|
<summary>
|
|
<para>Locks the GridSummaryItemCollection, preventing change notifications (and visual updates) from being raised by the object until the <b>EndUpdate</b> or <b>CancelUpdate</b> method is called.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.CancelUpdate">
|
|
<summary>
|
|
<para>Unlocks the GridSummaryItemCollection object after it has been locked by the <b>BeginUpdate</b> method, without causing an immediate visual update.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridSummaryItemCollection.CollectionChanged">
|
|
<summary>
|
|
<para>Fires when changes are made to the summary item collection.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.EndUpdate">
|
|
<summary>
|
|
<para>Unlocks the GridSummaryItemCollection object after a call to the <b>BeginUpdate</b> method and causes an immediate visual update.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.IndexOf(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Returns the item's position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns>A zero-based integer representing the specified item's position within the collection. <b>-1</b> if the collection doesn't contain the specified summary item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItemCollection.Item(System.Object)">
|
|
<summary>
|
|
<para>Gets a summary item specified by its tag.
|
|
</para>
|
|
</summary>
|
|
<param name="tag">
|
|
An object specifying the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Tag"/> property value of the required collection item.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object representing the summary item whose <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Tag"/> property matches the parameter value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItemCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual summary items.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the zero-based index of the required collection item. If negative or exceeds the last available index, an exception is raised.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object representing the summary item located at the specified index within the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItemCollection.Remove(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Removes the specified item from the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object representing the summary item to be removed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItemCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns the current summary item collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that owns the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ValidateRowEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ValidateRow"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ValidateRowEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.ValidateRowEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ValidateRow"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ValidateRowEventArgs"/> object that contain event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridGroupSummaryItemCollection">
|
|
|
|
<summary>
|
|
<para>Represents a group summary item collection.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItemCollection.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItemCollection"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant specifying the View that will own the summary item collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItemCollection.Add(DevExpress.Data.SummaryItemType,System.String,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Creates a new group summary item with predefined settings and adds it to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregation function type. This value initializes the new item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value specifying the name of a dataset field whose values are used for summary calculation. This value initializes the new item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="showInColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) specifying the column whose footer cells should display summary values. <b>null</b> (<b>Nothing</b> in Visual Basic) to display summary values within group rows. This value initializes the created item's <see cref="P:DevExpress.XtraGrid.GridGroupSummaryItem.ShowInGroupColumnFooter"/> property.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object representing the new summary item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItemCollection.Add">
|
|
<summary>
|
|
<para>Creates a new group summary item with default settings and adds it to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object representing the new summary item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItemCollection.Add(DevExpress.Data.SummaryItemType,System.String,DevExpress.XtraGrid.Columns.GridColumn,System.String)">
|
|
<summary>
|
|
<para>Creates a new group summary item with predefined settings and adds it to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregation function type. This value initializes the new item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value specifying the name of a dataset field whose values are used for summary calculation. This value initializes the created item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="showInColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) specifying the column whose footer cells should display summary values. <b>null</b> (<b>Nothing</b> in Visual Basic) to display summary values within group rows. This value initializes the created item's <see cref="P:DevExpress.XtraGrid.GridGroupSummaryItem.ShowInGroupColumnFooter"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A <see cref="T:System.String"/> value specifying summary values formatting. This value initializes the new item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object representing the new summary item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItemCollection.Add(DevExpress.Data.SummaryItemType,System.String,DevExpress.XtraGrid.Columns.GridColumn,System.String,System.IFormatProvider)">
|
|
<summary>
|
|
<para>Creates a new group summary item with the specified settings and adds it to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregation function type. This value initializes the new item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value specifying the name of a dataset field whose values are used for summary calculation. This value initializes the new item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="showInColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) specifying the column whose footer cells should display summary values. <b>null</b> (<b>Nothing</b> in Visual Basic) to display summary values within group rows. This value initializes the created item's <see cref="P:DevExpress.XtraGrid.GridGroupSummaryItem.ShowInGroupColumnFooter"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A <see cref="T:System.String"/> value specifying the summary value's format. This value initializes the new item's <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="formatProvider">
|
|
An IFormatProvider object that implements a formatting routine. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Format"/> property.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object representing the new summary item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItemCollection.Add(DevExpress.Data.SummaryItemType,System.String)">
|
|
<summary>
|
|
<para>Adds a new summary item to the current summary collection and initializes its summary type and field name.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that is the new item's summary type. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value that is the field's name used to calculate the summary. This parameter is used to initialize the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object that is a new summary item added to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridGroupSummaryItemCollection.View">
|
|
<summary>
|
|
<para>Gets a View that owns the current GridGroupSummaryItemCollection object.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant that owns the current GridGroupSummaryItemCollection object.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridGroupSummaryItem">
|
|
|
|
<summary>
|
|
<para>Represents an individual group summary item.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItem.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItem.#ctor(DevExpress.Data.SummaryItemType,System.String,DevExpress.XtraGrid.Columns.GridColumn,System.String)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object with predefined summary settings.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregation function type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value specifying the name of a data filed whose values are used for summary calculation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="showInColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing a column whose group footer cells should display summary values. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridGroupSummaryItem.ShowInGroupColumnFooter"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value specifying summary values formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItem.#ctor(DevExpress.Data.SummaryItemType,System.String,DevExpress.XtraGrid.Columns.GridColumn,System.String,System.Object)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object with predefined summary settings and tag.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregation function type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value specifying the name of a data filed whose values are used for summary calculation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="showInColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing a column whose group footer cells should display summary values. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridGroupSummaryItem.ShowInGroupColumnFooter"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value specifying summary values formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An used to identify the group summary item. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Tag"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItem.Assign(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Copies settings of the specified group summary item object to the current one.
|
|
</para>
|
|
</summary>
|
|
<param name="source">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object whose settings should be copied to the current summary item.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridGroupSummaryItem.IsEquals(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Indicates whether the specified group summary item has the same settings as the current one.
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object to be compared to the current summary item.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified object's settings match the current object's settings; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridGroupSummaryItem.ShowInGroupColumnFooter">
|
|
<summary>
|
|
<para>Gets or sets the column whose group footer cells should display summary values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column whose group footer cells should display summary values. <b>null</b> (<b>Nothing</b> in Visual Basic) to display summary values within group rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridGroupSummaryItem.ShowInGroupColumnFooterName">
|
|
<summary>
|
|
<para>Gets or sets the name of the column whose group footer cells should display summary values.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the name of the column whose group footer cells display summary values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo">
|
|
|
|
<summary>
|
|
<para>Contains information about a specific point within a Banded Grid View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo"/> class instance.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo.Band">
|
|
<summary>
|
|
<para>Gets the band located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band located under the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo.Clear">
|
|
<summary>
|
|
<para>Sets the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo"/> class properties to their default values.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo.Column">
|
|
<summary>
|
|
<para>Gets or sets a column located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing a column that contains the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo.HitTest">
|
|
<summary>
|
|
<para>Gets or sets a value identifying the type of the View's visual element located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest"/> enumeration value identifying the visual element under the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo.InBandPanel">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within the band panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within the band panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest">
|
|
|
|
<summary>
|
|
<para>Lists values identifying a Banded Grid View's visual elements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.Band">
|
|
<summary>
|
|
<para>The test point belongs to a band header.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.BandButton">
|
|
<summary>
|
|
<para>The test point belongs to the band panel button.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.BandEdge">
|
|
<summary>
|
|
<para>The test point belongs to the right edge of a band header. End-users can drag these edges to resize bands horizontally (the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.AllowSize"/> option of the desired band must be enabled for this purpose).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.BandPanel">
|
|
<summary>
|
|
<para>The point belongs to the band header panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.CellButton">
|
|
<summary>
|
|
<para>The test point belongs to a master-detail expand button, which can be used to open/close details.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.Column">
|
|
<summary>
|
|
<para>The test point belongs to a column header.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.ColumnButton">
|
|
<summary>
|
|
<para>The test point belongs to the column header panel button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.ColumnEdge">
|
|
<summary>
|
|
<para>The test point belongs to the right edge of a column header. End-users can drag these edges to resize columns horizontally or double-click them to apply best fit to the column (the <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowSize"/> option of the desired column must be enabled for this purpose).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.ColumnFilterButton">
|
|
<summary>
|
|
<para>The test point belongs to a filter button, which can be used by end-users to invoke the flter dropdown. This enables end-users to apply filtering conditions to columns.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.ColumnPanel">
|
|
<summary>
|
|
<para>The test point belongs to the column header panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.CustomizationForm">
|
|
<summary>
|
|
<para>The test point belongs to the customization form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.EmptyRow">
|
|
<summary>
|
|
<para>The test point is below all rows or belongs to an empty space within a row. Empty spaces may appear in advanced banded Views as the result of columns layout customization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FilterCloseButton">
|
|
<summary>
|
|
<para>The test point belongs to the filter close button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FilterPanel">
|
|
<summary>
|
|
<para>The test point belongs to the filter panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FilterPanelActiveButton">
|
|
<summary>
|
|
<para>The test point belongs to the button in the filter panel used to activate filtering within a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FilterPanelCustomizeButton">
|
|
<summary>
|
|
<para>The test point belongs to the filter panel customize button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FilterPanelMRUButton">
|
|
<summary>
|
|
<para>The test point belongs to a button in the filter panel used to display a dropdown window with a list of the most recently used filter criteria.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FilterPanelText">
|
|
<summary>
|
|
<para>The test point belongs to a string in the filter panel which represents the filter criteria applied to a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FixedLeftDiv">
|
|
<summary>
|
|
<para>The test point belongs to the left fixed line.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.FixedRightDiv">
|
|
<summary>
|
|
<para>The test point belongs to the right fixed line.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.Footer">
|
|
<summary>
|
|
<para>The test point belongs to the view footer.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.GroupPanel">
|
|
<summary>
|
|
<para>The test point belongs to the group panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.GroupPanelColumn">
|
|
<summary>
|
|
<para>The test point belongs to a column header displayed within the group panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.GroupPanelColumnFilterButton">
|
|
<summary>
|
|
<para>The test point belongs to the filter button of the column header that resides within the group panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.HScrollBar">
|
|
<summary>
|
|
<para>The test point belongs to the View's horizontal scroll bar.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.MasterTabPageHeader">
|
|
<summary>
|
|
<para>The test point belongs to the View's master-detail tab.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.None">
|
|
<summary>
|
|
<para>The test point does not belong to any View's visual element or is outside the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.Row">
|
|
<summary>
|
|
<para>The test point belongs to a group row, group row indent or a cell edge.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowCell">
|
|
<summary>
|
|
<para>The test point belongs to a row cell.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowDetail">
|
|
<summary>
|
|
<para>The test point belongs to a detail section.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowDetailEdge">
|
|
<summary>
|
|
<para>The test point belongs to the detail section's bottom edge. The edge can be dragged to resize the detail section vertically.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowDetailIndicator">
|
|
<summary>
|
|
<para>The test point belongs to an indicator panel cell corresponding to a detail section.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowEdge">
|
|
<summary>
|
|
<para>The test point belongs to the bottom edge of a data row. The edge can be dragged to resize the row vertically (if the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowRowSizing"/> option is active).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowFooter">
|
|
<summary>
|
|
<para>The test point belongs to a group footer.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowGroupButton">
|
|
<summary>
|
|
<para>The test point belongs to a group expand button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowIndicator">
|
|
<summary>
|
|
<para>The test point belongs to an indicator panel cell corresponding to a data row or group row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.RowPreview">
|
|
<summary>
|
|
<para>The test point belongs to a preview section.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.ViewCaption">
|
|
<summary>
|
|
<para>The test point belongs to the View Caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitTest.VScrollBar">
|
|
<summary>
|
|
<para>The test point belongs to the View's vertical scroll bar.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsNavigation">
|
|
|
|
<summary>
|
|
<para>Provides navigation options for Advanced Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsNavigation.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsNavigation"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsNavigation.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsNavigation.UseAdvHorzNavigation">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether advanced horizontal navigation is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the advanced horizontal navigation is enabled within a view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsNavigation.UseAdvVertNavigation">
|
|
<summary>
|
|
<para>Gets or sets whether advanced vertical navigation is enabled within a View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if advanced vertical navigation is enabled within a view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection">
|
|
|
|
<summary>
|
|
<para>Represents a read-only column collection.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant representing the View that will own the new column collection. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection.View"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection.Contains(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether the collection contains the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the collection contains the specified column; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection.IndexOf(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the specified column's position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns>A zero-based integer value representing the specified column's position within the collection. <b>-1</b> if the collection doesn't contain the specified column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual columns.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the column's zero-based index within the collection.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column located at the specified position within the collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if the specified index is negative or exceeds the last available index.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns the current column collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant representing the View that owns the column collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.GridColumnCollection">
|
|
|
|
<summary>
|
|
<para>Represents a column collection in Grid Views and Card Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Columns.GridColumnCollection"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant representing the View that will own the new column collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.Add">
|
|
<summary>
|
|
<para>Creates a new hidden column and adds it to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the new column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.Add(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Adds the specified column to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
The column to add to the collection.
|
|
|
|
</param>
|
|
<returns>An integer value that specifies the position of the column within the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.AddField(System.String)">
|
|
<summary>
|
|
<para>Creates a new hidden column which is bound to the specified field, and appends it to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value that specifies the name of the data field to which to bind the created column.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which represents the new column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.AddRange(DevExpress.XtraGrid.Columns.GridColumn[])">
|
|
<summary>
|
|
<para>Adds an array of columns to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="columns">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> objects.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.AddVisible(System.String)">
|
|
<summary>
|
|
<para>Adds a new column, binding it to the specified field and making this column visible.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string that specifies the name of the field to which to bind the created column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.FieldName"/> property.
|
|
|
|
</param>
|
|
<returns>The created <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.AddVisible(System.String,System.String)">
|
|
<summary>
|
|
<para>Adds a new column, binds it to the specified field, assigns the specified caption and makes this column visible.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string that specifies the name of the field to which to bind the created column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="caption">
|
|
A string that specifies the column's display caption. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.Caption"/> property.
|
|
|
|
</param>
|
|
<returns>The created <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.ColumnByFieldName(System.String)">
|
|
<summary>
|
|
<para>Returns a column specified by its bound field name.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string value representing the column's bound field name.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column bound to the specified field. <b>null</b> (<b>Nothing</b> in Visual Basic) if the collection has no columns bound to the field.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.ColumnByName(System.String)">
|
|
<summary>
|
|
<para>Returns a column specified by its name.
|
|
</para>
|
|
</summary>
|
|
<param name="columnName">
|
|
A string value specifying the column's name.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if the collection doesn't contain the column with the specified name.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.Contains(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether the collection contains the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the collection contains the specified column; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.IndexOf(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the specified column's position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns>A zero-based integer representing the column's position within the collection. <b>-1</b> if the column doesn't belong to the collection.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.Insert(System.Int32)">
|
|
<summary>
|
|
<para>Creates a new column and adds it to the specified position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
A zero-based integer specifying the new column's position within the collection. If negative, the column is inserted as the first element. If it exceeds the last available index, the column is appended to the collection.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column inserted.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.Insert(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Inserts the specified column at the specified position.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
A zero-based integer specifying the column's position within the collection. If the specified index is negative or greater than or equal to the number of columns in the collection, an exception will be thrown.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object to be added to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual columns.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
A zero-based integer specifying the desired column's position within the collection. If negative or exceeds the last available index, an exception is raised.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column at the specified position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnCollection.Item(System.String)">
|
|
<summary>
|
|
<para>Gets the column specified by the bound field name.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string value specifying the column's bound field name.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column bound to the specified field. <b>null</b> (<b>Nothing</b> in Visual Basic) if the collection doesn't contain columns bound to the specified field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumnCollection.Remove(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Removes the specified column from the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column to be removed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumnCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns the collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant representing the View that owns the column collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.FixedStyle">
|
|
|
|
<summary>
|
|
<para>Contains values specifying the band or column behavior when the View is scrolled.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FixedStyle.Left">
|
|
<summary>
|
|
<para>The band or column is anchored to the View's left edge.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FixedStyle.None">
|
|
<summary>
|
|
<para>The band or column takes part in horizontal scrolling.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.FixedStyle.Right">
|
|
<summary>
|
|
<para>The band or column is anchored to the View's right edge.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawFooterCell"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowFooterCell"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawFooterCell"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowFooterCell"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawFooterCell"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowFooterCell"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Utils.Drawing.ObjectPainter,DevExpress.Utils.Drawing.StyleObjectInfoArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value identifying the painted element's row by its handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column containing the painted footer cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowCellObjectCustomDrawEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
An <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> object that provides default painting facilities. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.Utils.Drawing.StyleObjectInfoArgs"/> object that contains the View information about the element being painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs.Info"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs.Info">
|
|
<summary>
|
|
<para>Gets an object providing information necessary to paint a footer cell.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Drawing.GridFooterCellInfoArgs"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardCaption"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardCaption"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the <see cref="T:DevExpress.XtraGrid.Views.Card.CardView"/> object that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs"/> object that contains the event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardCaption"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,System.Drawing.Rectangle,DevExpress.Utils.AppearanceObject,System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="bounds">
|
|
A <see cref="T:System.Drawing.Rectangle"/> structure that specifies the boundaries of the painted element. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Bounds"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint a card caption. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value identifying the card whose caption is painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,DevExpress.XtraGrid.Views.Card.ViewInfo.CardInfo,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CardCaptionCustomDrawEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="cardInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardInfo"/> object which contains the information required to paint a card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs.CardInfo"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint a card caption. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs.CardCaption">
|
|
<summary>
|
|
<para>Gets or sets the current card's caption.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies the card's caption.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs.CardInfo">
|
|
<summary>
|
|
<para>Gets an object that stores the information needed to paint a card.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardInfo"/> object that provides the information required to paint a card.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardCaptionCustomDrawEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the row handle identifying the card whose caption is painted.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the row handle that identifies the painted card.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ViewBaseOptions">
|
|
|
|
<summary>
|
|
<para>Serves as the base for classes that provide options to grid control's Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ViewBaseOptions.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.ViewBaseOptions"/> object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawFooter"/>, <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowFooter"/>, <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawGroupRow"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowPreview"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawFooter"/>, <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowFooter"/>, <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawGroupRow"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowPreview"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> object that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs"/> object that contains the event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for custom painting events that need to provide row identification facilities.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,System.Int32,DevExpress.Utils.Drawing.ObjectPainter,DevExpress.Utils.Drawing.ObjectInfoArgs,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value identifying the painted element's row by its handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
An <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> object that provides default painting facilities. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.Utils.Drawing.StyleObjectInfoArgs"/> object that contains the View information about the element being painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Info"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that specifies the painted element's appearance settings. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row whose corresponding element is being painted.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the row handle.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowCellObjectCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Serves as the base for the <see cref="T:DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowCellObjectCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Utils.Drawing.ObjectPainter,DevExpress.Utils.Drawing.ObjectInfoArgs,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.RowCellObjectCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value identifying the painted element's row by its handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or a descendant) that represents the column corresponding to the painted element. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowCellObjectCustomDrawEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
An <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> object that provides default painting facilities. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.Utils.Drawing.StyleObjectInfoArgs"/> object that contains the View information about the element being painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Info"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that specifies the painted element's appearance settings. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowCellObjectCustomDrawEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column containing the painted element.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column that contains the painted element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.DragObjectStartEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectStart"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.DragObjectStartEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectStart"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectStart"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs.#ctor(System.Object)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="dragObject">
|
|
An object representing the band or column whose header is about to be dragged. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs.DragObject"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs.Allow">
|
|
<summary>
|
|
<para>Gets or sets whether the drag and drop operation can be started.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the end-user can start drag and drop; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.DragObjectStartEventArgs.DragObject">
|
|
<summary>
|
|
<para>Gets the column or band whose header is about to be dragged.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the column or band whose header is about to be dragged.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.DragObjectOverEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectOver"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.DragObjectOverEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectOver"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectOver"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs.#ctor(System.Object,DevExpress.XtraGrid.Dragging.PositionInfo)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="dragObject">
|
|
An object representing the band or column whose header is being dragged. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs.DragObject"/> property.
|
|
|
|
</param>
|
|
<param name="dropInfo">
|
|
An object providing information on the header's current position. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs.DropInfo"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs.DragObject">
|
|
<summary>
|
|
<para>Gets the column or band whose header is being dragged.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the column or band whose header has been dropped.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.DragObjectOverEventArgs.DropInfo">
|
|
<summary>
|
|
<para>Gets an object containing information about the dragged header's current position.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Dragging.PositionInfo"/> descendant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.DragObjectDropEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectDrop"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.DragObjectDropEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectDrop"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectDrop"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs.#ctor(System.Object,DevExpress.XtraGrid.Dragging.PositionInfo)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="dragObject">
|
|
An object representing the column or band whose header has been dropped. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs.DragObject"/> property.
|
|
|
|
</param>
|
|
<param name="dropInfo">
|
|
An object specifying the dropping position. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs.DropInfo"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs.Canceled">
|
|
<summary>
|
|
<para>Gets whether the dragged header has been dropped successfully.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the drag and drop operation was cancelled; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs.DragObject">
|
|
<summary>
|
|
<para>Gets the column or band whose header has been dropped.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the column or band whose header has been dropped.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.DragObjectDropEventArgs.DropInfo">
|
|
<summary>
|
|
<para>Gets an object providing information about drop position.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Dragging.PositionInfo"/> descendant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawFilterPanel"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawFilterPanel"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. This parameter identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawFilterPanel"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,DevExpress.Utils.Drawing.ObjectPainter,DevExpress.Utils.Drawing.ObjectInfoArgs,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
An <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> object that provides facilities for painting an element using the default mechanism. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.Utils.Drawing.ObjectInfoArgs"/> object that contains information about the element being painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Info"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
A <see cref="T:DevExpress.Utils.AppearanceObject"/> object that specifies the painted element's appearance settings. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Info">
|
|
<summary>
|
|
<para>Gets an object containing information about the painted element.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.Drawing.ObjectInfoArgs"/> object providing information about the painted element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter">
|
|
<summary>
|
|
<para>Gets the painter object that provides the default element painting mechanism.
|
|
</para>
|
|
</summary>
|
|
<value>An <b>ObjectPainter</b> descendant providing the default painting mechanism for the painted element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.StyleFormatConditionCollection">
|
|
|
|
<summary>
|
|
<para>Represents a collection of style conditions applied to a View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatConditionCollection.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.StyleFormatConditionCollection"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant that will own the new collection. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatConditionCollection.View"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatConditionCollection.Add(DevExpress.XtraGrid.StyleFormatCondition)">
|
|
<summary>
|
|
<para>Adds a style condition object to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="condition">
|
|
A <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> object to be added to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatConditionCollection.AddRange(DevExpress.XtraGrid.StyleFormatCondition[])">
|
|
<summary>
|
|
<para>Adds an array of style condition objects.
|
|
</para>
|
|
</summary>
|
|
<param name="conditions">
|
|
An array of <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> objects to be added to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatConditionCollection.CompareValues(System.Object,System.Object)">
|
|
<summary>
|
|
<para>Compares the two specified values.
|
|
</para>
|
|
</summary>
|
|
<param name="val1">
|
|
The first value to compare.
|
|
|
|
</param>
|
|
<param name="val2">
|
|
The second value to compare.
|
|
|
|
</param>
|
|
<returns><b>0</b> if the values are equal; <b>-1</b> if the first value is less than the second value; <b>1</b> if the first value is greater than the second value.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatConditionCollection.GetStyleFormatByValue(DevExpress.XtraGrid.Columns.GridColumn,System.Object,System.Int32)">
|
|
<summary>
|
|
<para>Returns a style condition that matches the specified criteria.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that specifies a grid column.
|
|
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.Object"/> that is the column's value.
|
|
|
|
|
|
</param>
|
|
<param name="listSourceRow">
|
|
The index of the row in the data source whose value is to be tested.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> object that matches the specified criteria.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.StyleFormatConditionCollection.IsLoading">
|
|
<summary>
|
|
<para>Gets a value which specifies whether the View that owns the current collection is being initialized.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View that owns the current collection is being initialized; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.StyleFormatConditionCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual items within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the required item's zero-based index within the collection. If negative or exceeds the last available index, an exception is raised.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> object residing at the specified position within the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.StyleFormatConditionCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns the collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that owns the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridControlViewCollection">
|
|
|
|
<summary>
|
|
<para>Represents a collection that contains Views currently displayed by a grid control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControlViewCollection.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridControlViewCollection"/> object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControlViewCollection.Contains(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Indicates whether the collection contains the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant object to search for.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the collection contains the specified view; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControlViewCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual Views.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value representing the View's zero-based index within the collection.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View located at the specified position within the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsView">
|
|
|
|
<summary>
|
|
<para>Provides appearance options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsView.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.AllowCellMerge">
|
|
<summary>
|
|
<para>Gets or sets whether neighboring cells with identical values can merge.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to allow neighboring cells with identical values to merge; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.AllowHtmlDrawGroups">
|
|
<summary>
|
|
<para>Gets or sets whether HTML tags can be used to format text in group rows.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if HTML tags can be used to format text in group rows; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.AllowHtmlDrawHeaders">
|
|
<summary>
|
|
<para>Gets or sets whether HTML formatting can be applied to column and band captions.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if HTML formatting can be applied to column and band captions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsView.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.AutoCalcPreviewLineCount">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the number of text lines within preview sections is calculated automatically depending on their contents.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to enable automatic calculation of preview sections' height; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ColumnAutoWidth">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether column widths are automatically modified so that the total columns' width matches the View's width.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to enable the column auto width feature; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.EnableAppearanceEvenRow">
|
|
<summary>
|
|
<para>Gets or sets whether the even rows are painted using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.EvenRow"/> property.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to paint the even rows using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.EvenRow"/> property; <b>false</b> to use the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.Row"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.EnableAppearanceOddRow">
|
|
<summary>
|
|
<para>Gets or sets whether the odd rows are painted using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.OddRow"/> property.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to paint the odd rows using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.OddRow"/> property; <b>false</b> to use the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewAppearances.Row"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.GroupDrawMode">
|
|
<summary>
|
|
<para>Gets or sets a value specifying how group rows should be painted.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GroupDrawMode"/> enumeration value specifying how group rows are to be painted.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.HeaderFilterButtonShowMode">
|
|
<summary>
|
|
<para>Gets or sets the display style of column filter buttons.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Controls.FilterButtonShowMode"/> enumeration value which specifies the display style of column filter buttons.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.NewItemRowPosition">
|
|
<summary>
|
|
<para>Gets or sets the new item row's position within the View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.NewItemRowPosition"/> enumeration value specifying the new item row's position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.RowAutoHeight">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the height of each data row is automatically adjusted to completely display the contents of its cells.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to enable automatic data row height calculation; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowAutoFilterRow">
|
|
<summary>
|
|
<para>Gets or sets whether the auto filter row is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the auto filter row; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowChildrenInGroupPanel">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the View's group panel acts as a joined group panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View's group panel can accept the child View's column headers; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowColumnHeaders">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether column headers are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the column header panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowDetailButtons">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether master rows display master-detail expand buttons.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display master-detail expand buttons; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowFooter">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the view footer is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the View footer; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowGroupedColumns">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether grouping columns are displayed within the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display grouping columns within the view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowGroupExpandCollapseButtons">
|
|
<summary>
|
|
<para>Gets or sets whether group expand buttons are visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if group expand buttons are visible; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowGroupPanel">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the group panel is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the group panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowHorizontalLines">
|
|
<summary>
|
|
<para>Gets or sets whether horizontal grid lines are displayed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if horizontal grid lines are displayed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowHorzLines">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether horizontal grid lines are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display horizontal grid lines; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowIndicator">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the row indicator panel is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the row indicator panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowNewItemRow">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the new item row is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the new item row; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowPreview">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether preview sections are displayed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display row preview sections; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowPreviewLines">
|
|
<summary>
|
|
<para>Gets or sets whether preview lines are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display preview lines; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowPreviewRowLines">
|
|
<summary>
|
|
<para>Gets or sets whether horizontal lines are displayed below preview sections.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if horizontal lines are displayed below preview sections.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowVerticalLines">
|
|
<summary>
|
|
<para>Gets or sets whether vertical grid lines are displayed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if vertical grid lines are displayed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.ShowVertLines">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether vertical grid lines are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display vertical grid lines; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsView.WaitAnimationOptions">
|
|
<summary>
|
|
<para>Gets or sets how async data loading operations are indicated. This property is in effect in Instant Feedback Mode.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.WaitAnimationOptions"/> object that specifies how async data loading operations are indicated.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection">
|
|
|
|
<summary>
|
|
<para>Provides selection options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.EnableAppearanceFocusedCell">
|
|
<summary>
|
|
<para>Gets or sets whether the appearance settings for focused cell are enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the appearance settings for focused cell are enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.EnableAppearanceFocusedRow">
|
|
<summary>
|
|
<para>Gets or sets whether the appearance settings for focused row are enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the appearance settings for focused row are enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.EnableAppearanceHideSelection">
|
|
<summary>
|
|
<para>Gets or sets whether the appearance settings used to paint the selected row(s) when the grid control is not focused are enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the appearance settings used to paint the selected row(s) when the grid control is not focused are enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.InvertSelection">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the focused style is applied to the focused cell only or to all but the focused row cell.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to apply focused style to the focused cell only; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.MultiSelectMode">
|
|
<summary>
|
|
<para>Gets or sets whether multiple cells or rows can be selected.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode"/> enumeration value which specifies whether multiple cells or rows can be selected.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.UseIndicatorForSelection">
|
|
<summary>
|
|
<para>Gets or sets whether rows can be selected via the Row Indicator Panel when the grid is in multiple selection mode.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if rows can be selected via the row indicator; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint">
|
|
|
|
<summary>
|
|
<para>Provides print/export options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.AutoWidth">
|
|
<summary>
|
|
<para>Gets or sets whether widths of columns in the print/export output are automatically changed so that the View fits the page width.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to force the View to fit the page horizontally; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.EnableAppearanceEvenRow">
|
|
<summary>
|
|
<para>Gets or sets whether even rows in the print/export output are painted using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.EvenRow"/> property.
|
|
This option is in effect when the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.UsePrintStyles"/> property is set to <b>true</b>.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to paint even rows using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.EvenRow"/> property; <b>false</b> to use the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridView.Appearance"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.EnableAppearanceOddRow">
|
|
<summary>
|
|
<para>Gets or sets whether odd rows in the print/export output are painted using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.OddRow"/> property.
|
|
This option is in effect when the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.UsePrintStyles"/> property is set to <b>true</b>.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to paint odd rows using the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances.OddRow"/> property; <b>false</b> to use the appearance settings provided by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridView.Appearance"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.ExpandAllDetails">
|
|
<summary>
|
|
<para>Gets or sets whether the View is printed/exported with all master rows expanded.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the View with all details visible regardless of master rows' expanded state; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.ExpandAllGroups">
|
|
<summary>
|
|
<para>Gets or sets whether the View is printed/exported with all group rows expanded.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the View with all data rows visible regardless of the group rows' expanded state; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.MaxMergedCellHeight">
|
|
<summary>
|
|
<para>Gets or sets the maximum height of merged cells in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the maximum height of merged cells in the print/export output.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintDetails">
|
|
<summary>
|
|
<para>Gets or sets to print/export details of master rows.
|
|
</para>
|
|
</summary>
|
|
<value><b>false</b> to print/export the View with all master rows collapsed, regardless of their actual expanded state; otherwise, <b>true</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintFilterInfo">
|
|
<summary>
|
|
<para>Gets or sets whether to display the filter panel in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the filter panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintFooter">
|
|
<summary>
|
|
<para>Gets or sets whether to display the view footer in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the View footer; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintGroupFooter">
|
|
<summary>
|
|
<para>Gets or sets whether to display group footers in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export group footers; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintHeader">
|
|
<summary>
|
|
<para>Gets or sets whether to display column headers in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export column headers; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintHorzLines">
|
|
<summary>
|
|
<para>Gets or sets whether horizontal grid lines are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display horizontal grid lines in the print/export output; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintPreview">
|
|
<summary>
|
|
<para>Gets or sets whether to display the preview sections in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print preview/export sections; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintSelectedRowsOnly">
|
|
<summary>
|
|
<para>Gets or sets whether only the focused/selected rows are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if only only the focused/selected rows are printed/exported; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.PrintVertLines">
|
|
<summary>
|
|
<para>Gets or sets whether vertical grid lines are displayed in the print/export output.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export vertical grid lines; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.SplitCellPreviewAcrossPages">
|
|
<summary>
|
|
<para>Gets or sets whether preview sections are allowed to be split across pages when printing/exporting.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if preview sections are allowed to be split across pages when printing/exporting; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint.UsePrintStyles">
|
|
<summary>
|
|
<para>Gets or sets whether print appearances are used when the grid control is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to use print appearances when the grid control is printed/exported; <b>false</b> to use View appearances.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation">
|
|
|
|
<summary>
|
|
<para>Provides navigation options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation.AutoFocusNewRow">
|
|
<summary>
|
|
<para>Gets or sets whether adding a new record to an underlying data source automatically moves focus to the corresponding grid row.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to focus new rows automatically; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation.AutoMoveRowFocus">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether horizontal navigation keys move focus to the next/previous row when the current row's last/first cell is focused.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if horizontal navigation keys can move focus between rows; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation.EnterMoveNextColumn">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the ENTER key can be used to move cell focus.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to enable focus moving using the ENTER key; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation.UseOfficePageNavigation">
|
|
<summary>
|
|
<para>Enables the Office 2007 navigation mode, where pressing the PAGE DOWN key moves focus to the bottom visible record, and pressing the PAGE UP key moves focus to the top visible record.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if Office 2007 navigation mode is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation.UseTabKey">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the TAB/SHIFT+TAB key combinations move focus to the next/previous row cell or to the next/previous control in tab order.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the TAB/SHIFT+TAB key combinations are processed by the view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu">
|
|
|
|
<summary>
|
|
<para>Provides menu options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.EnableColumnMenu">
|
|
<summary>
|
|
<para>Gets or sets whether the end-users can invoke Column Header Context Menu.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can right-click column headers to invoke their context menus; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.EnableFooterMenu">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can invoke footer context menus.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can click the view footer and group footers to invoke their context menus; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.EnableGroupPanelMenu">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can invoke the group panel context menu.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can right-click the group panel to invoke its context menu; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.ShowAddNewSummaryItem">
|
|
<summary>
|
|
<para>Gets or sets whether or not the footer menu contains an item that allows adding multiple total summaries for a column at runtime.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies the availability of the corresponding menu item.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.ShowAutoFilterRowItem">
|
|
<summary>
|
|
<para>Gets whether the "Show Auto Filter Row" check item is displayed within the Column Header Context Menu.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the "Show Auto Filter Row" check item is available within a column header's menu; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.ShowDateTimeGroupIntervalItems">
|
|
<summary>
|
|
<para>Gets or sets whether a menu that enables switching group modes for date-time columns is available at runtime.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a menu that enables switching group modes for date-time columns is available at runtime; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.ShowGroupSortSummaryItems">
|
|
<summary>
|
|
<para>Gets or sets whether a context menu for grouping columns contains commands that allow group rows to be sorted according to group summary values.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a grouping column's context menu contains these commands; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.ShowGroupSummaryEditorItem">
|
|
<summary>
|
|
<para>Gets or sets whether an end-user can invoke a Group Summary Editor at runtime, via a context menu.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can invoke a Group Summary Editor at runtime, via a context menu; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu.ShowSplitItem">
|
|
<summary>
|
|
<para>Gets or sets whether the <b>Split</b> command is available in the Grid Control's context menu.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the <b>Split</b> command is available in the Grid Control's context menu; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsHint">
|
|
|
|
<summary>
|
|
<para>Provides hint options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsHint.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsHint"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsHint.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsHint.ShowCellHints">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether hints are displayed for cells with truncated content.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display hints for cells with truncated content; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsHint.ShowColumnHeaderHints">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether hints are displayed for column headers displaying truncated captions.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display hints for column headers displaying truncated captions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsHint.ShowFooterHints">
|
|
<summary>
|
|
<para>Gets or sets whether tooltips are displayed for footer cells, when the text is clipped.
|
|
</para>
|
|
</summary>
|
|
<value>A Boolean value that specifies whether tooltips are displayed for footer cells, when the text is clipped.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail">
|
|
|
|
<summary>
|
|
<para>Provides detail customization options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.AllowExpandEmptyDetails">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether master rows can be expanded when details have no data.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if master rows can be expanded when details have no data; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.AllowOnlyOneMasterRowExpanded">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether several master rows can be expanded simultaneously.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if expanding a master row collapses the previously expanded row; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.AllowZoomDetail">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the View's immediate details can be maximized to fit the entire grid control's area.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if details can be zoomed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.AutoZoomDetail">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether details are automatically maximized to fit the entire grid control's area when corresponding master rows are expanded.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the details are automatically zoomed when master rows are expanded; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.EnableDetailToolTip">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether detail tooltips are enabled for detail Views that are opened via the current master View. This option must be applied to a master View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a detail tooltip is displayed when pointing to a master row's expand button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.EnableMasterViewMode">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the View's details can be displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to allow expanding master rows ; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.ShowDetailTabs">
|
|
<summary>
|
|
<para>Gets or sets whether detail tabs are displayed in detail sections when master rows of the current master View are expanded. This option must be applied to a master View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display detail tabs; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.SmartDetailExpand">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the current master View is automatically scrolled when one of its detail Views at the first level is expanded, so all rows in that detail View will be displayed. This functionality is supported only when expanding first level detail Views.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View is automatically scrolled when one of its detail Views is expanded; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.SmartDetailExpandButton">
|
|
<summary>
|
|
<para>Gets or sets whether master-detail expand buttons are displayed grayed out when their associated detail rows don't contain any data.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display master-detail expand buttons as grayed out when their associated detail rows don't contain any data; <b>false</b> to always display master-detail expand buttons in black.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.SmartDetailExpandButtonMode">
|
|
<summary>
|
|
<para>Gets or sets a value which specifies the manner in which master-detail expand buttons are painted.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.DetailExpandButtonMode"/> enumeration value which specifies whether master-detail expand buttons are displayed grayed out when their associated details don't contain any data.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail.SmartDetailHeight">
|
|
<summary>
|
|
<para>Reserved for future use.
|
|
</para>
|
|
</summary>
|
|
<value>Reserved for future use.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization">
|
|
|
|
<summary>
|
|
<para>Provides customization options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowColumnMoving">
|
|
<summary>
|
|
<para>Gets or sets whether end-users are allowed to move columns by dragging their headers.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users are allowed to move grid columns; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowColumnResizing">
|
|
<summary>
|
|
<para>Gets or sets whether end-users are allowed to change the width of grid columns.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users are allowed to change a column's width; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowFilter">
|
|
<summary>
|
|
<para>Gets or sets a value which specifies whether end-users can filter data using the filter dropdowns.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can filter data using the filter dropdowns; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowGroup">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether end-users can apply data grouping.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can apply data grouping; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowQuickHideColumns">
|
|
<summary>
|
|
<para>Gets or sets whether a column/band can be hidden by dragging it away from the Column Header Panel, even if the Customization Form is not open.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a column/band can be hidden by dragging it away from the Column Header Panel, even if the Customization Form is not open; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowRowSizing">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether end-users can resize data rows vertically.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can drag data rows' bottom edges to resize rows vertically; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowSort">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether end-users can apply data sorting.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can apply data sorting; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior">
|
|
|
|
<summary>
|
|
<para>Provides behavior options for Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior"/> class with the specified owning View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant which represents a Grid View whose behavior options are initialized.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.AllowFixedGroups">
|
|
<summary>
|
|
<para>Gets or sets whether the top visible group row is always displayed when scrolling through grouped data.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies if the top visible group row is always displayed when scrolling through grouped data.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.AllowIncrementalSearch">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether end-users can locate rows by typing the desired column value.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if incremental searching is allowed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.AllowOnlyOneMasterRowExpanded">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether several master rows can be expanded simultaneously.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if expanding a master row collapses the previously expanded row; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.AllowPartialRedrawOnScrolling">
|
|
<summary>
|
|
<para>Gets or sets whether a View is partially repainted when it's scrolled vertically by a row.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is partially repainted during vertical scrolling; <b>false</b> if the entire region of the View is repainted.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.AutoExpandAllGroups">
|
|
<summary>
|
|
<para>Gets or sets whether all the groups within the View are automatically expanded.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to expand all groups automatically; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.AutoUpdateTotalSummary">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether total summaries are automatically updated when changing column values.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> for automatic total summaries updating; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.CopyToClipboardWithColumnHeaders">
|
|
<summary>
|
|
<para>Gets or sets whether column captions are copied to the clipboard, when CTRL+C is pressed or the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.CopyToClipboard"/> method is called.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if column captions are copied to the clipboard when CTRL+C is pressed or the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.CopyToClipboard"/> method is called; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.DefaultCopyToClipboardWithColumnHeaders">
|
|
<summary>
|
|
<para>Gets the default value of the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.CopyToClipboardWithColumnHeaders"/> property. This property is set to <b>true</b>.
|
|
</para>
|
|
</summary>
|
|
<returns> [To be supplied] </returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.KeepGroupExpandedOnSorting">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the group rows' expanded state is preserved when applying data sorting.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to preserve the group rows' expanded state when sorting; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.SmartVertScrollBar">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether scrolling the View to the bottom places the last row to the top of the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the scrolling to the bottom places the last row to the bottom of the view; <b>false</b> if the last row is placed to the top as the result.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior.SummariesIgnoreNullValues">
|
|
<summary>
|
|
<para>Gets or sets whether null values must be ignored when calculating summaries.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if null values must be ignored when calculating summaries; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardOptionsView">
|
|
|
|
<summary>
|
|
<para>Provides appearance options for Card Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardOptionsView.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardOptionsView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardOptionsView.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowCardCaption">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether card captions are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display card captions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowCardExpandButton">
|
|
<summary>
|
|
<para>Gets or sets whether expand buttons are displayed within the card captions.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if expand buttons are displayed within the card captions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowEmptyFields">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether empty fields are displayed within cards.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if empty fields are displayed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowFieldCaptions">
|
|
<summary>
|
|
<para>Gets or sets whether field captions are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display field captions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowFieldHints">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether hints are displayed for card fields with truncated content.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display hints for card fields with truncated content; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowHorzScrollBar">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the horizontal scroll bar is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the horizontal scroll bar is displayed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowLines">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether Card Separator are displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the card separators are displayed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsView.ShowQuickCustomizeButton">
|
|
<summary>
|
|
<para>Gets or sets whether the customization button is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display the quick customization button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardOptionsPrint">
|
|
|
|
<summary>
|
|
<para>Provides print/export options for Card Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardOptionsPrint"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.AutoHorzWidth">
|
|
<summary>
|
|
<para>Gets or sets whether cards in the print/export output are automatically resized horizontally to fit the report page's width.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if cards are automatically resized horizontally to fit the report page's width; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.PrintCardCaption">
|
|
<summary>
|
|
<para>Gets or sets whether card captions are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if card captions are printed/exported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.PrintEmptyFields">
|
|
<summary>
|
|
<para>Gets or sets whether empty fields are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if empty fields are printed/exported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.PrintFilterInfo">
|
|
<summary>
|
|
<para>Gets or sets whether the filter panel is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the filter panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.PrintSelectedCardOnly">
|
|
<summary>
|
|
<para>Gets or sets whether to print/export only the selected card or all cards within the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to print/export the selected card only; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.PrintSelectedCardsOnly">
|
|
<summary>
|
|
<para>Gets or sets whether only the focused/selected cards are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if only only the focused/selected cards are printed/exported; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsPrint.UsePrintStyles">
|
|
<summary>
|
|
<para>Gets or sets whether print styles or View styles are used to print/export the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to use print styles for printing/exporting the grid's data; <b>false</b>, to use View styles.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior">
|
|
|
|
<summary>
|
|
<para>Provides behavior options for Card Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior"/> class with the specified owning View.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant which represents a Card View whose behavior options are initialized.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.AllowExpandCollapse">
|
|
<summary>
|
|
<para>Gets or sets whether cards can be collapsed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if cards can be collapsed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.AutoFocusNewCard">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether adding a new record focuses the new card.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to force the View to focus new cards automatically; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.AutoHorzWidth">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the Card Auto Width feature is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the cards auto width feature is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.FieldAutoHeight">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether card field height is calculated automatically, depending on cell contents.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to enable automatic field height calculation; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.Sizeable">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether a card column width can be changed by the end-users.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a card column width can be changed by the end-user; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior.UseTabKey">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the TAB/SHIFT+TAB key combinations move focus within the Card View or to the next/previous control in tab order.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if TAB/SHIFT+TAB key combinations are handled by the view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection">
|
|
|
|
<summary>
|
|
<para>Represents a column collection owned by a band.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.#ctor(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band that will own the column collection. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Band"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Add(DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn)">
|
|
<summary>
|
|
<para>Adds the specified column to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column to add.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Band">
|
|
<summary>
|
|
<para>Gets the band owning the current column collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object whose <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Columns"/> property is represented by this column collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Contains(DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn)">
|
|
<summary>
|
|
<para>Indicates whether the collection contains the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the collection contains the specified column; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.IndexOf(DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn)">
|
|
<summary>
|
|
<para>Returns the position of the specified column within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns>An integer value representing the specified column's zero-based index within the collection. <b>-1</b> if the collection doesn't contain the specified column.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Insert(System.Int32,DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn)">
|
|
<summary>
|
|
<para>Adds the specified column to the specified position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value representing the zero-based index where the specified column should be inserted. If negative or exceeds the number of elements, an exception is raised.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column to insert.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to columns.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the required column's zero-based index. If negative or exceeds the number of elements, an exception is raised.
|
|
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column at the specified position within the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Item(System.String)">
|
|
<summary>
|
|
<para>Gets a column with the specified name.
|
|
</para>
|
|
</summary>
|
|
<param name="name">
|
|
A <see cref="T:System.String"/> value specifying the column name.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if the specified column doesn't belong to the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.MoveTo(System.Int32,DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn)">
|
|
<summary>
|
|
<para>Moves a column to a new position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="newIndex">
|
|
An integer value specifying the target position (a zero-based index within the collection). A negative value to remove the column.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column to be moved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.Remove(DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn)">
|
|
<summary>
|
|
<para>Removes a column from the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column to remove.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.View">
|
|
<summary>
|
|
<para>Gets the View that displays columns from this collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object (or descendant) representing the View that displays columns from this collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if collection doesn't have the owning band or the owning band doesn't have the owning View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection.VisibleColumnCount">
|
|
<summary>
|
|
<para>Gets the number of visible columns.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the number of visible columns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection">
|
|
|
|
<summary>
|
|
<para>Represents a band collection.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.#ctor(DevExpress.XtraGrid.Views.BandedGrid.BandedGridView,DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection"/> class.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object or its descendant representing a View to which the created collection belongs. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.View"/> property.
|
|
|
|
</param>
|
|
<param name="ownerBand">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band that owns the created band collection. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.OwnerBand"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Add">
|
|
<summary>
|
|
<para>Creates and adds a new band to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band added.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Add(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Adds the specified band to the end of the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band to be added.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the new band.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.AddBand(System.String)">
|
|
<summary>
|
|
<para>Creates a band with the specified caption and appends it to the collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="caption">
|
|
A <see cref="T:System.String"/> value which specifies the band's caption. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Caption"/> property.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object which represents the created band.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.AddRange(DevExpress.XtraGrid.Views.BandedGrid.GridBand[])">
|
|
<summary>
|
|
<para>Adds an array of band objects to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="bands">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> objects to be added to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.CanAdd(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Indicates whether the specified band can be added to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band being examined.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified band can be added to the collection; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Contains(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Indicates whether the collection contains a specific band.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object to locate in the collection.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the collection contains the specified band; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.ContainsEx(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Indicates whether a specific band is a child of the collection owner (at any nesting level).
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object to be located among the collection owner's children.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified band is a child of the collection owner; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.CreateBand">
|
|
<summary>
|
|
<para>Creates a new band with default settings.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object that represents the created band.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.FirstVisibleBand">
|
|
<summary>
|
|
<para>Gets the first visible band within the collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the first visible band within the collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if the collection contains no visible bands.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.GetVisibleBand(System.Int32)">
|
|
<summary>
|
|
<para>Returns a band at the specified position among visible bands within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the zero-based index of a band among visible bands.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing a band at the specified position among visible bands. <b>null</b> (<b>Nothing</b> in Visual Basic) if the collection contains no visible bands or the specified index is negative or exceeds the maximum available visible index.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.GetVisibleBand(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Searches for a visible band starting from a specified band.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object specifying the band from which the search is started.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the found band. <b>null</b> (<b>Nothing</b> in Visual Basic) if no visible band is found.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.IndexOf(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Returns the specified band's position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band to be located.
|
|
|
|
</param>
|
|
<returns>An integer value representing the specified band's zero-based index. <b>-1</b> if the collection doesn't contain the specified band.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Insert(System.Int32)">
|
|
<summary>
|
|
<para>Creates a new band and adds it at the specified position within a collection.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value representing the zero-based index at which the new band should be inserted.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the new band.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Insert(System.Int32,DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Adds the specified band to the specified position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="position">
|
|
An integer value representing the zero-based index at which the specified band should be inserted. If negative or exceeds the number of elements, an exception is raised.
|
|
|
|
</param>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band to be inserted.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.InsertRoot(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Adds a band to the collection moving all previous collection elements to this band's children collection.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band to be added.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Item(System.String)">
|
|
<summary>
|
|
<para>Gets a band with the specified name.
|
|
</para>
|
|
</summary>
|
|
<param name="name">
|
|
A <see cref="T:System.String"/> value specifying the name of the band to be found.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing a band with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if no band is found.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to bands.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the band's zero-based index within the collection.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band located at the specified position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.LastVisibleBand">
|
|
<summary>
|
|
<para>Gets the last visible band within the collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the last visible band within the collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if the collection contains no visible bands.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.MoveTo(System.Int32,DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Moves a band to a new position within the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="newIndex">
|
|
An integer value representing a new position of a band within the collection.
|
|
|
|
</param>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band to be moved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.OwnerBand">
|
|
<summary>
|
|
<para>Gets a band owning the current band collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object whose <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Children"/> property is represented by this band collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.Remove(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Removes the specified band from the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band to remove.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.View">
|
|
<summary>
|
|
<para>Gets the View that displays bands from this collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object (or descendant) representing the View displaying bands in this collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection.VisibleBandCount">
|
|
<summary>
|
|
<para>Gets the number of visible bands within the collection.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the number of visible bands within the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand">
|
|
|
|
<summary>
|
|
<para>Represents an individual band.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBand.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.AppearanceHeader">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the band header.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object representing the band header's appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.AutoFillDown">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether a band header should be automatically stretched to fill the empty space below it.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a band header is automatically stretched to fill the empty space below it; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.BandLevel">
|
|
<summary>
|
|
<para>Gets the band's nesting level.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the band's zero-based nesting level.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Caption">
|
|
<summary>
|
|
<para>Gets or sets the band's caption.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the text to be displayed within the band header.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Children">
|
|
<summary>
|
|
<para>Provides access to the band's child bands collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection"/> object representing the child bands collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Collection">
|
|
<summary>
|
|
<para>Gets the bands collection that owns the current band.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection"/> object representing the bands collection that owns the current band.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Columns">
|
|
<summary>
|
|
<para>Provides access to columns owned by the band.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandColumnCollection"/> object representing the band's column collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.CustomizationCaption">
|
|
<summary>
|
|
<para>Gets or sets the band's caption when its header is displayed within the Customization Form.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value which specifies the band's caption when its header is displayed within the customization form.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Fixed">
|
|
<summary>
|
|
<para>Gets or sets the band's behavior when the View is scrolled horizontally.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.FixedStyle"/> enumeration member specifying the band behavior when the View is scrolled horizontally.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBand.GetTextCaption">
|
|
<summary>
|
|
<para>Returns the non formatted band caption.
|
|
</para>
|
|
</summary>
|
|
<returns>A string value that represents the band's non formatted caption.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.HasChildren">
|
|
<summary>
|
|
<para>Gets a value indicating that the band has child bands.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band contains one or more child bands; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.ImageAlignment">
|
|
<summary>
|
|
<para>Gets or sets the band header image alignment.
|
|
</para>
|
|
</summary>
|
|
<value>A <b>System.Drawing.StringAlignment</b> enumeration member specifying the image alignment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.ImageIndex">
|
|
<summary>
|
|
<para>Gets or sets the image displayed within the band header.
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer specifying the image by its index within the source collection. <b>-1</b> if no image is displayed within the band header.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Images">
|
|
<summary>
|
|
<para>Gets an image collection whose images can be displayed within the band's header.
|
|
</para>
|
|
</summary>
|
|
<value>An object which provides images for band headers.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Index">
|
|
<summary>
|
|
<para>Gets the band's position within the owning collection.
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer representing the band's position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.IsLoading">
|
|
<summary>
|
|
<para>Indicates whether the View that owns the band is currently being initialized.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is being initialized; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.MinWidth">
|
|
<summary>
|
|
<para>Gets or sets the band's minimum allowed width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the band's minimum width in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Name">
|
|
<summary>
|
|
<para>Gets or sets the band name.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value specifying the band name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.OptionsBand">
|
|
<summary>
|
|
<para>Provides access to the band's options.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand"/> object containing the band's options.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.ParentBand">
|
|
<summary>
|
|
<para>Gets the parent band.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band's parent. <b>null</b> (<b>Nothing</b> in Visual Basic) if the band is at the root hierarchy level or if it not within the View's bands hierarchy.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.ReallyVisible">
|
|
<summary>
|
|
<para>Gets a value indicating whether the band is currently visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a band is currently visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Resize(System.Int32)">
|
|
<summary>
|
|
<para>Specifies a new width for the band.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="newWidth">
|
|
An integer value representing the band's new width.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.RootBand">
|
|
<summary>
|
|
<para>Gets the root band that is the current band's parent.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the root band in the current band's hierarchy branch.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.RowCount">
|
|
<summary>
|
|
<para>Gets or sets the band header height in rows.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the band header height in rows. Values less than <b>1</b> are not accepted.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Tag">
|
|
<summary>
|
|
<para>Gets or sets the data associated with the current band.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An object containing information which is associated with the current band.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.ToolTip">
|
|
<summary>
|
|
<para>Gets or sets a custom tooltip for the band.
|
|
</para>
|
|
</summary>
|
|
<value>A string, which is a custom tooltip for the band.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.GridBand.ToString">
|
|
<summary>
|
|
<para>Gets the band's caption.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that specifies the band's caption.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.View">
|
|
<summary>
|
|
<para>Gets the View to which the band belongs.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object (or descendant) representing the View to which the band belongs.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Visible">
|
|
<summary>
|
|
<para>Gets or sets whether the band is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.VisibleIndex">
|
|
<summary>
|
|
<para>Gets the band's visual position within its owner (within a parent band or, for root bands, within a View).
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer value specifying the band's visual position. <b>-1</b> if the band is invisible.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.VisibleWidth">
|
|
<summary>
|
|
<para>Gets the current band width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the current band width in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.GridBand.Width">
|
|
<summary>
|
|
<para>Gets or sets band width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying band width in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CustomDrawBandHeader"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CustomDrawBandHeader"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
An event source identifying the View which raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs"/> object providing data for the event.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CustomDrawBandHeader"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,DevExpress.Utils.Drawing.HeaderObjectPainter,DevExpress.XtraGrid.Drawing.GridBandInfoArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
An <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> object that provides default painting facilities. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.Utils.Drawing.StyleObjectInfoArgs"/> object that contains the View information about the band header being painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs.Info"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs.Band">
|
|
<summary>
|
|
<para>Gets the band whose header is to be painted.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object specifying the band whose header is to be painted.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandHeaderCustomDrawEventArgs.Info">
|
|
<summary>
|
|
<para>Gets an object providing View information for the band header being painted.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Drawing.GridBandInfoArgs"/> object containing the painted band's View information.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView">
|
|
|
|
<summary>
|
|
<para>Represents a View that displays data in a tabular form and which allows grouping of columns into bands.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.#ctor(DevExpress.XtraGrid.GridControl)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object with the specified owner.
|
|
</para>
|
|
</summary>
|
|
<param name="ownerGrid">
|
|
A <see cref="T:DevExpress.XtraGrid.GridControl"/> object representing a grid control that will own the View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.GridControl"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.Appearance">
|
|
<summary>
|
|
<para>Provides access to the properties that control the appearance of the Banded Grid View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewAppearances"/> object that provides appearance settings for the View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.AppearancePrint">
|
|
<summary>
|
|
<para>Provides access to the properties that specify the appearances of Banded Grid View elements when they are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewPrintAppearances"/> object that provides appearance settings for Banded Grid View elements when they are printed/exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.Assign(DevExpress.XtraGrid.Views.Base.BaseView,System.Boolean)">
|
|
<summary>
|
|
<para>Copies properties and, optionally, event handlers from the View passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="v">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing a View whose properties and event handlers are copied. If <b>null</b> (<b>Nothing</b> in Visual Basic), the method does nothing.
|
|
|
|
</param>
|
|
<param name="copyEvents">
|
|
<b>true</b> if event handlers should be copied; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.BandPanelRowHeight">
|
|
<summary>
|
|
<para>Gets or sets the band panel row height.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the band panel row height in pixels. <b>-1</b> to calculate the band panel row height automatically based on band header contents.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.Bands">
|
|
<summary>
|
|
<para>Provides access to the root bands collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBandCollection"/> object representing the root bands collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.BandWidthChanged">
|
|
<summary>
|
|
<para>Occurs when the band's width is changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CalcHitInfo(System.Drawing.Point)">
|
|
<summary>
|
|
<para>Returns information about View elements located at a specified point.
|
|
</para>
|
|
</summary>
|
|
<param name="pt">
|
|
A <see cref="T:System.Drawing.Point"/> structure specifying the test point coordinates relative to the grid control's top-left corner.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo"/> object that contains information about View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CalcHitInfo(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns information about the View elements located at the specified point.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="x">
|
|
An integer representing the X coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<param name="y">
|
|
An integer representing the Y coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo"/> object which contains information on the View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CanDragBand(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Indicates whethera band can be dragged by end-users.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the inspected band.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can drag the band; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CanResizeBand(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Indicates whether the specified band can be resized by end-users.
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the inspected band.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can resize the specified band; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.Columns">
|
|
<summary>
|
|
<para>Provides access to the columns collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection"/> object representing the View's column collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CreateExportLink(DevExpress.XtraExport.IExportProvider)">
|
|
<summary>
|
|
<para>Returns an object that enables you to export a View's data in a number of different formats
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object implementing the <b>DevExpress.XtraExport.IExportProvider</b> interface that exports data to a particular format.
|
|
|
|
</param>
|
|
<returns>A <b>BaseExportLink</b> descendant (a <b>BandedViewExportLink</b> object) providing facilities for exporting data.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.CustomDrawBandHeader">
|
|
<summary>
|
|
<para>Enables you to custom paint band headers.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.InvalidateBandHeader(DevExpress.XtraGrid.Views.BandedGrid.GridBand)">
|
|
<summary>
|
|
<para>Invalidates a band header or the entire band panel.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="band">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing the band whose header is to be repainted. <b>null</b> (<b>Nothing</b> in Visual Basic) to invalidate the entire band panel.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.InvalidateHitObject(DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo)">
|
|
<summary>
|
|
<para>Invalidates the View element located at the point specified by the hit information object.
|
|
</para>
|
|
</summary>
|
|
<param name="hitInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/> descendant (a <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.ViewInfo.BandedGridHitInfo"/> object) containing hit information.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.IsDraggingState">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View element is currently being dragged.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a band header or column header is being dragged; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.IsSizingState">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View element is currently being resized.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View element is being resized; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.MinBandPanelRowCount">
|
|
<summary>
|
|
<para>Gets or sets the minimum band header panel height in rows.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the minimal number of rows possible within the band panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.OptionsCustomization">
|
|
<summary>
|
|
<para>Provides access to the View's customization options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization"/> object containing the View's customization options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.OptionsHint">
|
|
<summary>
|
|
<para>Provides access to the View's hint options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsHint"/> object containing the View's hint options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.OptionsPrint">
|
|
<summary>
|
|
<para>Provides options that control how the View is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsPrint"/> object containing the View's print and export options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.OptionsView">
|
|
<summary>
|
|
<para>Provides access to the View's visual display options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsView"/> object containing the View's visual display options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.PaintAppearance">
|
|
<summary>
|
|
<para>Provides access to the appearance settings currently used to paint the banded View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedViewAppearances"/> object which provides the appearance settings currently used to paint the banded View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.State">
|
|
<summary>
|
|
<para>Gets the View's current state.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState"/> enumeration member indicating the View's current state.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView.SynchronizeVisual(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes a View's visual settings with the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose visual settings should be copied to the current View.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsView">
|
|
|
|
<summary>
|
|
<para>Provides appearance options for Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsView.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsView.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsView.ShowBands">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the band panel is displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the band panel is displayed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsView.ShowGroupedColumns">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether grouping columns should be displayed within the View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to display grouping columns within the view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsHint">
|
|
|
|
<summary>
|
|
<para>Provides hint options for Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsHint.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsHint"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsHint.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsHint.ShowBandHeaderHints">
|
|
<summary>
|
|
<para>Gets or sets a value spoecifying whether hints are displayed for band headers with truncated captions.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if hints are displayed for band headers with truncated captions; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization">
|
|
|
|
<summary>
|
|
<para>Provides customization options for Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization.AllowBandMoving">
|
|
<summary>
|
|
<para>Gets or sets whether bands can be moved to a new position.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if bands can be moved to a new position; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization.AllowBandResizing">
|
|
<summary>
|
|
<para>Gets or sets whether the bands can be resized.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the bands can be resized; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization.AllowChangeBandParent">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether end-users can move bands between parents.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if bands can be moved between parents; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization.AllowChangeColumnParent">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether end-users can move columns between bands.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can move columns between bands; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies all settings from the options object passed as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridOptionsCustomization.ShowBandsInCustomizationForm">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether hidden bands can be shown within the customization form.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if hidden bands can be shown within the customization form; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnReadOnlyCollection">
|
|
|
|
<summary>
|
|
<para>Represents a read-only collection of banded columns.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnReadOnlyCollection.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnReadOnlyCollection"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant representing the View owning the column collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnReadOnlyCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Provides indexed access to individual columns.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the zero-based index of the required collection item.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column at the specified position within the collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if the specified index is negative or exceeds the last available index.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection">
|
|
|
|
<summary>
|
|
<para>Represents a banded grid column collection.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.#ctor(DevExpress.XtraGrid.Views.Base.ColumnView)">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant representing a View that will own the column collection created. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.View"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.Add">
|
|
<summary>
|
|
<para>Creates a new hidden column and appends it to the collection.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the new column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.AddField(System.String)">
|
|
<summary>
|
|
<para>Creates a new column which is bound to the specified field and appends it to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value that specifies the name of the data field to bind the created column to.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object which represents the new column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.AddRange(DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn[])">
|
|
<summary>
|
|
<para>Adds an array of column objects to the collection.
|
|
</para>
|
|
</summary>
|
|
<param name="columns">
|
|
An array of <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> objects to be added to the collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.ColumnByFieldName(System.String)">
|
|
<summary>
|
|
<para>Returns a column by the name of the field to which it is bound.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value specifying the field name.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing a column bound to the data source field with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column is found.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.ColumnByName(System.String)">
|
|
<summary>
|
|
<para>Returns a column by its name.
|
|
</para>
|
|
</summary>
|
|
<param name="columnName">
|
|
A <see cref="T:System.String"/> value specifying the column name.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing a column with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column is found.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.Item(System.Int32)">
|
|
<summary>
|
|
<para>Gets a column at a specific index.
|
|
</para>
|
|
</summary>
|
|
<param name="index">
|
|
An integer value specifying the zero-based index of the required column. If negative or exceeds the maximum available index, an exception is raised.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing a column at the specified position within the collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.Item(System.String)">
|
|
<summary>
|
|
<para>Gets a column by the name of the field to which it is bound.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A <see cref="T:System.String"/> value specifying the data source field name.
|
|
|
|
</param>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing a column within the collection bound to the data source field with the specified name. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column is found.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumnCollection.View">
|
|
<summary>
|
|
<para>Gets the View that owns a column collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object representing a View where columns of this collection are displayed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn">
|
|
|
|
<summary>
|
|
<para>Represents an individual column within Banded Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.AutoFillDown">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether a column header should be automatically stretched to fill the empty space below it.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a column header is automatically stretched to fill the empty space below it; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.ColIndex">
|
|
<summary>
|
|
<para>Gets a column's horizontal position within a band row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the zero-based index of a column within a band row. <b>-1</b> if the column has no parent band.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.ColVIndex">
|
|
<summary>
|
|
<para>Gets or sets the column's visible state and position within a band row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the column's zero-based index among the visible columns in a band row. <b>-1</b> if the column is invisible.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.Fixed">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether a column is scrolled horizontally with the View or in a fixed position.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.FixedStyle"/> enumeration member specifying column behavior when the View is scrolled.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.MaxWidth">
|
|
<summary>
|
|
<para>This property is not supported by the BandedGridColumn class.
|
|
</para>
|
|
</summary>
|
|
<value>0
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.OwnerBand">
|
|
<summary>
|
|
<para>Gets or sets a column's parent band.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.GridBand"/> object representing a band to which a column belongs.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.RowCount">
|
|
<summary>
|
|
<para>Gets or sets the column header height in rows.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the column header height in rows. Values less than <b>1</b> are not accepted.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.RowIndex">
|
|
<summary>
|
|
<para>Gets or sets the vertical position of a banded column.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the zero-based index of the band row where a column header is displayed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.View">
|
|
<summary>
|
|
<para>Gets the View to which a specific column belongs.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridView"/> object representing a View to which a column belongs.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.VisibleIndex">
|
|
<summary>
|
|
<para>Gets or sets the column's position among visible columns.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the column's zero-based index among visible columns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView">
|
|
|
|
<summary>
|
|
<para>Represents a View that displays data in a tabular form, allows grouping columns into bands and supports complex data cell arrangements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.#ctor(DevExpress.XtraGrid.GridControl)">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView"/> class owned by the grid control specified.
|
|
</para>
|
|
</summary>
|
|
<param name="ownerGrid">
|
|
A <see cref="T:DevExpress.XtraGrid.GridControl"/> object representing the grid control that will own the created View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.GridControl"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView"/> class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.CreateExportLink(DevExpress.XtraExport.IExportProvider)">
|
|
<summary>
|
|
<para>Returns an object that enables you to export a View's data in a number of different formats.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object implementing the <b>DevExpress.XtraExport.IExportProvider</b> interface that exports data to a particular format.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Export.BaseExportLink"/> descendant (a <b>DevExpress.XtraGrid.Export.AdvBandedViewExportLink</b> object) providing exporting facilities.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.OptionsNavigation">
|
|
<summary>
|
|
<para>Provides access to a View's navigation options.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsNavigation"/> object that contains a View's navigation options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.OptionsSelection">
|
|
<summary>
|
|
<para>Provides access to the View's selection options.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsSelection"/> object which contains the View's selection properties.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.OptionsView">
|
|
<summary>
|
|
<para>Provides access to the View's display options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridOptionsView"/> object containing the View's display options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.SetColumnPosition(DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn,System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Moves a column to the specified position among visible columns belonging to the same band.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn"/> object representing the column to be moved.
|
|
|
|
</param>
|
|
<param name="rowIndex">
|
|
An integer value representing the zero-based index of the row where the specified column should be moved. This value is assigned to the column's <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.RowIndex"/> property. If negative, an exception is raised.
|
|
|
|
</param>
|
|
<param name="colIndex">
|
|
An integer value representing the zero-based column index within a band row. This value is assigned to the column's <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn.ColIndex"/> property. If negative, it is set to <b>0</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.BandedGrid.AdvBandedGridView.SetColumnWidth(DevExpress.XtraGrid.Views.BandedGrid.BandedGridColumn,System.Int32)">
|
|
<summary>
|
|
<para>Sets the column's width to the specified value.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object whose width is to be changed.
|
|
|
|
</param>
|
|
<param name="width">
|
|
The column's new width. This value cannot be less than <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.MinWidth"/>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState">
|
|
|
|
<summary>
|
|
<para>Contains values indicating all available Banded Grid View states.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.BandDown">
|
|
<summary>
|
|
<para>A band header is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.BandDragging">
|
|
<summary>
|
|
<para>A band header is being dragged by the end-user. The band's <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.AllowMove"/> option must be enabled to allow band header dragging.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.BandSizing">
|
|
<summary>
|
|
<para>A band is being resized by the end-user. This implies that the band header's right edge is being dragged. This operation is available only for bands whose <see cref="P:DevExpress.XtraGrid.Views.BandedGrid.OptionsBand.AllowSize"/> option is enabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.CellSelection">
|
|
<summary>
|
|
<para>Multiple cells are being selected by an end-user using the mouse. The <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.MultiSelectMode"/> property must be set to the <see cref="F:DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode.CellSelect"/> value to make this operation available.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.ColumnButtonDown">
|
|
<summary>
|
|
<para>A header panel button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.ColumnDown">
|
|
<summary>
|
|
<para>A column header is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.ColumnDragging">
|
|
<summary>
|
|
<para>A column header is being dragged by the end-user. The column's <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowMove"/> and View's <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowColumnMoving"/> options must be enabled to allow column header dragging.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.ColumnFilterDown">
|
|
<summary>
|
|
<para>A column's filter button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.ColumnSizing">
|
|
<summary>
|
|
<para>A column is being resized by the end-user. This implies that the column header's right edge is being dragged. This operation is available only for columns whose <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowSize"/> option is enabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.Editing">
|
|
<summary>
|
|
<para>A cell editor is active at the moment.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.FilterCloseButtonPressed">
|
|
<summary>
|
|
<para>A filter close button is pressed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.FilterPanelActiveButtonPressed">
|
|
<summary>
|
|
<para>A check box residing in a filter panel is pressed. This implies that the filter criteria applied to a View is going to be enabled or disabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.FilterPanelCustomizeButtonPressed">
|
|
<summary>
|
|
<para>A filter panel customize button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.FilterPanelMRUButtonPressed">
|
|
<summary>
|
|
<para>The button which is used to display a dropdown window with a list of the most recently used filter criteria is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.FilterPanelTextPressed">
|
|
<summary>
|
|
<para>The string in the filter panel which represents the filter criteria applied to a View is pressed. This shows/hides a dropdown window with a list of the most recently used filter criteria.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.IncrementalSearch">
|
|
<summary>
|
|
<para>The incremental search is being performed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.Normal">
|
|
<summary>
|
|
<para>No specific action is being performed within a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.RowDetailSizing">
|
|
<summary>
|
|
<para>A detail View's clone is being resized by the end-user. This implies that the detail's bottom edge is being dragged.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.RowSizing">
|
|
<summary>
|
|
<para>A data row is being resized by the end-user. This implies that the corresponding indicator cell's bottom edge is being dragged. The <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowRowSizing"/> option must be enabled to allow such operations.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.Scrolling">
|
|
<summary>
|
|
<para>A View is being scrolled. This implies that an end-user has depressed the mouse wheel and is moving the mouse to scroll the View's contents.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.Selection">
|
|
<summary>
|
|
<para>Multiple rows are being selected using the dragging operation. This implies that the end-user presses an indicator cell corresponding to the selection start and drags the mouse to the selection end. The <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection.MultiSelect"/> option must be enabled to make this operation available.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.BandedGrid.BandedGridState.Unknown">
|
|
<summary>
|
|
<para>An unknown action is being performed within a View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode">
|
|
|
|
<summary>
|
|
<para>Contains values that specify how cards are arranged in a print/export output.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode.Column">
|
|
<summary>
|
|
<para>Cards are arranged in a single column.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode.Default">
|
|
<summary>
|
|
<para>Currently, this option is the same as the <see cref="F:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode.MultiColumn"/> option.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode.MultiColumn">
|
|
<summary>
|
|
<para>Cards are arranged in multiple columns.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode.MultiRow">
|
|
<summary>
|
|
<para>Cards are arranged in multiple rows.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Layout.LayoutViewPrintMode.Row">
|
|
<summary>
|
|
<para>Cards are arranged in a single row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanded"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsed"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.RowEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanded"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsed"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.RowEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanded"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsed"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowEventArgs.#ctor(System.Int32)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.RowEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the row's handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the row's handle.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the row's handle.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowAllowEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanding"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsing"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowAllowEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.RowAllowEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanding"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsing"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.RowAllowEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowAllowEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanding"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsing"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowAllowEventArgs.#ctor(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.RowAllowEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="allow">
|
|
<b>true</b> if the group row can be collapsed/expanded; otherwise, <b>false</b>. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowAllowEventArgs.Allow"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowAllowEventArgs.Allow">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the current operation is allowed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to allow the operation; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowCollapsed"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowExpanded"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowCollapsed"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowExpanded"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. This parameter identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs"/> that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode">
|
|
|
|
<summary>
|
|
<para>Contains display options applied in single card display mode.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode.#ctor(DevExpress.XtraGrid.Views.Layout.LayoutView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewOptionsSingleRecordMode class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> object that will own the created object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode.Assign(DevExpress.Utils.Controls.BaseOptions)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.Controls.BaseOptions"/> descendant whose settings are assigned to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode.CardAlignment">
|
|
<summary>
|
|
<para>Gets or sets the card's alignment within the View when the card is stretched to fully fill the View's width or height. This option is in effect when the <see cref="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode.StretchCardToViewHeight"/> or <see cref="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode.StretchCardToViewWidth"/> property is enabled (not both).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Layout.CardsAlignment"/> value that specifies the card's alignment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode.StretchCardToViewHeight">
|
|
<summary>
|
|
<para>Gets or sets whether the currently visible card is stretched vertically to fully fill the View's height. This option is in effect in Single Record view mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current card is stretched vertically to fully fill the View's height; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.LayoutViewOptionsSingleRecordMode.StretchCardToViewWidth">
|
|
<summary>
|
|
<para>Gets or sets whether the currently visible card is stretched horizontally to fully fill the View's width. This option is in effect in Single Record view mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current card is stretched horizontally to fully fill the View's width; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridMenuType">
|
|
|
|
<summary>
|
|
<para>Lists values specifying Grid View context menu types.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridMenuType.Column">
|
|
<summary>
|
|
<para>Corresponds to the column header context menu.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridMenuType.Group">
|
|
<summary>
|
|
<para>Corresponds to the group panel context menu.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridMenuType.Row">
|
|
<summary>
|
|
<para>Corresponds to the context menu which is activated by an end-user right-clicking on a data or group row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridMenuType.Summary">
|
|
<summary>
|
|
<para>Corresponds to the footer cell context menu.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridMenuType.User">
|
|
<summary>
|
|
<para>Corresponds to the user defined context menu.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ShowFilterPanelMode">
|
|
|
|
<summary>
|
|
<para>Contains values that specify when the Filter Panel is visible.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowFilterPanelMode.Default">
|
|
<summary>
|
|
<para>The filter panel is shown when the filtering is applied to a View. Otherwise, the filter panel is hidden.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowFilterPanelMode.Never">
|
|
<summary>
|
|
<para>The filter panel is hidden.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowFilterPanelMode.ShowAlways">
|
|
<summary>
|
|
<para>The filter panel is always shown at the bottom of the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GridMenuItemClick"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GridMenuItemClick"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GridMenuItemClick"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraGrid.GridSummaryItemCollection,DevExpress.XtraGrid.GridSummaryItem,DevExpress.Data.SummaryItemType,System.String,DevExpress.XtraGrid.Views.Grid.GridMenuType,System.Windows.Forms.MenuItem)">
|
|
<summary>
|
|
<para>Creates and initializes a new <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column containing an element where the context menu was activated. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="items">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItemCollection"/> object representing the group summaries collection defined for the sender View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryItems"/> property.
|
|
|
|
</param>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object representing a summary item whose corresponding footer cell was clicked to invoke the menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryItem"/> property.
|
|
|
|
</param>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregate function type used by the summary item. This value is assigned the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="format">
|
|
A <see cref="T:System.String"/> value specifying the summary value formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryFormat"/> property.
|
|
|
|
</param>
|
|
<param name="mtype">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value specifying the context menu type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.MenuType"/> property.
|
|
|
|
</param>
|
|
<param name="menuItem">
|
|
A <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.MenuItem"/> object representing the clicked menu item. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.MenuItem"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraGrid.GridSummaryItemCollection,DevExpress.XtraGrid.GridSummaryItem,DevExpress.Data.SummaryItemType,System.String,DevExpress.XtraGrid.Views.Grid.GridMenuType,DevExpress.Utils.Menu.DXMenuItem)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing the column whose footer cell or header was clicked to invoke a menu. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="items">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItemCollection"/> object representing the View's group summaries collection. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryItems"/> property.
|
|
|
|
</param>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object specifying summary settings for the footer cell where the context menu was activated. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryItem"/> property.
|
|
|
|
</param>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value representing the summary item's type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="format">
|
|
A string value representing the summary value's formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryFormat"/> property.
|
|
|
|
</param>
|
|
<param name="mtype">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value specifying the type of the menu whose item was clicked. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.MenuType"/> property.
|
|
|
|
</param>
|
|
<param name="menuItem">
|
|
A <see cref="T:DevExpress.Utils.Menu.DXMenuItem"/> object representing the clicked DX menu item. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.DXMenuItem"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column whose footer cell or header was clicked to invoke a context menu.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing the column whose footer cell or header was clicked to invoke a menu. <b>null</b> (<b>Nothing</b> in Visual Basic) if a group panel's menu item was clicked.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.DXMenuItem">
|
|
<summary>
|
|
<para>Gets the clicked menu item.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.Menu.DXMenuItem"/> object representing the clicked menu item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether default menu item click processing is required after event handler execution.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if default event processing is not required; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.MenuItem">
|
|
<summary>
|
|
<para>This property is obsolete.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Windows.Forms.MenuItem"/> object representing the clicked menu item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.MenuType">
|
|
<summary>
|
|
<para>Gets the type of the context menu whose item was clicked.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value specifying the type of the menu whose item was clicked.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryFormat">
|
|
<summary>
|
|
<para>Gets or sets the summary value formatting.
|
|
</para>
|
|
</summary>
|
|
<value>A string value representing the summary value formatting. An empty string if the menu was invoked within a column header or group panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryItem">
|
|
<summary>
|
|
<para>Gets a summary item object corresponding to the footer cell whose menu's item was clicked.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object specifying summary settings for the footer cell where the context menu was activated. <b>null</b> (<b>Nothing</b> in Visual Basic) if the context menu was invoked by right-clicking a column header or group panel.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryItems">
|
|
<summary>
|
|
<para>Gets the View's group summary items collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridSummaryItemCollection"/> object representing the View's group summaries collection. <b>null</b> (<b>Nothing</b> in Visual Basic) if the context menu was invoked within a column header or group panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs.SummaryType">
|
|
<summary>
|
|
<para>Gets the summary type which is about to be applied.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value representing the summary item type.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.ViewOperationEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.GridControl.ViewRegistered"/> and <see cref="E:DevExpress.XtraGrid.GridControl.ViewRemoved"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.ViewOperationEventArgs.View">
|
|
<summary>
|
|
<para>Gets the currently processed View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> class descendant that represents the currently processed View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.ViewFocusEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.GridControl.FocusedViewChanged"/> event.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.ViewFocusEventHandler.Invoke(System.Object,DevExpress.XtraGrid.ViewFocusEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.GridControl.FocusedViewChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the grid control that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.ViewFocusEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.ViewFocusEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.GridControl.FocusedViewChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.ViewFocusEventArgs.#ctor(DevExpress.XtraGrid.Views.Base.BaseView,DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.ViewFocusEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="previousView">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object representing the previously focused View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.ViewFocusEventArgs.PreviousView"/> property.
|
|
|
|
</param>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object representing the currently focused View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.ViewFocusEventArgs.View"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.ViewFocusEventArgs.PreviousView">
|
|
<summary>
|
|
<para>Gets a value representing the previously focused View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the previously focused View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.ViewFocusEventArgs.View">
|
|
<summary>
|
|
<para>Gets a value representing the currently focused View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the currently focused View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.FilterControlEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FilterEditorCreated"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.FilterControlEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.FilterControlEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FilterEditorCreated"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.FilterControlEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.BaseViewAppearanceCollection">
|
|
|
|
<summary>
|
|
<para>Serves as the base for the classes that provide the appearance settings used to paint the View elements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseViewAppearanceCollection.#ctor(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.BaseViewAppearanceCollection"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will own the created collection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseViewAppearanceCollection.IsLoading">
|
|
<summary>
|
|
<para>Indicates whether the View that owns the current collection is currently being initialized.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is being initialized; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseViewAppearanceCollection.ToString">
|
|
<summary>
|
|
<para>Gets the object's text representation.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that specifies the object's text representation.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowIndicator"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowIndicator"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowIndicator"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,System.Int32,DevExpress.Utils.Drawing.ObjectPainter,DevExpress.Utils.Drawing.IndicatorObjectInfoArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventArgs"/> class with the specified parameters.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object which specifies the storage for the most often used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value which represents the handle of the row whose indicator cell is being painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
A <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> descendant which provides the default painting mechanism for the painted element. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.Utils.Drawing.IndicatorObjectInfoArgs"/> object providing information about the painted element. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventArgs.Info"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowIndicatorCustomDrawEventArgs.Info">
|
|
<summary>
|
|
<para>Gets information about the painted row indicator.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.Drawing.IndicatorObjectInfoArgs"/> object which provides information about the painted indicator cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawColumnHeader"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawColumnHeader"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawColumnHeader"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,DevExpress.Utils.Drawing.HeaderObjectPainter,DevExpress.XtraGrid.Drawing.GridColumnInfoArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="painter">
|
|
An <see cref="T:DevExpress.Utils.Drawing.ObjectPainter"/> object that provides default painting facilities. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Painter"/> property.
|
|
|
|
</param>
|
|
<param name="info">
|
|
A <see cref="T:DevExpress.Utils.Drawing.StyleObjectInfoArgs"/> object that contains the View information about the element being painted. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawObjectEventArgs.Info"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs.Column">
|
|
<summary>
|
|
<para>Returns the <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> whose header is to be drawn.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> whose header is to be drawn.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ColumnHeaderCustomDrawEventArgs.Info">
|
|
<summary>
|
|
<para>Gets an object providing information necessary to paint a column header.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Drawing.GridColumnInfoArgs"/> object providing appearance and state information about a column header.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.ScrollStyleFlags">
|
|
|
|
<summary>
|
|
<para>Lists values specifying a View's scrollbar behavior.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ScrollStyleFlags.LiveHorzScroll">
|
|
<summary>
|
|
<para>If active, the View is scrolled simultaneously with changing its horizontal scrollbar's position. Otherwise, the actual View scrolling takes place only when the scrollbar's thumb is released.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ScrollStyleFlags.LiveVertScroll">
|
|
<summary>
|
|
<para><para>If active, the View is scrolled simultaneously with changing its vertical scrollbar's position. Otherwise, the actual View scrolling takes place only when the scrollbar's thumb is released.</para>
|
|
|
|
<para>When this option is disabled, you can enable the vertical scrollbar's tooltip. The tooltip's text allows end-users to identify the row corresponding to the current scrollbar's position. If the current scrollbar's position corresponds to a group row, the group row's text is displayed by the tooltip. If the target row is a data row, the tooltip displays a value from this row's particular field. The field is specified by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridView.VertScrollTipFieldName"/> property.</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ScrollStyleFlags.None">
|
|
<summary>
|
|
<para>If active, disables all other options.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawCell"/>, <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldCaption"/>, <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardField"/> and <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldValue"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawCell"/>, <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldCaption"/>, <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardField"/> and <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldValue"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawCell"/>, <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardField"/>, <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldCaption"/>, and <see cref="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldValue"/> events.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,System.Drawing.Rectangle,DevExpress.Utils.AppearanceObject,System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Object,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="bounds">
|
|
A <see cref="T:System.Drawing.Rectangle"/> structure that specifies the boundaries of the painted element. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Bounds"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint a cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value identifying the row in which the painted element resides. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.RowHandle"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column containing the painted data cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="cellValue">
|
|
An object representing the painted cell's value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.CellValue"/> property.
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A string value that represents the painted cell's display text. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.DisplayText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.Cell">
|
|
<summary>
|
|
<para>Provides information on the painted cell.
|
|
</para>
|
|
</summary>
|
|
<value>A DevExpress.XtraGrid.Views.Grid.ViewInfo.GridCellInfo object that contains information about the painted cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.CellValue">
|
|
<summary>
|
|
<para>Gets the painted cell's value.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the painted cell's value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column whose element is being painted.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column whose data cell is being painted. <b>null</b> (<b>Nothing</b> in Visual Basic) if the painted element has no corresponding column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.DisplayText">
|
|
<summary>
|
|
<para>Gets or sets the painted element's display text.
|
|
</para>
|
|
</summary>
|
|
<value>A string value representing the element's display text.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of a painted element's row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value identifying the row that corresponds to the painted element.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomDrawEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawGroupPanel"/> and <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawEmptyForeground"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomDrawEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawGroupPanel"/> and <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawEmptyForeground"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. This parameter identifies the View which raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawGroupPanel"/> and <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawEmptyForeground"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.#ctor(DevExpress.Utils.Drawing.GraphicsCache,System.Drawing.Rectangle,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="cache">
|
|
A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object that specifies the storage for the most used pens, fonts and brushes. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache"/> property.
|
|
|
|
</param>
|
|
<param name="bounds">
|
|
A <see cref="T:System.Drawing.Rectangle"/> structure that represents the painted element's bounding rectangle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Bounds"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that specifies the painted element's appearance settings. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Appearance">
|
|
<summary>
|
|
<para>Gets the painted element's appearance settings.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object specifying the painted element's appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Bounds">
|
|
<summary>
|
|
<para>Returns a value specifying limits for the drawing area.
|
|
</para>
|
|
</summary>
|
|
<value>A <b>Rectangle</b> specifying the drawing area.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Cache">
|
|
<summary>
|
|
<para>Gets an object which specifies the storage for the most often used pens, fonts and brushes.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Graphics">
|
|
<summary>
|
|
<para>Gets an object used to paint.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Graphics"/> object providing a means for painting.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomDrawEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether an event was handled and that the default actions are therefore not required.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the default actions are not required; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ScrollVisibility">
|
|
|
|
<summary>
|
|
<para>Lists values specifying the availability of View elements that enable data scrolling.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ScrollVisibility.Always">
|
|
<summary>
|
|
<para>The scrolling element is always visible.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ScrollVisibility.Auto">
|
|
<summary>
|
|
<para>The scrolling element is visible only when data scrolling can be performed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ScrollVisibility.Never">
|
|
<summary>
|
|
<para>The scrolling element is invisible regardless of whether data scrolling can be performed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowHeightEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CalcRowHeight"/> event of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowHeightEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CalcRowHeight"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CalcRowHeight"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the row's handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="rowHeight">
|
|
An integer value specifying the row's height in pixels. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs.RowHeight"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row whose height is to be specified.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the row's handle.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowHeightEventArgs.RowHeight">
|
|
<summary>
|
|
<para>Gets or sets the row's height.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the row height in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupLevelStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupLevelStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupLevelStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs.#ctor(System.Int32,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs"/> class with the specified level and appearance.
|
|
</para>
|
|
</summary>
|
|
<param name="level">
|
|
An integer value specifying the level of the processed group row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs.Level"/> property.
|
|
|
|
</param>
|
|
<param name="levelAppearance">
|
|
A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance setting used to paint the group rows residing at the processed nesting level. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs.LevelAppearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs.Level">
|
|
<summary>
|
|
<para>Gets the nesting level of group rows whose style is to be specified.
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer value representing the row nesting level.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GroupLevelStyleEventArgs.LevelAppearance">
|
|
<summary>
|
|
<para>Gets the appearance settings applied to the group rows located at the current nesting level.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance setting used to paint the group rows residing at the nesting level currently being processed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.InvalidRowException"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.InvalidRowException"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.InvalidRowException"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs.#ctor(System.Exception,System.String,System.Int32,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the InvalidRowExceptionEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="except">
|
|
A <see cref="T:System.Exception"/> object representing the exception which caused this event to be raised. This value is assigned to the <see cref="P:DevExpress.XtraEditors.Controls.ExceptionEventArgs.Exception"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="errorText">
|
|
A string value representing the error message box text. This value is assigned to the <see cref="P:DevExpress.XtraEditors.Controls.ExceptionEventArgs.ErrorText"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row that failed validation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="row">
|
|
An object representing the row that failed validation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs.Row"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs.Row">
|
|
<summary>
|
|
<para>Gets an object which represents the row that failed validation.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the row that failed validation.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.InvalidRowExceptionEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row that failed validation.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the handle of the row that failed validation.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellStyle"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraGrid.Views.Base.GridRowCellState,DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the row whose cell's style is to be set. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column that owns the cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridRowCellState"/> enumeration value which specifies the row's state.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs.Appearance"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs.Appearance">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the data cell currently being processed.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that provides the appearance settings used to paint the cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowCellStyleEventArgs.CombineAppearance(DevExpress.Utils.AppearanceObject)">
|
|
<summary>
|
|
<para>Copies the activated settings of the appearance object passed as the parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="appearance">
|
|
An <see cref="T:DevExpress.Utils.AppearanceObject"/> object that represents the source of the operation.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowCellDefaultAlignment"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowCellDefaultAlignment"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowCellDefaultAlignment"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Utils.HorzAlignment)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the row owning the cell by its handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column that contains the cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="horzAlignment">
|
|
A <see cref="T:DevExpress.Utils.HorzAlignment"/> enumeration value specifying the cell content's horizontal alignment. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventArgs.HorzAlignment"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.RowCellAlignmentEventArgs.HorzAlignment">
|
|
<summary>
|
|
<para>Gets or sets the cell content's default horizontal alignment.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.HorzAlignment"/> enumeration member specifying the cell content's default horizontal alignment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridMenuEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.PopupMenuShowing"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridMenuEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.GridMenuEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.PopupMenuShowing"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event sender. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridMenuEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the menu processing events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridMenuEventArgs.#ctor(DevExpress.XtraGrid.Views.Grid.GridMenuType,DevExpress.XtraGrid.Menu.GridViewMenu,DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridMenuEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="menuType">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value specifying the type of the invoked Grid View's context menu. This value is assigned to the MenuType property.
|
|
|
|
</param>
|
|
<param name="menu">
|
|
A <see cref="T:DevExpress.XtraGrid.Menu.GridViewMenu"/> object which represents the Grid View's context menu. This value is assigned to the Menu property.
|
|
|
|
</param>
|
|
<param name="hitInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object which contains information about the View elements located at the point where an end-user has right-clicked to invoke the context menu. This value is assigned to the HitInfo property.
|
|
|
|
</param>
|
|
<param name="allow">
|
|
<b>true</b> to display the context menu; otherwise, <b>false</b>. This value is assigned to the Allow property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridMenuEventArgs.#ctor(DevExpress.XtraGrid.Views.Grid.GridMenuType,DevExpress.XtraGrid.Menu.GridViewMenu,System.Drawing.Point,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridMenuEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="menuType">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuType"/> enumeration value specifying the type of the invoked Grid View's context menu. This value is assigned to the MenuType property.
|
|
|
|
</param>
|
|
<param name="menu">
|
|
A <see cref="T:DevExpress.XtraGrid.Menu.GridViewMenu"/> object which represents the Grid View's context menu. This value is assigned to the Menu property.
|
|
|
|
</param>
|
|
<param name="point">
|
|
A <see cref="T:System.Drawing.Point"/> structure which specifies the point where an end-user has right-clicked to invoke the context menu. This value is assigned to the Point property.
|
|
|
|
</param>
|
|
<param name="allow">
|
|
<b>true</b> to display the context menu; otherwise, <b>false</b>. This value is assigned to the Allow property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridMenuEventArgs.#ctor(DevExpress.XtraGrid.Menu.GridViewMenu,DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo)">
|
|
<summary>
|
|
<para>Initializes a new instance of the GridMenuEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="menu">
|
|
A <see cref="T:DevExpress.XtraGrid.Menu.GridViewMenu"/> object which represents the Grid View's context menu. This value is assigned to the Menu property.
|
|
|
|
</param>
|
|
<param name="hitInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object which contains information about the View elements located at the point where an end-user has right-clicked to invoke the context menu. This value is assigned to the HitInfo property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupListBox"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupListBox"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupListBox"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraEditors.Repository.RepositoryItemComboBox)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column whose Filter DropDown is about to be invoked. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="comboBox">
|
|
A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemComboBox"/> object providing access to the filter items list. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs.ComboBox"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column whose filter dropdown is about to be displayed.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column whose filter dropdown is about to be displayed.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs.ComboBox">
|
|
<summary>
|
|
<para>Gets an object providing access to the filter dropdown's items.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItemComboBox"/> object that allows you to access the filter items list.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.FilterItem">
|
|
|
|
<summary>
|
|
<para>Represents an individual item within a filter dropdown list.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterItem.#ctor(System.String,System.Object)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.FilterItem"/> object.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="text">
|
|
A <see cref="T:System.String"/> value that is the textual representation of the created filter item. This value is assigned to the <see cref="F:DevExpress.XtraGrid.Views.Grid.FilterItem.Text"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="val">
|
|
An object representing the filter value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.FilterItem.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.FilterItem.Text">
|
|
<summary>
|
|
<para>Specifies the text representing the filter item within the filter dropdown list.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>$
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.FilterItem.ToString">
|
|
<summary>
|
|
<para>Returns the filter item's textual representation.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that is the textual representation of the current filter item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.FilterItem.Value">
|
|
<summary>
|
|
<para>Gets the filter value represented by the current filter item.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the filter value defined by the filter item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs">
|
|
|
|
<summary>
|
|
<para>Serves as the base for classes that provide data for cell events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle or the row that contains the processed cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column that contains the processed cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.CellValue">
|
|
<summary>
|
|
<para>Returns the value of the currently processed cell.
|
|
</para>
|
|
</summary>
|
|
<value>An object that specifies the current cell's value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column that contains the processed cell.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (descendant) representing the column that contains the cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row that contains the processed cell.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the handle of the row that contains the cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomRowCellEdit"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomRowCellEdit"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomRowCellEdit"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row that contains the processed cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column that contains the processed cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraEditors.Repository.RepositoryItem)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row that contains the processed cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column that contains the processed cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="repositoryItem">
|
|
A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> object representing the editor assigned to the processed cell. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs.RepositoryItem"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs.RepositoryItem">
|
|
<summary>
|
|
<para>Gets or sets the editor assigned to the processed cell.
|
|
</para>
|
|
</summary>
|
|
<value>The <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomRowCellEditEventArgs.RepositoryItem"/> object which represents the currently assigned editor.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationName"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationName"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationName"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs.#ctor(System.Int32,System.Int32,System.String)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the master row's handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
An integer value identifying the relation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RelationIndex"/> property.
|
|
|
|
</param>
|
|
<param name="relationName">
|
|
A string value specifying the level whose corresponding View will represent the relation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs.RelationName"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs.RelationName">
|
|
<summary>
|
|
<para>For the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationName"/> event this property gets or sets the name of the level whose bound View will be used to represent the currently processed detail's data.
|
|
|
|
<para>
|
|
For the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationDisplayCaption"/> event this property gets or sets the display caption for the currently processed relation.
|
|
</para>
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the name (or display name for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationDisplayCaption"/> event) of the level for the currently processed relation.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationCount"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationCount"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationCount"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the master row's handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="relationCount">
|
|
An integer value specifying the number of relations for the master row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs.RelationCount"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs.RelationCount">
|
|
<summary>
|
|
<para>Gets or sets the number of relations for the master row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the number of relations for the master row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets a value identifying a master row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the handle of the master row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetLevelDefaultView"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetLevelDefaultView"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetLevelDefaultView"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventArgs.#ctor(System.Int32,System.Int32,DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the master row's handle. This property is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
An integer value identifying the detail by its relation index. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RelationIndex"/> property.
|
|
|
|
</param>
|
|
<param name="defaultView">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that will be used to display the detail. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventArgs.DefaultView"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventArgs.DefaultView">
|
|
<summary>
|
|
<para>Gets or sets a pattern view to represent the detail View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant that will be used to represent the detail's data.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetChildList"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetChildList"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs"/> object that event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetChildList"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs.#ctor(System.Int32,System.Int32,System.Collections.IList)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the master row's handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
An integer value identifying the detail clone by its relation index. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RelationIndex"/> property.
|
|
|
|
</param>
|
|
<param name="childList">
|
|
An object implementing the <see cref="T:System.Collections.IList"/> interface and containing the detail's records list. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs.ChildList"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs.ChildList">
|
|
<summary>
|
|
<para>Gets or sets a detail clone's record list.
|
|
</para>
|
|
</summary>
|
|
<value>An object implementing the <see cref="T:System.Collections.IList"/> interface and containing records for the detail clone.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowEmpty"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowEmpty"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowEmpty"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventArgs.#ctor(System.Int32,System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the master row's handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
An integer value identifying the detail View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RelationIndex"/> property.
|
|
|
|
</param>
|
|
<param name="isEmpty">
|
|
<b>true</b> if the specified detail clone has no data; otherwise, <b>false</b>. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventArgs.IsEmpty"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.MasterRowEmptyEventArgs.IsEmpty">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether a detail contains data.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to indicate that the detail has no data; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowExpanding"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowCollapsing"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowExpanding"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowCollapsing"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventArgs"/> class instance that contains the event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowExpanding"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowCollapsing"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventArgs.#ctor(System.Int32,System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The row handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
The relation index. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RelationIndex"/> property.
|
|
|
|
</param>
|
|
<param name="allow">
|
|
Indicates whether a row can be expanded. <b>true</b>, if a row can be expanded; otherwise, <b>false</b>. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventArgs.Allow"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.MasterRowCanExpandEventArgs.Allow">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the current operation is allowed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to allow the expanding/collapsing operation; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs">
|
|
|
|
<summary>
|
|
<para>Serves as the base for event arguments that require detail identification capabilities.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing a processed row handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CustomRowCellEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
An integer value specifying the relation index that identifies the affected detail. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RelationIndex"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RelationIndex">
|
|
<summary>
|
|
<para>Gets the relation index that identifies the affected detail.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the relation index.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the affected master row handle.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing a row handle.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomFilterDialog"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomFilterDialog"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. This parameter identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs"/> class instance that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomFilterDialog"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraGrid.Columns.ColumnFilterInfo)">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column to be filtered using the custom filter dialog. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="filterInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object specifying the filter criteria to be applied to the column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs.FilterInfo"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column to be filtered using custom filter criteria.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column for which the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomFilterDialog"/> event occurred.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs.FilterInfo">
|
|
<summary>
|
|
<para>Gets or sets an object specifying custom filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object specifying the filter criteria to be applied.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the custom filter dialog should be invoked.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to suppress the standard custom filter dialog; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CustomFilterDialogEventArgs.UseAsteriskAsWildcard">
|
|
<summary>
|
|
<para>Gets or sets whether the asterisk ('*') character can be used as a wildcard character.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the asterisk ('*') character can be used as a wildcard character; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.DrawFocusRectStyle">
|
|
|
|
<summary>
|
|
<para>Contains values specifying how the focus rectangle is painted within Grid Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.DrawFocusRectStyle.CellFocus">
|
|
<summary>
|
|
<para>The focus rectangle is painted around the focused cell.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.DrawFocusRectStyle.None">
|
|
<summary>
|
|
<para>The focus rectangle is not painted.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.DrawFocusRectStyle.RowFocus">
|
|
<summary>
|
|
<para>The focus rectangle is painted around the focused row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomCardCaptionImage"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventArgs.#ctor(System.Int32,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the LayoutViewCardCaptionImageEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the current card. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="list">
|
|
An object that represents an image list. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Card.CardCaptionImageEventArgs.ImageList"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventArgs.CaptionImageLocation">
|
|
<summary>
|
|
<para>Gets or sets the relative position of an image within a card's caption.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.GroupElementLocation"/> value that specifies the image's position.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCardCaptionImageEventArgs.CaptionImageVisible">
|
|
<summary>
|
|
<para>Gets or sets whether the image in a card's caption is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the caption image is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowClickEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowClick"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.RowClickEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.RowClickEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellClick"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.RowClickEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo">
|
|
|
|
<summary>
|
|
<para>Contains information about a specific point within a Card View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo"/> class instance.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.Clear">
|
|
<summary>
|
|
<para>Sets all properties to their default values.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.Column">
|
|
<summary>
|
|
<para>Gets or sets the column located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column that contains the test point. <b>null</b> (<b>Nothing</b> in Visual Basic) if the test point is over a visual element (card, card caption, separator, etc.) which does not belong to any column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.HitTest">
|
|
<summary>
|
|
<para>Gets or sets a value identifying the type of the visual element located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest"/> enumeration value identifying the type of the visual element located under the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.InCard">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a card.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a card; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.InCardButtons">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a card scroll button.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a card scroll button; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.InCardCaption">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a card caption.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a card caption; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.InField">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a card field.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a card field; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.InFilterPanel">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a filter panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a filter panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.IsEquals(DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo)">
|
|
<summary>
|
|
<para>Indicates whether the specified card hit object is equal to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo"/> object to be compared with the current card hit info object.
|
|
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified object equals the current object; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo.RowHandle">
|
|
<summary>
|
|
<para>Gets or sets a value identifying the card that contains the test point.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the handle of the card that contains the test point. <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> if no card is located under the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest">
|
|
|
|
<summary>
|
|
<para>Lists values identifying Card View's visual elements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.Card">
|
|
<summary>
|
|
<para>The test point belongs to a card's area not occupied by card constituent elements (in other words, the point belongs to a card's edge).
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.CardCaption">
|
|
<summary>
|
|
<para>The test point belongs to a card's caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.CardCaptionErrorIcon">
|
|
<summary>
|
|
<para>The test point belongs to an error icon displayed within a card caption. Such error icons are displayed when cards fail to be validated.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.CardDownButton">
|
|
<summary>
|
|
<para>The test point belongs to a bottom card scroll button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.CardExpandButton">
|
|
<summary>
|
|
<para>The test point belongs to the card expand button that resides within the card caption and is used to expand/collapse the card.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.CardUpButton">
|
|
<summary>
|
|
<para>The test point belongs to a top card scroll button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.CloseZoomButton">
|
|
<summary>
|
|
<para>The test point belongs to a Card View's zoom button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.Field">
|
|
<summary>
|
|
<para>The test point belongs to a card field's area which is not occupied by the field caption or field value cell (in other words, the point belongs to a field edge).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FieldCaption">
|
|
<summary>
|
|
<para>The test point belongs to a field caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FieldValue">
|
|
<summary>
|
|
<para>The test point belongs to a field value cell.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FilterPanel">
|
|
<summary>
|
|
<para>The test point belongs to a filter panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FilterPanelActiveButton">
|
|
<summary>
|
|
<para>The test point belongs to the check box in the filter panel used to enable/disable filtering within a Card View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FilterPanelCloseButton">
|
|
<summary>
|
|
<para>The test point belongs to a filter panel close button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FilterPanelCustomizeButton">
|
|
<summary>
|
|
<para>The test point belongs to the filter panel customize button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FilterPanelMRUButton">
|
|
<summary>
|
|
<para>The test point belongs to a button in the filter panel used to display a dropdown window with a list of the most recently used filter criteria.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.FilterPanelText">
|
|
<summary>
|
|
<para>The test point belongs to a string in the filter panel which represents the filter criteria applied to a Card View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.MasterTabPageHeader">
|
|
<summary>
|
|
<para>The test point belongs to the View's master-detail tab.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.None">
|
|
<summary>
|
|
<para>The test point does not belong to any Card View visual element or is outside the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.QuickCustomizeButton">
|
|
<summary>
|
|
<para>The test point belongs to the customization button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.Separator">
|
|
<summary>
|
|
<para>The test point belongs to a card separator.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitTest.ViewCaption">
|
|
<summary>
|
|
<para>The test point belongs to the View Caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo">
|
|
|
|
<summary>
|
|
<para>Contains information about a specific point within a Grid View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> class instance.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.Clear">
|
|
<summary>
|
|
<para>Sets all properties to their default values.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.Column">
|
|
<summary>
|
|
<para>Gets or sets a column located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column that contains the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.FooterCell">
|
|
<summary>
|
|
<para>Gets or sets an object that contains view information on a footer cell (if the test point belongs to a footer cell).
|
|
</para>
|
|
</summary>
|
|
<value>A GridFooterCellInfoArgs object that contains information on a footer cell. <b>null</b> if the test point doesn't belong to a footer cell.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.HitTest">
|
|
<summary>
|
|
<para>Gets or sets a value identifying the type of a visual element located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest"/> enumeration value identifying the type of a visual element that contains the test point.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.InColumn">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a column header.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a column header; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.InColumnPanel">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within the Column Header Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within the column header panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.InFilterPanel">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within the filter panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within the filter panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.InGroupColumn">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is over a column header displayed within the Group Panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a grouping column's header; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.InGroupPanel">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within the group panel.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within the group panel; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.InRow">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a row (data row or group row).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a row; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.InRowCell">
|
|
<summary>
|
|
<para>Gets a value indicating whether the test point is within a cell.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the test point is within a cell; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo.RowHandle">
|
|
<summary>
|
|
<para>Gets or sets the handle of the row located under the test point.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the handle of the row located under the test point.
|
|
The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value if the test point doesn't belong to any row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest">
|
|
|
|
<summary>
|
|
<para>Lists values identifying a Grid View's visual elements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.CellButton">
|
|
<summary>
|
|
<para>The test point belongs to a master-detail expand button which can be used to open/close details.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.Column">
|
|
<summary>
|
|
<para>The test point belongs to a column header.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.ColumnButton">
|
|
<summary>
|
|
<para>The test point belongs to the header panel button.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.ColumnEdge">
|
|
<summary>
|
|
<para>The test point belongs to the right edge of a column header. End-users can drag these edges to resize columns horizontally (the desired column's <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowSize"/> option must be enabled for this purpose).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.ColumnFilterButton">
|
|
<summary>
|
|
<para>The test point belongs to a filter button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.ColumnPanel">
|
|
<summary>
|
|
<para>The test point belongs to the column header panel's area not occupied by column headers.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.CustomizationForm">
|
|
<summary>
|
|
<para>The test point belongs to the customization form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.EmptyRow">
|
|
<summary>
|
|
<para>The test point is below all rows.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FilterPanel">
|
|
<summary>
|
|
<para>The test point belongs to the filter panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FilterPanelActiveButton">
|
|
<summary>
|
|
<para>The test point belongs to the button in the filter panel used to activate filtering within a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FilterPanelCloseButton">
|
|
<summary>
|
|
<para>The test point belongs to the filter close button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FilterPanelCustomizeButton">
|
|
<summary>
|
|
<para>The test point belongs to the filter panel customize button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FilterPanelMRUButton">
|
|
<summary>
|
|
<para>The test point belongs to the button in the filter panel used to display a dropdown window with a list of the most recently used filter criteria.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FilterPanelText">
|
|
<summary>
|
|
<para>The test point belongs to a string in the filter panel which represents the filter criteria applied to a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FixedLeftDiv">
|
|
<summary>
|
|
<para>The test point belongs to the left fixed line.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.FixedRightDiv">
|
|
<summary>
|
|
<para>The test point belongs to the right fixed line.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.Footer">
|
|
<summary>
|
|
<para>The test point belongs to the view footer.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.GroupPanel">
|
|
<summary>
|
|
<para>The test point belongs to the group panel.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.GroupPanelColumn">
|
|
<summary>
|
|
<para>The test point belongs to a column header displayed within the group panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.GroupPanelColumnFilterButton">
|
|
<summary>
|
|
<para>The test point belongs to the filter button displayed by a column header that resides within the group panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.HScrollBar">
|
|
<summary>
|
|
<para>The test point belongs to the View's horizontal scroll bar.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.MasterTabPageHeader">
|
|
<summary>
|
|
<para>The test point belongs to the View's master-detail tab.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.None">
|
|
<summary>
|
|
<para>The test point does not belong to any View visual element or is outside the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.Row">
|
|
<summary>
|
|
<para>The test point belongs to either a group row or a data row's area not occupied by data cells.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowCell">
|
|
<summary>
|
|
<para>The test point belongs to a row cell.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowDetail">
|
|
<summary>
|
|
<para>The test point belongs to a detail section.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowDetailEdge">
|
|
<summary>
|
|
<para>The test point belongs to the detail section's bottom edge. The edge can be dragged to resize the detail section vertically.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowDetailIndicator">
|
|
<summary>
|
|
<para>The test point belongs to an indicator panel cell corresponding to a detail section.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowEdge">
|
|
<summary>
|
|
<para>The test point belongs to the bottom edge of a data row. The edge can be dragged to resize the row vertically (if the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowRowSizing"/> option is active).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowFooter">
|
|
<summary>
|
|
<para>The test point belongs to a group footer.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowGroupButton">
|
|
<summary>
|
|
<para>The test point belongs to a group expand button.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowIndicator">
|
|
<summary>
|
|
<para>The test point belongs to an indicator panel cell corresponding to a data row or group row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.RowPreview">
|
|
<summary>
|
|
<para>The test point belongs to a preview section.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.ViewCaption">
|
|
<summary>
|
|
<para>The test point belongs to the View Caption.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.VScrollBar">
|
|
<summary>
|
|
<para>The test point belongs to the View's vertical scroll bar.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridView">
|
|
|
|
<summary>
|
|
<para>Represents a View displaying data in a tabular form.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> object with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.#ctor(DevExpress.XtraGrid.GridControl)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/> object with the specified owner control.
|
|
</para>
|
|
</summary>
|
|
<param name="ownerGrid">
|
|
A <see cref="T:DevExpress.XtraGrid.GridControl"/> object representing the grid control that will own the new View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.GridControl"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.AddUnboundColumn(System.String,System.String)">
|
|
<summary>
|
|
<para>Creates an unbound column with the specified name and display caption and opens the Expression Editor to allow an end-user to specify an expression for the column.
|
|
</para>
|
|
</summary>
|
|
<param name="columnName">
|
|
A string to be assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.Name"/> property.
|
|
|
|
</param>
|
|
<param name="caption">
|
|
The column's display caption. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.Caption"/> property.
|
|
|
|
</param>
|
|
<returns>The created unbound column. <b>null</b> if an end-user didn't specify an expression for the column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.AddUnboundColumn">
|
|
<summary>
|
|
<para>Creates an unbound column with an empty display caption and opens the Expression Editor to allow an end-user to specify an expression for the column.
|
|
</para>
|
|
</summary>
|
|
<returns>The created unbound column. <b>null</b> if an end-user didn't specify an expression for the column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.AfterPrintRow">
|
|
<summary>
|
|
<para>Fires after an individual row has been printed/exported, and allows you to add custom information to the printout/export output.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.Appearance">
|
|
<summary>
|
|
<para>Provides access to the properties that control the appearance of the Grid View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridViewAppearances"/> object providing appearance settings for View elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.AppearancePrint">
|
|
<summary>
|
|
<para>Provides access to the properties that specify the appearances of the Grid View's elements when they are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridViewPrintAppearances"/> object that provides appearance settings for the Grid View's elements when they are printed/exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.Assign(DevExpress.XtraGrid.Views.Base.BaseView,System.Boolean)">
|
|
<summary>
|
|
<para>Copies property values and, optionally, event handlers from the View specified as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="v">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose settings should be copied to the current View.
|
|
|
|
</param>
|
|
<param name="copyEvents">
|
|
<b>true</b> to copy event handlers; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.BeforePrintRow">
|
|
<summary>
|
|
<para>Fires before printing/exporting each individual row, and allows you to add custom information to the printout/export output, and prevent a row from being printed/exported.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.BeginSummaryUpdate">
|
|
<summary>
|
|
<para>Prevents summaries from being calculated until the <see cref="M:DevExpress.XtraGrid.Views.Grid.GridView.EndSummaryUpdate"/> method is called.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.BestFitColumns">
|
|
<summary>
|
|
<para>Adjusts the width of columns so that columns fit their contents in an optimal way.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.BestFitMaxRowCount">
|
|
<summary>
|
|
<para>Gets or sets the number of data rows whose contents are processed to apply best fit to columns.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the number of data rows that are processed to apply best fit to columns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CalcHitInfo(System.Drawing.Point)">
|
|
<summary>
|
|
<para>Returns information about View elements located at a specified point.
|
|
</para>
|
|
</summary>
|
|
<param name="pt">
|
|
A <see cref="T:System.Drawing.Point"/> structure specifying test point coordinates relative to the grid control's top-left corner.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object that contains information about View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CalcHitInfo(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns information about the View elements located at the specified point.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="x">
|
|
An integer representing the X coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<param name="y">
|
|
An integer representing the Y coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object that contains information about View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CalcPreviewText">
|
|
<summary>
|
|
<para>Enables you to provide custom text for preview sections.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CalcRowHeight">
|
|
<summary>
|
|
<para>Enables you to specify the height of individual rows.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanCollapseMasterRowEx(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether a master row can be collapsed.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
A zero-based integer identifying the open detail.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the master row can be collapsed; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanDragColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether end-users can drag the specified column's header.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users are allowed to drag the specified column's header; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanExpandMasterRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified master row can be expanded to make its default detail visible.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row being tested by its handle.
|
|
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified master row can be expanded; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanExpandMasterRowEx(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether a master row can be expanded to display a particular detail.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value containing master row handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
An zero-based integer identifying the tested detail by its relation index.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified master row can be expanded; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanGroupColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether end-users can group data by a column's values.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) that represents the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b> end-users can involve the specified column in data grouping; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanResizeColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether the specified column's settings allow end-users to resize the column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can resize the specified column; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanResizeDetailRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the end-users can change the height of the specified master row's detail section.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value containing a master row handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can drag the detail section's bottom edge to resize the section; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanResizeRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether end-users can resize a row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the row by its handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can resize the row; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanShowFilterButton(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether end-users can use a particular column to apply data filtering.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the filter button should be displayed within the specified column's header; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CanSortColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether end-users can sort data by values of a particular column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can sort data by the specified column's values; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CellMerge">
|
|
<summary>
|
|
<para>Provides the ability to customize cell merging behavior.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.ChildGridLevelName">
|
|
<summary>
|
|
<para>Gets or sets the name of the child level whose grouping state is displayed by the joined group panel.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the child level whose grouping state is displayed by the joined group panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ClearGrouping">
|
|
<summary>
|
|
<para>Clears the grouping applied to the View and returns the group columns to display in the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseAllDetails">
|
|
<summary>
|
|
<para>Closes all View's details.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseAllGroups">
|
|
<summary>
|
|
<para>Collapses all groups.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseGroupLevel(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Collapses group rows corresponding to the specified group level. Allows you to collapse group rows recursively.
|
|
</para>
|
|
</summary>
|
|
<param name="groupLevel">
|
|
An integer value that is the group level of group rows to be collapsed.
|
|
|
|
</param>
|
|
<param name="recursive">
|
|
<b>true</b> if child group rows of target group rows must be collapsed as well; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseGroupLevel(System.Int32)">
|
|
<summary>
|
|
<para>Collapses group rows corresponding to the specified group level.
|
|
</para>
|
|
</summary>
|
|
<param name="groupLevel">
|
|
An integer value that is the group level of group rows to be collapsed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseGroupRow(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Collapses the specified group row and optionally any child group rows at all nesting levels.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the group row by its handle. If the specified handle points to a data row this method does nothing.
|
|
|
|
</param>
|
|
<param name="recursive">
|
|
<b>true</b> to collapse any child group rows at all nesting levels; <b>false</b> to preserve the expanded state of any child group rows.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseGroupRow(System.Int32)">
|
|
<summary>
|
|
<para>Collapses the specified group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the group row by its handle. If the specified handle points to a data row this method does nothing.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseMasterRow(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Collapses a specific detail View which belongs to the specific master row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the master row to collapse.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
The index of the master/detail relationship for which a master row is to be collapsed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseMasterRow(System.Int32)">
|
|
<summary>
|
|
<para>Collapses the specified master row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the master row to be collapsed.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CollapseMasterRow(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Collapses a master row's detail View, identified by the name of the relationship associated with it.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationName">
|
|
A string representing the required relationship's name.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.ColumnPanelRowHeight">
|
|
<summary>
|
|
<para>Gets or sets the column header row height.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the column header row height in pixels. <b>-1</b> to calculate this height automatically depending on column header contents.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ColumnsCustomization">
|
|
<summary>
|
|
<para>Invokes the customization form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ColumnsCustomization(System.Drawing.Point)">
|
|
<summary>
|
|
<para>Invokes the customization form at the specified position.
|
|
</para>
|
|
</summary>
|
|
<param name="showPoint">
|
|
A <see cref="T:System.Drawing.Point" /> structure specifying the customization form's top-left corner position. The point is set in screen coordinates.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.ColumnWidthChanged">
|
|
<summary>
|
|
<para>Occurs after a column's width has been changed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.CreateExportLink(DevExpress.XtraExport.IExportProvider)">
|
|
<summary>
|
|
<para>Returns the export link (<b>GridViewExportLink</b>) for the specified <see cref="T:DevExpress.XtraGrid.Views.Grid.GridView"/>.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object that implements the <b>DevExpress.XtraExport.IExportProvider</b> interface that exports data to a particular format.
|
|
|
|
</param>
|
|
<returns>A <b>BaseExportLink</b> descendant (a <b>GridViewExportLink</b> object) providing export facilities.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomColumnGroup">
|
|
<summary>
|
|
<para>Provides the ability to group data using custom rules.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawCell">
|
|
<summary>
|
|
<para>Enables data cells to be painted manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawColumnHeader">
|
|
<summary>
|
|
<para>Enables you to paint column headers manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawFooter">
|
|
<summary>
|
|
<para>Enables you to paint the view footer manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawFooterCell">
|
|
<summary>
|
|
<para>Enables you to paint view footer cells manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawGroupPanel">
|
|
<summary>
|
|
<para>Enables you to paint the group panel manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawGroupRow">
|
|
<summary>
|
|
<para>Enables you to paint group rows manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowFooter">
|
|
<summary>
|
|
<para>Enables you to paint group footers manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowFooterCell">
|
|
<summary>
|
|
<para>Enables you to paint group footer cells manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowIndicator">
|
|
<summary>
|
|
<para>Enables you to custom paint cells within the row indicator panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomDrawRowPreview">
|
|
<summary>
|
|
<para>Enables you to paint preview sections manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.CustomizationForm">
|
|
<summary>
|
|
<para>Provides access to the customization form.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Windows.Forms.Form"/> descendant representing the customization form. <b>null</b> (<b>Nothing</b> in Visual Basic) if the customization form is hidden.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.CustomizationFormBounds">
|
|
<summary>
|
|
<para>Sets the boundaries of the customization form. Reading this property may not return the actual boundaries of the customization form.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Rectangle"/> structure representing the customization form's boundaries.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.CustomizationRowCount">
|
|
<summary>
|
|
<para>Gets or sets the number of headers that can be displayed within the customization form simultaneously.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the number of headers that can be displayed within the customization form.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomRowCellEdit">
|
|
<summary>
|
|
<para>Enables you to assign editors to individual cells.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomRowCellEditForEditing">
|
|
<summary>
|
|
<para>Allows you to assign a custom editor to a column for in-place editing and so override the default column editor, which is by default used both in display and edit modes.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomSummaryCalculate">
|
|
<summary>
|
|
<para>Enables you to calculate summary values manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.CustomSummaryExists">
|
|
<summary>
|
|
<para>Enables you to specify which summaries should be calculated and displayed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.DefaultRelationIndex">
|
|
<summary>
|
|
<para>Gets or sets the value indicating which detail level is processed by default.
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer representing the relation index processed by default.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.DestroyCustomization">
|
|
<summary>
|
|
<para>Closes the customization form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.DetailVerticalIndent">
|
|
<summary>
|
|
<para>Gets or sets the distance between master rows and Detail Sections, in pixels.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the distance between master rows and Detail Sections, in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectDrop">
|
|
<summary>
|
|
<para>Fires immediately after a drag and drop operation on a column header or band header has been completed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectOver">
|
|
<summary>
|
|
<para>Enables you to control whether the dragged column header or band header can be dropped at the current position.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.DragObjectStart">
|
|
<summary>
|
|
<para>Fires when the end-user attempts to drag a column header or band header.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.Editable">
|
|
<summary>
|
|
<para>Determines whether end-users can modify the View's cell values.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can activate cell editors and modify their contents; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.EditingValue">
|
|
<summary>
|
|
<para>Gets or sets the edited cell value.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Object"/> representing the edited cell value. <b>null</b> (<b>Nothing</b> in Visual Basic) if no cell is currently being edited.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.EndSummaryUpdate">
|
|
<summary>
|
|
<para>Forces an immediate summary calculation and re-enables the automatic summary calculation feature.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandAllGroups">
|
|
<summary>
|
|
<para>Expands all groups.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandGroupLevel(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Expands group rows corresponding to the specified group level. Allows you to expand group rows recursively.
|
|
</para>
|
|
</summary>
|
|
<param name="groupLevel">
|
|
An integer value that is the group level of group rows to be expanded.
|
|
|
|
</param>
|
|
<param name="recursive">
|
|
<b>true</b> if child group rows of target group rows must be expanded as well; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandGroupLevel(System.Int32)">
|
|
<summary>
|
|
<para>Expands group rows corresponding to the specified group level.
|
|
</para>
|
|
</summary>
|
|
<param name="groupLevel">
|
|
An integer value that is the group level of group rows to be expanded.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandGroupRow(System.Int32)">
|
|
<summary>
|
|
<para>Expands the specified group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the group row by its handle. If the specified handle points to a data row this method does nothing.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandGroupRow(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Expands the specified group row and optionally any child group rows at all nesting levels.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the group row by its handle. If the specified handle points to a data row this method does nothing.
|
|
|
|
</param>
|
|
<param name="recursive">
|
|
<b>true</b> to expand any child group rows at all nesting levels; <b>false</b> to preserve the expanded state of any child group rows.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandMasterRow(System.Int32)">
|
|
<summary>
|
|
<para>Expands the specified master row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandMasterRow(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Expands the specified detail View, which is identified by its master row and relationship index.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
A zero-based integer identifying the required detail by relation index.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ExpandMasterRow(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Expands the specified master row's detail View, which is identified by the relationship's name.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationName">
|
|
A string representing the required relationship's name.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.FixedLineWidth">
|
|
<summary>
|
|
<para>Gets or sets the width of frozen panel separators.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the width of vertical lines that separate anchored columns and bands from others. The value is set in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.FocusRectStyle">
|
|
<summary>
|
|
<para>Gets or sets a value specifying how the focus rectangle is painted.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.DrawFocusRectStyle"/> enumerator value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.FooterPanelHeight">
|
|
<summary>
|
|
<para>Gets or sets the height of the view footer.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the View footer height in pixels. <b>-1</b> to calculate the View footer height automatically.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetChildRowCount(System.Int32)">
|
|
<summary>
|
|
<para>Returns the number of immediate children for a particular group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the group row by its handle.
|
|
|
|
</param>
|
|
<returns>An integer value representing the number of the specified group row's immediate children. <b>0</b> if the specified row is a data row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetChildRowHandle(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns the handle of a group row's child.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the group row whose immediate child row is to be obtained.
|
|
|
|
</param>
|
|
<param name="childIndex">
|
|
A zero-based integer representing the desired child row's index.
|
|
|
|
</param>
|
|
<returns>An integer value representing the child row handle. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> field value if the specified row is a data row or the specified child row index is invalid.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetDataRowHandleByGroupRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Returns the handle of the first data row within a group.
|
|
</para>
|
|
</summary>
|
|
<param name="groupRowHandle">
|
|
An integer value specifying the group row by its handle.
|
|
|
|
</param>
|
|
<returns>An integer value identifying the data row by its handle.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetDetailView(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Gets the detail View specified by the master row and relation index.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the master row handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
A zero-based integer specifying the relation index.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the obtained detail clone. <b>null</b> (<b>Nothing</b> in Visual Basic) if the specified detail clone does not exist.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetFocusedDisplayText">
|
|
<summary>
|
|
<para>Returns the focused cell's display value.
|
|
</para>
|
|
</summary>
|
|
<returns>A string representing the text displayed within the View's focused cell.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetFocusedValue">
|
|
<summary>
|
|
<para>Returns the focused cell's value.
|
|
</para>
|
|
</summary>
|
|
<returns>An object representing the focused cell's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupRowDisplayText(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Returns the text displayed within a specific group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the group row.
|
|
|
|
</param>
|
|
<param name="fullText">
|
|
<b>true</b> to include the "[#image]" substring in the returned value in the position specified by the <see cref="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupFormat"/> property; otherwise, <b>false</b>
|
|
|
|
</param>
|
|
<returns>The text displayed within a specific group row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupRowDisplayText(System.Int32)">
|
|
<summary>
|
|
<para>Returns the text displayed within a specific group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the group row.
|
|
|
|
</param>
|
|
<returns>The text displayed within a specific group row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupRowPrintValue(System.Int32)">
|
|
<summary>
|
|
<para>Returns the export value corresponding to the specified group row. The value will be exported when exporting the grid View's data as values, not as display text in MS Excel format.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that identifies a group row.
|
|
|
|
</param>
|
|
<returns>An export value corresponding to the specified group row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupRowValue(System.Int32)">
|
|
<summary>
|
|
<para>Gets the value of the specified grouping column by which data is grouped.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the required group row.
|
|
|
|
|
|
</param>
|
|
<returns>The value of the grouping column by which data is grouped.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupRowValue(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Gets the value of a group row in the specified grouping column.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that represents a group row's handle.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents a grouping column.
|
|
|
|
</param>
|
|
<returns>An object that represents the value of a group row in a specific grouping column.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupSummaryDisplayText(System.Int32,DevExpress.XtraGrid.GridGroupSummaryItem)">
|
|
<summary>
|
|
<para>Returns the text representation of the specified group summary's value for a specific data group.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the group row which contains the data rows against which the summary is calculated.
|
|
|
|
</param>
|
|
<param name="summaryItem">
|
|
A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object identifying the required group summary.
|
|
|
|
</param>
|
|
<returns>A string representing the group summary's display text.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupSummaryText(System.Int32)">
|
|
<summary>
|
|
<para>Gets the summary text displayed within a particular group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the group row whose summary text is to be obtained.
|
|
|
|
</param>
|
|
<returns>A string value representing the summary text displayed within the specified group row. An empty string if no summary text is displayed within the row or if the specified row is a data row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupSummaryValue(System.Int32,DevExpress.XtraGrid.GridGroupSummaryItem)">
|
|
<summary>
|
|
<para>Returns the value of a specific group summary for a specific data group.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the group row which contains the data rows against which the summary is calculated.
|
|
|
|
</param>
|
|
<param name="summaryItem">
|
|
A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItem"/> object identifying the required group summary.
|
|
|
|
</param>
|
|
<returns>An object representing the specified group summary's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetGroupSummaryValues(System.Int32)">
|
|
<summary>
|
|
<para>Returns summary values calculated for a particular group.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the desired group by the corresponding group row handle.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.Collections.Hashtable"/> object containing summary values calculated for a particular group.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetMasterRowExpanded(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the master row is expanded.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the required master row.
|
|
|
|
</param>
|
|
<returns><b>true</b>, if a specific master row is expanded, otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetMasterRowExpandedEx(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether a particular detail clone is visible.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the master row.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
A zero-based integer specifying which master row's detail is to be tested.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified detail clone is visible; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetNextVisibleRow(System.Int32)">
|
|
<summary>
|
|
<para>Returns the visible index of the row that follows a specific row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value specifying a specific row's visible index, whose next visible row's index is to be obtained. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value is returned if the <i>rowVisibleIndex</i> parameter is equal to or greater than <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.RowCount"/>.
|
|
|
|
</param>
|
|
<returns>An integer value specifying the following row's visible index.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetParentRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Determines a particular row's parent group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the row whose parent row's handle is to be obtained.
|
|
|
|
</param>
|
|
<returns>The handle of the parent group row for the specified child row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRelationCount(System.Int32)">
|
|
<summary>
|
|
<para>Returns the number of relations for a particular master row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the master row handle.
|
|
|
|
</param>
|
|
<returns>An integer value indicating the number of relations for the specified master row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRelationDisplayName(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns a detail clone's caption.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
A zero-based integer specifying the master row's detail clone by its relation index.
|
|
|
|
</param>
|
|
<returns>A string value representing the detail clone's caption.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRelationIndex(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Gets the index of the specified relationship for the specified master row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the master row handle.
|
|
|
|
</param>
|
|
<param name="relationName">
|
|
A string identifying the name of the required relationship.
|
|
|
|
|
|
</param>
|
|
<returns>An integer representing the zero-based index of the specified relationship; <b>-999999</b> if a relationship with the specified name is not found.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRelationName(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns the name of the level whose associated View represents the specified detail clone.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the master row handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
A zero-based integer specifying the master row's detail whose corresponding level name is to be obtained.
|
|
|
|
</param>
|
|
<returns>A string value representing the level name.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowCellValue(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the specified cell's value in the current View.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing a handle of the row in which the desired cell resides.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing the column that contains the desired cell.
|
|
|
|
</param>
|
|
<returns>An object representing the required cell's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowCellValue(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Returns the value of the specified cell, which is identified by the row handle and field name in the grid's data source.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row in which the desired cell resides.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string representing the field name of the column that contains the required cell. A <see cref="T:System.NullReferenceException"/> exception will be thrown if the underlying data source does not contain a column with the specified field name.
|
|
|
|
</param>
|
|
<returns>An object representing the required cell's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowCellValue(System.Int32,System.String,DevExpress.Data.OperationCompleted)">
|
|
<summary>
|
|
<para>Gets the value of the specified cell in the grid's data source.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that is the handle of the row in which the desired cell resides. For more information on row handles refer to the Identifying Rows and Cards.
|
|
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string that is the field name of the column that contains the required cell. A <b>System.NullReferenceException</b> exception will be thrown if the underlying data source does not contain a column with the specified field name.
|
|
|
|
|
|
</param>
|
|
<param name="completed">
|
|
A <b>DevExpress.Data.OperationCompleted</b> method that will be called when the requested operation is completed. The method's argument will contain the requested value.
|
|
|
|
</param>
|
|
<returns><para>
|
|
An object that is the specified cell's value.
|
|
</para>
|
|
<para>
|
|
<b>null</b> (<b>Nothing</b> in Visual Basic) if the specified row handle doesn't point to any of the rows within the current View or points to a group row.
|
|
</para>
|
|
<para>
|
|
In Instant Feedback Mode (async server mode), an invalid "Non-loaded Value" is returned if the requested cell is not currently loaded.
|
|
</para>
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowCellValue(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Data.OperationCompleted)">
|
|
<summary>
|
|
<para>Returns the specified cell's value in the current View.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that is the handle of the row in which the desired cell resides. For more information on row handles refer to the Identifying Rows and Cards.
|
|
|
|
|
|
</param>
|
|
<param name="column">
|
|
A GridColumn object or descendant specifying the column that contains the desired cell.
|
|
|
|
|
|
</param>
|
|
<param name="completed">
|
|
A <b>DevExpress.Data.OperationCompleted</b> method that will be called when the requested operation is completed. The method's argument will contain the requested value.
|
|
|
|
</param>
|
|
<returns><para>
|
|
An object that is the specified cell's value.
|
|
</para>
|
|
<para>
|
|
<b>null</b> (<b>Nothing</b> in Visual Basic) if the specified row handle doesn't point to any of the rows within the current View or points to a group row.
|
|
</para>
|
|
<para>
|
|
In Instant Feedback Mode (async server mode), an invalid "Non-loaded Value" is returned if the requested cell is not currently loaded.
|
|
</para>
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowExpanded(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether a specific group row is expanded.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the tested row's handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> for expanded group rows. <b>false</b> for collapsed group rows and data rows.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowFooterCellText(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the summary text displayed within a particular row footer cell.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the group row handle. This identifies the row footer whose cell's display text is to be obtained.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column where the desired cell resides.
|
|
|
|
</param>
|
|
<returns>A string value representing the summary text displayed within the specified row footer cell.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowLevel(System.Int32)">
|
|
<summary>
|
|
<para>Returns the row's group level.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value the row by its handle.
|
|
|
|
</param>
|
|
<returns>A zero-based integer representing the row's group level.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowPreviewDisplayText(System.Int32)">
|
|
<summary>
|
|
<para>Gets the text displayed within a row's preview section.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the row whose preview section's content is to be obtained.
|
|
|
|
</param>
|
|
<returns>A string value representing the text displayed within the specified preview section.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetRowSummaryItem(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns a key-and-value pair representing the summary item and its value calculated for a particular group footer cell.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying a group row handle. This identifies the group whose footer contains the desired cell.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column where the desired cell resides.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.Collections.DictionaryEntry"/> object whose key is the summary item and value is the summary value. An empty dictionary entry if the specified row footer cell doesn't have the corresponding summary item.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetSelectedCells(System.Int32)">
|
|
<summary>
|
|
<para>Returns the columns where the selected cells in the specified row reside.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which identifies the row.
|
|
|
|
</param>
|
|
<returns>An array of <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> objects that contain the selected cells in the specified row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetSelectedCells">
|
|
<summary>
|
|
<para>Returns the selected cells.
|
|
</para>
|
|
</summary>
|
|
<returns>An array of <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> objects that represent selected cells.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetShowEditorMode">
|
|
<summary>
|
|
<para>Returns a value that specifies how an in-place editor is activated for a grid cell.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.Utils.EditorShowMode"/> enumeration value which specifies how a cell editor is activated.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetSummaryFormat(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.Data.SummaryItemType)">
|
|
<summary>
|
|
<para>Gets the summary format for the specified column and summary type.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object for which the summary format is to be returned.
|
|
|
|
</param>
|
|
<param name="sumType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> value that identifies the summary type.
|
|
|
|
</param>
|
|
<returns>A string that specifies the summary format for the specified column and summary type.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetVisibleDetailRelationIndex(System.Int32)">
|
|
<summary>
|
|
<para>Determines which of the master row's details is currently visible.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the master row's handle.
|
|
|
|
</param>
|
|
<returns>A zero-based integer identifying the opened detail. <b>-1</b> if the master row is collapsed (i.e. none of the detail Views are visible).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetVisibleDetailView(System.Int32)">
|
|
<summary>
|
|
<para>Gets the master row's detail that is currently visible.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the master row whose visible detail is to be obtained.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the detail clone currently visible. <b>null</b> (<b>Nothing</b> in Visual Basic) if the specified master row is collapsed (no details are currently visible).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetVisibleIndex(System.Int32)">
|
|
<summary>
|
|
<para>Gets the row's visible index.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the inspected row.
|
|
|
|
</param>
|
|
<returns>An integer value representing the row's visible index.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetVisibleRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Returns the handle of the row displayed at the specified position.
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value representing a row's visible index.
|
|
|
|
</param>
|
|
<returns>An integer value representing the desired row's handle. <see cref="F:DevExpress.XtraGrid.GridControl.NewItemRowHandle"/> if the specified index corresponds to a new item row or a newly added row which is currently being edited.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GetVisibleRowLevel(System.Int32)">
|
|
<summary>
|
|
<para>Returns the group level of a row specified by its visible index.
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value identifying the row by its visible index.
|
|
|
|
</param>
|
|
<returns>A zero-based integer representing the row's group level.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.GridMenuItemClick">
|
|
<summary>
|
|
<para>Enables you to provide custom responses to clicking context menu items.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupFooterShowMode">
|
|
<summary>
|
|
<para>Gets or sets which groups display footers.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GroupFooterShowMode"/> enumeration value specifying which groups display footers.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupFormat">
|
|
<summary>
|
|
<para>Gets or sets the text pattern for group rows.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the text pattern for group rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupLevelStyle">
|
|
<summary>
|
|
<para>Enables you to specify custom styles for group rows (and corresponding indents) residing at particular nesting levels.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupPanelText">
|
|
<summary>
|
|
<para>Gets or sets the text displayed within the group panel.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the text displayed within the group panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsed">
|
|
<summary>
|
|
<para>Fires immediately after a group row has been collapsed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsing">
|
|
<summary>
|
|
<para>Occurs before group rows are collapsed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanded">
|
|
<summary>
|
|
<para>Fires immediately after a group row has been expanded.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanding">
|
|
<summary>
|
|
<para>Occurs when a group row is about to be expanded.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowHeight">
|
|
<summary>
|
|
<para>Gets or sets the height of group rows.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the height of group rows in pixels. <b>-1</b> to calculate the group row height automatically.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupSummary">
|
|
<summary>
|
|
<para>Provides access to group summary items.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridGroupSummaryItemCollection"/> object representing the collection of group summary item objects.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupSummarySortInfo">
|
|
<summary>
|
|
<para>Enables sorting group rows by summary values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GroupSummarySortInfoCollection"/> collection which contains the information required to sort group rows by summary values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.GroupSummarySortInfoState">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>A string.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.GuessAutoFilterRowValuesFromFilter">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridView.GuessAutoFilterRowValuesFromFilterAfterRestoreLayout">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<returns>A nullable Boolean value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.HideCustomization">
|
|
<summary>
|
|
<para>Closes the customization form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.HideCustomizationForm">
|
|
<summary>
|
|
<para>Fires before the customization form is closed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.HideEditor">
|
|
<summary>
|
|
<para>Hides the active editor discarding any changes made.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.HideLoadingPanel">
|
|
<summary>
|
|
<para>Hides the Loading Panel displayed via the <see cref="M:DevExpress.XtraGrid.Views.Grid.GridView.ShowLoadingPanel"/> method.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.HorzScrollStep">
|
|
<summary>
|
|
<para>Gets or sets the offset by which the View is scrolled horizontally when clicking scrollbar buttons.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the horizontal scrolling step in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.HorzScrollVisibility">
|
|
<summary>
|
|
<para>Gets or sets a value specifying when the horizontal scrollbar should be displayed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ScrollVisibility"/> enumeration value specifying when the horizontal scrollbar should be displayed.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IndicatorWidth">
|
|
<summary>
|
|
<para>Gets or sets the width of the row indicator panel.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the width of the row indicator panel in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateColumnHeader(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Invalidates a particular column header or the entire column header panel.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column whose header is to be repainted. <b>null</b> (<b>Nothing</b> in Visual Basic) to invalidate the entire column header panel.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateFilterPanel">
|
|
<summary>
|
|
<para>Invalidates the filter panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateFooter">
|
|
<summary>
|
|
<para>Invalidates the view footer.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateGroupPanel">
|
|
<summary>
|
|
<para>Invalidates the group panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateHitObject(DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo)">
|
|
<summary>
|
|
<para>Invalidates the View element located at the point specified by the hit information object.
|
|
</para>
|
|
</summary>
|
|
<param name="hit">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/>
|
|
descendant (a <see cref="T:DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitInfo"/> object) containing hit information.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateRow(System.Int32)">
|
|
<summary>
|
|
<para>Invalidates the specified row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the row to be invalidated.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateRowCell(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Invalidates the specified data cell.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the row that contains the cell.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column to which the cell belongs.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateRowIndicator(System.Int32)">
|
|
<summary>
|
|
<para>Invalidates the indicator panel cell corresponding to the specified row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row whose corresponding indicator cell is to be repainted.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvalidateRows">
|
|
<summary>
|
|
<para>Invalidates all rows.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvertCellSelection(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Inverts the cell's selection.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which specifies the handle of the row which owns the cell.
|
|
|
|
</param>
|
|
<param name="focusedColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which represents the column which contains the cell.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.InvokeMenuItemClick(DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs)">
|
|
<summary>
|
|
<para>This member supports the View's infrastructure and should not be used from your code.
|
|
</para>
|
|
</summary>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridMenuItemClickEventArgs"/> class instance representing data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GridMenuItemClick"/> event.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsCellSelect">
|
|
<summary>
|
|
<para>Gets or sets whether block selection is enabled.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if block selection is enabled; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsCellSelected(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether the cell is selected.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which specifies the handle of the row where the cell resides.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which represents the column which contains the cell.
|
|
|
|
</param>
|
|
<returns><b>true</b> is the cell is selected; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsCellSelected(DevExpress.XtraGrid.Views.Base.GridCell)">
|
|
<summary>
|
|
<para>Indicates whether the specified cell is selected.
|
|
</para>
|
|
</summary>
|
|
<param name="cell">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object which represents the grid cell.
|
|
|
|
</param>
|
|
<returns><b>true</b> is the cell is selected; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsDataRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row is a regular data row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the row to test by its handle.
|
|
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row is a regular data row; otherwise, <b>false</b>.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsDefaultState">
|
|
<summary>
|
|
<para>Gets a value indicating whether the View is in the default state.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if no operation is being performed by end-users; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsDraggingState">
|
|
<summary>
|
|
<para>Tests whether the end-user is currently dragging a column header.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a dragging operation is being performed within the view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsEditing">
|
|
<summary>
|
|
<para>Indicates whether a cell editor is active presently.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is in the edit mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsExistAnyRowFooterCell(System.Int32)">
|
|
<summary>
|
|
<para>Determines whether the group footer contains any summary values.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the group row whose footer is tested.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the row footer contains summary values; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsFilterRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row is the auto filter row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the tested row by its handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row is the auto filter row; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsGroupRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row is a group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the tested row by its handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row is a group row; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsMasterRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row is a master row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the tested row by its handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row is a master row; otherwise <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsMasterRowEmpty(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether a particular master row's default detail View is empty.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the tested master row by its handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the master row's default detail View is empty; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsMasterRowEmptyEx(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether a particular master row's detail View is empty.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the tested master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
An integer value identifying the master row's detail by its relation index.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified detail View has no data; otherwise, <b>false</b>.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsMultiSelect">
|
|
<summary>
|
|
<para>Indicates whether multiple rows are allowed to be selected.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if multiple rows are allowed to be selected; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsRowVisible(System.Int32)">
|
|
<summary>
|
|
<para>Determines a particular row's visible state.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the row by its handle.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Grid.RowVisibleState"/> enumeration value specifying the row's visible state.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsShowDetailButtons">
|
|
<summary>
|
|
<para>Indicates whether master-detail expand buttons are displayed within rows.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if master-detail expand buttons are visible; otherwise <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsShowRowFooterCell(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether a particular row footer cell is visible.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the group row whose corresponding row footer contains the required cell.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column whose row footer cell is to be tested.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row footer cell is visible; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsShowRowFooters">
|
|
<summary>
|
|
<para>Indicates whether group footers are available.
|
|
</para>
|
|
</summary>
|
|
<returns><b>true</b> if group footers are available; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsSizingState">
|
|
<summary>
|
|
<para>Gets whether the end-user is resizing columns, rows or details at present time.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the end-user is changing the size of the View elements; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.IsValidRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row handle is valid.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the row's handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row handle is valid; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.IsVisible">
|
|
<summary>
|
|
<para>Gets a value indicating whether the View is visible on screen.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is visible on screen; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.LayoutChanged">
|
|
<summary>
|
|
<para>Updates the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.LeftCoord">
|
|
<summary>
|
|
<para>Gets or sets the offset by which the View is scrolled horizontally.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the horizontal scrolling offset in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.LeftCoordChanged">
|
|
<summary>
|
|
<para>Fires when the View is scrolled horizontally.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.LevelIndent">
|
|
<summary>
|
|
<para>Gets or sets the indent between group rows located at neighboring group levels.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the group row indent in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.MakeColumnVisible(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Makes the specified column visible on screen.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column that should be made visible.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.MakeRowVisible(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Makes the specified row visible on screen. Allows you to invalidate the row, if required.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the row that should be made visible.
|
|
|
|
</param>
|
|
<param name="invalidate">
|
|
<b>true</b> if the row needs to be invalidated; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.MakeRowVisible(System.Int32)">
|
|
<summary>
|
|
<para>Makes the specified row visible on screen.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the row that should be made visible.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowCollapsed">
|
|
<summary>
|
|
<para>Fires immediately after a detail clone has been destroyed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowCollapsing">
|
|
<summary>
|
|
<para>Enables you to control whether master rows can be collapsed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowEmpty">
|
|
<summary>
|
|
<para>Enables you to specify whether a particular detail has data.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowExpanded">
|
|
<summary>
|
|
<para>Fires immediately after a particular detail clone has become visible.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowExpanding">
|
|
<summary>
|
|
<para>Enables you to control whether particular detail clones can be displayed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetChildList">
|
|
<summary>
|
|
<para>Enables you to supply detail data manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetLevelDefaultView">
|
|
<summary>
|
|
<para>Enables you to specify a pattern view to represent a particular detail.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationCount">
|
|
<summary>
|
|
<para>Enables you to specify the number of details for individual master rows.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationDisplayCaption">
|
|
<summary>
|
|
<para>Enables the display caption for a particular relationship (detail clone) to be specified.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MasterRowGetRelationName">
|
|
<summary>
|
|
<para>Enables you to specify the pattern view that will represent a particular detail clone.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.MeasurePreviewHeight">
|
|
<summary>
|
|
<para>Provides the ability to specify the height of individual preview sections in pixels.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.MoveNextPage">
|
|
<summary>
|
|
<para>Moves focus to the next page.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.MovePrevPage">
|
|
<summary>
|
|
<para>Moves focus to the previous page.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.NewItemRowText">
|
|
<summary>
|
|
<para>Gets or sets the text displayed within the new item row.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the text displayed within the new item row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsBehavior">
|
|
<summary>
|
|
<para>Provides access to the View's behavior options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsBehavior"/> object containing the View's behavior options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsCustomization">
|
|
<summary>
|
|
<para>Provides access to the View's customization options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization"/> object containing the View's customization options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsDetail">
|
|
<summary>
|
|
<para>Provides access to the View's master-detail options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsDetail"/> object containing the View's master-detail options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsFind">
|
|
<summary>
|
|
<para>Provides access to settings controlling the behavior and visibility of the Find Panel and its elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridViewOptionsFind"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsHint">
|
|
<summary>
|
|
<para>Provides access to the View's hint options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsHint"/> object containing the View's hint options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsMenu">
|
|
<summary>
|
|
<para>Provides access to the View's menu options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsMenu"/> object containing the View's menu options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsNavigation">
|
|
<summary>
|
|
<para>Gets options regarding cell navigation.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsNavigation"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsPrint">
|
|
<summary>
|
|
<para>Provides options that control how the View is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsPrint"/> object containing the View's print and export options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsSelection">
|
|
<summary>
|
|
<para>Provides access to the View's selection options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection"/> object containing the View's selection options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.OptionsView">
|
|
<summary>
|
|
<para>Provides access to the View's display options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridOptionsView"/> object containing the View's display options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.PaintAppearance">
|
|
<summary>
|
|
<para>Provides access to the appearance settings currently used to paint the Grid View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridViewAppearances"/> object which provides the appearance settings currently used to paint the Grid View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.PopupMenuShowing">
|
|
<summary>
|
|
<para>Enables you to customize or prohibit grid context menus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.PressedColumn">
|
|
<summary>
|
|
<para>Gets the column whose header is pressed.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column whose header is pressed. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column header is pressed at the moment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.PreviewFieldName">
|
|
<summary>
|
|
<para>Gets or sets the name of the field whose values are displayed within preview sections.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value specifying the name of the field whose values are displayed within preview sections.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.PreviewIndent">
|
|
<summary>
|
|
<para>Gets or sets the horizontal offset of preview text.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value indicating the distance in pixels between a preview section's left edge and text.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.PreviewLineCount">
|
|
<summary>
|
|
<para>Gets or sets the number of text lines within preview sections.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the number of text lines within preview sections.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.PrevTopRowIndex">
|
|
<summary>
|
|
<para>Gets the index of the previous top visible row after a vertical scroll operation.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that represents the index of the previous top visible row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.RefreshRowCell(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Refreshes the specified row cell.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which identifies the row.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> containing the required cell.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellClick">
|
|
<summary>
|
|
<para>Allows you to respond to clicking a cell within a row. The event will not fire when clicking on a row cell, if data editing is enabled and the <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.EditorShowMode"/> property is set to <b>MouseDown</b> (and to <b>Default</b>, if multiple row selection is disabled).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.RowCellStyle">
|
|
<summary>
|
|
<para>Enables the appearance settings of individual cells to be changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.RowClick">
|
|
<summary>
|
|
<para>Allows you to respond to clicking a row. The event will not fire when clicking on a row cell, if data editing is enabled and the <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior.EditorShowMode"/> property is set to <b>MouseDown</b> (and to <b>Default</b>, if multiple row selection is disabled).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.RowCount">
|
|
<summary>
|
|
<para>Gets the number of visible rows within the current View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the number of visible rows within a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.RowHeight">
|
|
<summary>
|
|
<para>Gets or sets the height of cells within data rows.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the height of data cells in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.RowSeparatorHeight">
|
|
<summary>
|
|
<para>Gets or sets the distance between rows.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the distance between rows in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.RowStyle">
|
|
<summary>
|
|
<para>Enables the appearance settings of individual rows to be changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.ScrollStyle">
|
|
<summary>
|
|
<para>Gets or sets a value specifying the behavior of the View's scrollbars.
|
|
</para>
|
|
</summary>
|
|
<value>A bitwise combination of <see cref="T:DevExpress.XtraGrid.Views.Grid.ScrollStyleFlags"/> enumeration values that specifies the scrollbars behavior.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectAll">
|
|
<summary>
|
|
<para>Selects all rows within the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectCell(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Selects the cell.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which specifies the handle of the row where the cell is located.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which represents the column which contains the cell.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectCell(DevExpress.XtraGrid.Views.Base.GridCell)">
|
|
<summary>
|
|
<para>Selects the specified cell.
|
|
</para>
|
|
</summary>
|
|
<param name="cell">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object which represents the grid cell.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectCellAnchorRange(DevExpress.XtraGrid.Views.Base.GridCell,DevExpress.XtraGrid.Views.Base.GridCell)">
|
|
<summary>
|
|
<para>Selects multiple cells.
|
|
</para>
|
|
</summary>
|
|
<param name="start">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object representing the grid cell which identifies the starting point of the selection.
|
|
|
|
|
|
</param>
|
|
<param name="end">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object representing the grid cell which identifies the end point of the selection.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectCellAnchorRange(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Selects multiple cells.
|
|
</para>
|
|
</summary>
|
|
<param name="startRowHandle">
|
|
An integer value that specifies the handle of the row in which the cell that identifies the starting point of the selection is located.
|
|
|
|
|
|
</param>
|
|
<param name="startColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column in which the cell that identifies the starting point of the selection is located.
|
|
|
|
|
|
</param>
|
|
<param name="endRowHandle">
|
|
An integer value that specifies the handle of the row in which the cell that identifies the end point of the selection is located.
|
|
|
|
|
|
</param>
|
|
<param name="endColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> objects that represents the column in which the cell that identifies the end point of the selection is located.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectCells(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Selects multiple cells.
|
|
</para>
|
|
</summary>
|
|
<param name="startRowHandle">
|
|
An integer value that specifies the handle of the row in which the cell that identifies the starting point of the selection is located.
|
|
|
|
|
|
</param>
|
|
<param name="startColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column in which the cell that identifies the starting point of the selection is located.
|
|
|
|
|
|
</param>
|
|
<param name="endRowHandle">
|
|
An integer value that specifies the handle of the row in which the cell that identifies the end point of the selection is located.
|
|
|
|
|
|
</param>
|
|
<param name="endColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents the column in which the cell that identifies the end point of the selection is located.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectCells(DevExpress.XtraGrid.Views.Base.GridCell,DevExpress.XtraGrid.Views.Base.GridCell)">
|
|
<summary>
|
|
<para>Selects multiple cells.
|
|
</para>
|
|
</summary>
|
|
<param name="start">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object representing the grid cell which identifies the starting point of the selection.
|
|
|
|
</param>
|
|
<param name="end">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object representing the grid cell which identifies the end point of the selection.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectRow(System.Int32)">
|
|
<summary>
|
|
<para>Selects the specified row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which specifies the handle of the row to select.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SelectRows(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Selects the visible rows in the specified range.
|
|
</para>
|
|
</summary>
|
|
<param name="startRowHandle">
|
|
An integer value which specifies the row's handle at which the selection starts.
|
|
|
|
</param>
|
|
<param name="endRowHandle">
|
|
An integer value which specifies the row's handle at which the selection ends.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SetGroupLevelExpanded(System.Int32,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
<para>Expands or collapses group rows at the specified group level. Allows you to expand/collapse child group rows.
|
|
</para>
|
|
</summary>
|
|
<param name="groupLevel">
|
|
An integer value that is the group level of group rows to be expanded/collapsed.
|
|
|
|
</param>
|
|
<param name="expanded">
|
|
<b>true</b> to expand group rows; <b>false</b> to collapse group rows.
|
|
|
|
</param>
|
|
<param name="recursive">
|
|
<b>true</b> if child group rows of target group rows must be expanded/collapsed as well; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SetMasterRowExpanded(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Expands or collapses the specified master row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="expand">
|
|
<b>true</b> to expand the specified row; <b>false</b> to collapse it.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SetMasterRowExpanded(System.Int32,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Opens or closes a master row's detail View identified by the relationship's name.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationName">
|
|
A string representing the required relationship's name.
|
|
|
|
|
|
</param>
|
|
<param name="expand">
|
|
<b>true</b> to open the specified detail; <b>false</b> to hide it.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SetMasterRowExpandedEx(System.Int32,System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Opens or closes a master row's detail.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the master row by its handle.
|
|
|
|
</param>
|
|
<param name="relationIndex">
|
|
A zero-based integer identifying the required detail by relation index. If set to <b>-1</b>, the method acts like the <see cref="M:DevExpress.XtraGrid.Views.Grid.GridView.SetMasterRowExpanded"/> method.
|
|
|
|
</param>
|
|
<param name="expand">
|
|
<b>true</b> to open the specified detail; <b>false</b> to hide it.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SetRowExpanded(System.Int32,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
<para>Expands or collapses the specified group row and, optionally, the child group rows at all nesting levels.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the group row by its handle.
|
|
|
|
</param>
|
|
<param name="expanded">
|
|
<b>true</b> to expand the group row; <b>false</b> to collapse it.
|
|
|
|
</param>
|
|
<param name="recursive">
|
|
<b>true</b> to expand/collapse child group rows at all nesting levels; <b>false</b> to preserve the expanded state of child group rows.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SetRowExpanded(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Expands or collapses the specified group row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the group row by its handle.
|
|
|
|
</param>
|
|
<param name="expanded">
|
|
<b>true</b> to expand the group row; <b>false</b> to collapse it.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ShowCustomization">
|
|
<summary>
|
|
<para>Invokes the customization form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.ShowCustomizationForm">
|
|
<summary>
|
|
<para>Fires immediately after the customization form has been invoked.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ShowEditor">
|
|
<summary>
|
|
<para>Invokes the focused cell's editor.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ShowFilterPopup(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Displays a Filter DropDown for the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column for which the filter popup must be invoked.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.ShowGridMenu">
|
|
<summary>
|
|
<para>Enables you to customize or prohibit grid context menus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.ShowLoadingPanel">
|
|
<summary>
|
|
<para>Displays the animated Loading Panel, that allows you to indicate the process of data loading.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.StartIncrementalSearch(System.String)">
|
|
<summary>
|
|
<para>Starts an incremental search for the specified string.
|
|
</para>
|
|
</summary>
|
|
<param name="start">
|
|
The text to locate.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.State">
|
|
<summary>
|
|
<para>Gets the View's current state.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Grid.GridState"/> enumeration member indicating the View's current state
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.StopIncrementalSearch">
|
|
<summary>
|
|
<para>Stops the incremental search, if there is one currently in progress.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SynchronizeData(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes a View's data representation settings with the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose data representation settings should be copied to the current View.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.SynchronizeVisual(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes a View's display settings with the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose display settings should be copied to the current View.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Grid.GridView.TopRowChanged">
|
|
<summary>
|
|
<para>Fires when the View is scrolled vertically.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.TopRowIndex">
|
|
<summary>
|
|
<para>Gets or sets the top visible row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the top visible row's visible index.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UnselectCell(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Unselects a cell.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which specifies the handle of the row in which the cell is located.
|
|
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which represents the column that contains the cell.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UnselectCell(DevExpress.XtraGrid.Views.Base.GridCell)">
|
|
<summary>
|
|
<para>Unselects the specified cell.
|
|
</para>
|
|
</summary>
|
|
<param name="cell">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object which represents the grid cell.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UnSelectCells(DevExpress.XtraGrid.Views.Base.GridCell,DevExpress.XtraGrid.Views.Base.GridCell)">
|
|
<summary>
|
|
<para>Unselects the specified cells.
|
|
</para>
|
|
</summary>
|
|
<param name="start">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object that represents the selection's start.
|
|
|
|
</param>
|
|
<param name="end">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.GridCell"/> object that represents the selection's end.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UnSelectCells(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Unselects cells within the specified range.
|
|
</para>
|
|
</summary>
|
|
<param name="startRowHandle">
|
|
An integer value that is the handle of the row where the range starts.
|
|
|
|
</param>
|
|
<param name="startColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that is the column where the range starts.
|
|
|
|
</param>
|
|
<param name="endRowHandle">
|
|
An integer value that is the handle of the row where the range ends.
|
|
|
|
</param>
|
|
<param name="endColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that is the column where the range ends.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UpdateColumnsCustomization">
|
|
<summary>
|
|
<para>Updates the customization form.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UpdateGroupSummary">
|
|
<summary>
|
|
<para>Updates group summaries.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UpdateSummary">
|
|
<summary>
|
|
<para>Updates both group summaries and total summaries.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.GridView.UpdateTotalSummary">
|
|
<summary>
|
|
<para>Updates total summaries.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.VertScrollTipFieldName">
|
|
<summary>
|
|
<para>Gets or sets the field whose values are displayed within the vertical scrollbar's tooltip.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the name of the field whose values are displayed within the vertical scrollbar's tooltip.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.VertScrollVisibility">
|
|
<summary>
|
|
<para>Gets or sets a value specifying when the View's vertical scrollbar is visible.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ScrollVisibility"/> enumeration value specifying when the vertical scrollbar is visible.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.GridView.ViewRect">
|
|
<summary>
|
|
<para>Gets the bounding rectangle of the View's visible area.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Rectangle"/> structure representing the View's bounding rectangle. Coordinates are specified relative to the grid control's top-left corner.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowExpanded"/> and <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.GroupRowCollapsed"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CalcPreviewText"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. This parameter identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs"/> class instance that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Grid.GridView.CalcPreviewText"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.#ctor(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing a handle of the row whose preview text is to be generated. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="previewText">
|
|
A string value representing the preview text. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.PreviewText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.#ctor(System.Int32,System.Int32,System.Object,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CalcPreviewTextEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dataSourceRowIndex">
|
|
The index of the row in the underlying data source. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.DataSourceRowIndex"/> property.
|
|
|
|
</param>
|
|
<param name="rowHandle">
|
|
The index of the row in the View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="row">
|
|
An object that specifies the currently processed row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.Row"/> property.
|
|
|
|
</param>
|
|
<param name="previewText">
|
|
The current preview text. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.PreviewText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.DataSourceRowIndex">
|
|
<summary>
|
|
<para>Gets the index of the row in the underlying data source.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that is the zero-based index of the row in the underlying data source.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.PreviewText">
|
|
<summary>
|
|
<para>Gets or sets a text to display within the preview section.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the text to display within the preview section.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.Row">
|
|
<summary>
|
|
<para>Gets the object that is the currently processed row.
|
|
</para>
|
|
</summary>
|
|
<value>An object that is the currently processed row.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Grid.CalcPreviewTextEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row whose preview text is to be generated.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing a handle of the row whose preview text is to be generated.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.RowVisibleState">
|
|
|
|
<summary>
|
|
<para>Lists values representing row visibility states.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.RowVisibleState.Hidden">
|
|
<summary>
|
|
<para>The row is invisible. Rows can be invisible as the result of View scrolling or collapsing their parent group rows.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.RowVisibleState.Partially">
|
|
<summary>
|
|
<para>The row is partially visible. A row can be partially visible if it is the bottom visible row or its height exceeds the View's height.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.RowVisibleState.Visible">
|
|
<summary>
|
|
<para>The row is visible.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GroupFooterShowMode">
|
|
|
|
<summary>
|
|
<para>Lists values specifying which groups display their footers.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GroupFooterShowMode.Hidden">
|
|
<summary>
|
|
<para>Group footers are not displayed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GroupFooterShowMode.VisibleAlways">
|
|
<summary>
|
|
<para>Group footers are displayed for each group regardless of group rows' expanded state.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GroupFooterShowMode.VisibleIfExpanded">
|
|
<summary>
|
|
<para>Group footers are displayed for expanded groups only. They are not displayed if there are no group summaries set up.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Grid.GridState">
|
|
|
|
<summary>
|
|
<para>Contains values indicating all available Grid View states.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.CellSelection">
|
|
<summary>
|
|
<para>Multiple cells are being selected by an end-user via a mouse. The <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsSelection.MultiSelectMode"/> property must be set to the <see cref="F:DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode.CellSelect"/> value to make this operation available.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.ColumnButtonDown">
|
|
<summary>
|
|
<para>The header panel button is presently pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.ColumnDown">
|
|
<summary>
|
|
<para>A column header is presently pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.ColumnDragging">
|
|
<summary>
|
|
<para>A column header is being dragged. The desired column's <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowMove"/> and View's <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowColumnMoving"/> options must be enabled to allow column header dragging (the default behavior).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.ColumnFilterDown">
|
|
<summary>
|
|
<para>A filter button is presently pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.ColumnSizing">
|
|
<summary>
|
|
<para>A column's right edge is being dragged to change the column's width. The desired column's <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.AllowSize"/> option must be enabled to allow such resizing.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.Editing">
|
|
<summary>
|
|
<para>A cell editor is presently active.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.FilterPanelActiveButtonPressed">
|
|
<summary>
|
|
<para>A check box residing in a filter panel is pressed. This implies that the filter criteria applied to a View is going to be enabled or disabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.FilterPanelCloseButtonPressed">
|
|
<summary>
|
|
<para>A filter close button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.FilterPanelCustomizeButtonPressed">
|
|
<summary>
|
|
<para>A filter panel customize button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.FilterPanelMRUButtonPressed">
|
|
<summary>
|
|
<para>The button which is used to display a dropdown window with a list of the most recently used filter criteria is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.FilterPanelTextPressed">
|
|
<summary>
|
|
<para>The string in the filter panel which represents the filter criteria applied to a View is pressed. This shows/hides a dropdown window with a list of the most recently used filter criteria.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.IncrementalSearch">
|
|
<summary>
|
|
<para>Incremental search is being performed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.Normal">
|
|
<summary>
|
|
<para>The View is in its normal state. No specific action is being performed by the end-user.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.RowDetailSizing">
|
|
<summary>
|
|
<para>A detail clone View's bottom edge is being dragged to resize the View vertically.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.RowSizing">
|
|
<summary>
|
|
<para>A data row's bottom edge is being dragged to change row height. The View's <see cref="P:DevExpress.XtraGrid.Views.Grid.GridOptionsCustomization.AllowRowSizing"/> option must be enabled to allow such resizing operations.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.Scrolling">
|
|
<summary>
|
|
<para>A View is being scrolled. This implies that an end-user depresses the mouse wheel and moves the mouse to scroll the View's contents.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.Selection">
|
|
<summary>
|
|
<para>Multiple rows are being selected using drag and drop. End-users must click an indicator cell and drag the mouse for this purpose. The <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection.MultiSelect"/> option must be enabled to allow such selections.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Grid.GridState.Unknown">
|
|
<summary>
|
|
<para>An unknown action is being performed within the Grid View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.FilterControlEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FilterEditorCreated"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.FilterControlEventArgs.#ctor(DevExpress.XtraGrid.FilterEditor.FilterBuilder,DevExpress.XtraEditors.IFilterControl)">
|
|
<summary>
|
|
<para>Initializes a new instance of the FilterControlEventArgs class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="form">
|
|
The form displaying the FilterControl.
|
|
|
|
</param>
|
|
<param name="ifControl">
|
|
The FilterControl to be displayed in in the form.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FilterControlEventArgs.FilterBuilder">
|
|
<summary>
|
|
<para>Gets the form that displays the Filter Control.
|
|
</para>
|
|
</summary>
|
|
<value>A <b>FilterBuilder</b> object that represents the form displaying the Filter Control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FilterControlEventArgs.FilterControl">
|
|
<summary>
|
|
<para>Gets the Filter Control that displays filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.FilterControl"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FilterControlEventArgs.IFilterControl">
|
|
<summary>
|
|
<para>Gets the Filter Control that displays filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value>An IFilterControl object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FilterControlEventArgs.ShowFilterEditor">
|
|
<summary>
|
|
<para>Gets or sets whether the Filter Editor must be displayed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Filter Editor must be displayed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.ViewOperationEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.GridControl.ViewRegistered"/> and <see cref="E:DevExpress.XtraGrid.GridControl.ViewRemoved"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.ViewOperationEventHandler.Invoke(System.Object,DevExpress.XtraGrid.ViewOperationEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.GridControl.ViewRegistered"/> and <see cref="E:DevExpress.XtraGrid.GridControl.ViewRemoved"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the grid control that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.ViewOperationEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.StyleFormatCondition">
|
|
|
|
<summary>
|
|
<para>Represents a style condition applied to a View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> object with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.#ctor(DevExpress.XtraGrid.FormatConditionEnum,DevExpress.XtraGrid.Columns.GridColumn,System.Object,System.Object,System.Object,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="condition">
|
|
A <see cref="T:DevExpress.XtraGrid.FormatConditionEnum"/> enumeration value specifying the type of comparison operation. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Condition"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents a column whose values are involved in conditional formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.Column"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An object used to identify the new style condition object. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Tag"/> property.
|
|
|
|
</param>
|
|
<param name="val1">
|
|
An object that is compared to cell values as specified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value1"/> property.
|
|
|
|
</param>
|
|
<param name="val2">
|
|
An object that is compared to cell values as specified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value2"/> property.
|
|
|
|
</param>
|
|
<param name="applyToRow">
|
|
<b>true</b> to apply the specified style to entire rows that contain cells matching the defined criteria; <b>false</b> to apply the style to individual cells. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.ApplyToRow"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.#ctor(DevExpress.XtraGrid.FormatConditionEnum,DevExpress.XtraGrid.Columns.GridColumn,System.Object,System.Object,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="condition">
|
|
A <see cref="T:DevExpress.XtraGrid.FormatConditionEnum"/> enumeration value specifying the type of the comparison operation. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Condition"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents a column whose values are involved in conditional formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.Column"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An object used to identify the new style condition object. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Tag"/> property.
|
|
|
|
</param>
|
|
<param name="val1">
|
|
An object that is compared to cell values as specified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value1"/> property.
|
|
|
|
</param>
|
|
<param name="val2">
|
|
An object that is compared to cell values as specified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value2"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.#ctor(DevExpress.XtraGrid.FormatConditionEnum,DevExpress.XtraGrid.Columns.GridColumn,System.Object,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="condition">
|
|
A <see cref="T:DevExpress.XtraGrid.FormatConditionEnum"/> enumeration value specifying the type of the comparison operation. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Condition"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object that represents a column whose values are involved in conditional formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.Column"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An object used to identify the new style condition object. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Tag"/> property.
|
|
|
|
</param>
|
|
<param name="val1">
|
|
An object that is compared to cell values as specified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value1"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.#ctor(DevExpress.XtraGrid.FormatConditionEnum,System.Object,DevExpress.Utils.AppearanceObject,System.Object,System.Object,DevExpress.XtraGrid.Columns.GridColumn,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="condition">
|
|
A <see cref="T:DevExpress.XtraGrid.FormatConditionEnum"/> enumeration value specifying the type of comparison operation. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Condition"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An object used to identify the style condition object created. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Tag"/> property.
|
|
|
|
</param>
|
|
<param name="appearance">
|
|
A <see cref="T:DevExpress.Utils.AppearanceObject"/> descendant which provides the appearance settings used to paint the cells that meet the specified condition. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Appearance"/> property.
|
|
|
|
</param>
|
|
<param name="val1">
|
|
An object that is compared with the values of the cells identified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value1"/> property.
|
|
|
|
</param>
|
|
<param name="val2">
|
|
An object that is compared with the values of the cells identified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value2"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) which represents a column whose values are involved in conditional formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.Column"/> property.
|
|
|
|
</param>
|
|
<param name="applyToRow">
|
|
<b>true</b> to apply the specified style to entire rows that contain cells which match the defined criteria; <b>false</b> to apply the style to individual cells only. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.ApplyToRow"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.#ctor(DevExpress.XtraGrid.FormatConditionEnum,System.Object,DevExpress.Utils.AppearanceDefault,System.Object,System.Object,DevExpress.XtraGrid.Columns.GridColumn,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.StyleFormatCondition"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="condition">
|
|
A <see cref="T:DevExpress.XtraGrid.FormatConditionEnum"/> enumeration value specifying the type of comparison operation. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Condition"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An object used to identify the style condition object created. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Tag"/> property.
|
|
|
|
</param>
|
|
<param name="appearanceDefault">
|
|
An <see cref="T:DevExpress.Utils.AppearanceDefault"/> object which provides the appearance settings used to paint the cells that meet the specified condition. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Appearance"/> property.
|
|
|
|
</param>
|
|
<param name="val1">
|
|
An object that is compared with the values of the cells identified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value1"/> property.
|
|
|
|
</param>
|
|
<param name="val2">
|
|
An object that is compared with the values of the cells values identified by the <i>condition</i> parameter. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Value2"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) which represents a column whose values are involved in conditional formatting. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.Column"/> property.
|
|
|
|
</param>
|
|
<param name="applyToRow">
|
|
<b>true</b> to apply the specified style to entire rows that contain cells which match the defined criteria; <b>false</b> to apply the style to the individual cells only. This value is assigned to the <see cref="P:DevExpress.XtraGrid.StyleFormatCondition.ApplyToRow"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.#ctor(DevExpress.XtraGrid.FormatConditionEnum)">
|
|
<summary>
|
|
<para>Initializes a new instance of the StyleFormatCondition class with the specified comparison operation type.
|
|
</para>
|
|
</summary>
|
|
<param name="condition">
|
|
A <see cref="T:DevExpress.XtraGrid.FormatConditionEnum"/> enumeration value that specifies the type of the comparison operation. This value is assigned to the <see cref="P:DevExpress.XtraEditors.StyleFormatConditionBase.Condition"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.StyleFormatCondition.ApplyToRow">
|
|
<summary>
|
|
<para>Gets or sets whether the appearance settings are to be applied to rows or individual cells.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to apply the appearance settings to entire rows; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.StyleFormatCondition.Assign(DevExpress.XtraEditors.StyleFormatConditionBase)">
|
|
<summary>
|
|
<para>Copies the properties of the specified object to the current object.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="source">
|
|
The <see cref="T:DevExpress.XtraEditors.StyleFormatConditionBase"/> object whose properties should be copied.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.StyleFormatCondition.Collection">
|
|
<summary>
|
|
<para>Gets the collection that owns the current style condition object.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.StyleFormatConditionCollection"/> object representing the collection that owns the current object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.StyleFormatCondition.Column">
|
|
<summary>
|
|
<para>Gets or sets the column whose values take part in conditional formatting.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) representing the column whose values are used in conditional formatting. <b>null</b> (<b>Nothing</b> in Visual Basic) if all columns' values are involved.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.StyleFormatCondition.ColumnName">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>The name of the column to which the current condition is applied.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridSummaryItem">
|
|
|
|
<summary>
|
|
<para>Represents a footer summary item.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.#ctor(DevExpress.Data.SummaryItemType,System.String,System.String,System.Object)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object with the predefined summary settings and tag.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregation function type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value specifying the name of a data field whose values are used for summary calculation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value specifying the summary value's display format. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
<param name="tag">
|
|
An object used to identify the summary item. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Tag"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.#ctor(DevExpress.Data.SummaryItemType,System.String,System.String)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object with the predefined summary settings.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the aggregation function type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string value specifying the name of a data field whose values are used for summary calculation. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.FieldName"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string value specifying the summary value's display format. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.Assign(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Copies settings from the summary item object specified as the parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="source">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object whose settings should be copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.Collection">
|
|
<summary>
|
|
<para>Gets a collection to which the summary item belongs.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridSummaryItemCollection"/> object (or descendant) representing the collection to which the summary item belongs.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat">
|
|
<summary>
|
|
<para>Gets or sets the summary value formatting.
|
|
</para>
|
|
</summary>
|
|
<value>A string specifying the summary value's display format. An empty string to display the summary value using default formatting.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.FieldName">
|
|
<summary>
|
|
<para>Gets or sets the name of a dataset field whose values are used for summary calculation.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the name of a data field whose values are used for summary calculation.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.Format">
|
|
<summary>
|
|
<para>Gets or sets the <see cref="T:System.IFormatProvider"/> object which specifies how values should be formatted.
|
|
</para>
|
|
</summary>
|
|
<value>The IFormatProvider object, which specifies how values should be formatted.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.GetDefaultDisplayFormat">
|
|
<summary>
|
|
<para>Returns the default display format for the summary item.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that represents the default display format.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.GetDisplayFormatByType(DevExpress.Data.SummaryItemType,System.Boolean)">
|
|
<summary>
|
|
<para>Returns the default format string for the specified summary type.
|
|
</para>
|
|
</summary>
|
|
<param name="itemType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value representing the summary type.
|
|
|
|
</param>
|
|
<param name="fullForm">
|
|
<b>true</b> to add static text identifying summary type; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
<returns>A string value representing the default format string used for the specified summary type.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.GetDisplayText(System.Object,System.Boolean)">
|
|
<summary>
|
|
<para>Formats the specified value using the summary item's format settings.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="value">
|
|
A <see cref="T:System.Object"/> representing the value to be formatted.
|
|
|
|
|
|
</param>
|
|
<param name="fullForm">
|
|
<b>true</b> if the formatted string should contain static text identifying the summary item type; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
<returns>A string representing the specified value formatted with respect to the summary item's format settings.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.GetFormatDisplayText(System.String,System.Object)">
|
|
<summary>
|
|
<para>Returns the value formatted according to the specified format string.
|
|
</para>
|
|
</summary>
|
|
<param name="formatString">
|
|
A format string.
|
|
|
|
</param>
|
|
<param name="value">
|
|
A value to be formatted.
|
|
|
|
</param>
|
|
<returns>A string value that specifies the value formatted according to the specified format string.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.Index">
|
|
<summary>
|
|
<para>Gets the summary item's position within the owning collection.
|
|
</para>
|
|
</summary>
|
|
<value>A zero-based integer value representing summary item's position within the collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.IsEquals(DevExpress.XtraGrid.GridSummaryItem)">
|
|
<summary>
|
|
<para>Indicates whether the specified summary item has the same settings as the current one.
|
|
</para>
|
|
</summary>
|
|
<param name="item">
|
|
A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object whose settings are compared to the current summary item's settings.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the summary item passed as the parameter has the same settings as the current one; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.SetSummary(DevExpress.Data.SummaryItemType,System.String)">
|
|
<summary>
|
|
<para>Specifies the type and display format of the summary item.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the summary type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string specifying the summary value's display format. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.SetSummary(DevExpress.Data.SummaryItemType,System.String,System.IFormatProvider)">
|
|
<summary>
|
|
<para>Specifies the type, display format and format provider for the summary item.
|
|
</para>
|
|
</summary>
|
|
<param name="summaryType">
|
|
A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the summary type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType"/> property.
|
|
|
|
</param>
|
|
<param name="displayFormat">
|
|
A string specifying the summary value's display format. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.DisplayFormat"/> property.
|
|
|
|
</param>
|
|
<param name="format">
|
|
A format provider. This value is assigned to the <see cref="P:DevExpress.XtraGrid.GridSummaryItem.Format"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.SummaryType">
|
|
<summary>
|
|
<para>Gets or sets the aggregation function type.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.SummaryItemType"/> enumeration value specifying the summary type.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.SummaryValue">
|
|
<summary>
|
|
<para>Gets the current total summary item's value.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Object"/> representing the total summary value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridSummaryItem.Tag">
|
|
<summary>
|
|
<para>Gets or sets data associated with the summary item.
|
|
</para>
|
|
</summary>
|
|
<value>An object containing information associated with the summary item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridSummaryItem.ToString">
|
|
<summary>
|
|
<para>Gets the object's text representation.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that specifies the object's text representation.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.GridControl">
|
|
|
|
<summary>
|
|
<para>Represents the grid control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.GridControl"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.About">
|
|
<summary>
|
|
<para>Activates the control's <b>About</b> dialog box.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.AccessibleNotifyClients(System.Windows.Forms.AccessibleEvents,System.Int32)">
|
|
<summary>
|
|
<para>Notifies accessibility client applications of the specified <see cref="T:System.Windows.Forms.AccessibleEvents"/> event for the specified child control.
|
|
</para>
|
|
</summary>
|
|
<param name="accEvents">
|
|
An <see cref="T:System.Windows.Forms.AccessibleEvents"/> event being fired.
|
|
|
|
|
|
</param>
|
|
<param name="childID">
|
|
A child <see cref="T:System.Windows.Forms.Control"/> which fires the event.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.AllowRestoreSelectionAndFocusedRow">
|
|
<summary>
|
|
<para>Gets or sets whether to preserve the focused row and selection after sorting, grouping or filtering.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> enumeration value that specifies whether the focused row and selection are restored after sorting, grouping or filtering.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.GridControl.AutoFilterRowHandle">
|
|
<summary>
|
|
<para>Contains a value which represents the handle of the Auto Filter Row. For more information on row handles refer to the Identifying Rows and Cards section.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>$
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.AvailableViews">
|
|
<summary>
|
|
<para>Gets the collection of registered View types.
|
|
</para>
|
|
</summary>
|
|
<value>A collection of View types that can be created using the designer or the <see cref="M:DevExpress.XtraGrid.GridControl.CreateView"/> method.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.BeginInit">
|
|
<summary>
|
|
<para>Starts the grid's runtime initialization.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.BeginUpdate">
|
|
<summary>
|
|
<para>Locks the GridControl by preventing visual updates of the object and its elements until the <b>EndUpdate</b> method is called.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.BindingContext">
|
|
<summary>
|
|
<para>Gets or sets the <see cref="T:System.Windows.Forms.BindingContext"/> for the control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Windows.Forms.BindingContext"/> for the control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.ContextMenuStrip">
|
|
<summary>
|
|
<para>Gets or sets a <see cref="T:System.Windows.Forms.ContextMenuStrip"/> object associated with the grid control.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Windows.Forms.ContextMenuStrip"/> object associated with the grid control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.Controls">
|
|
<summary>
|
|
<para>Gets the collection of controls contained within the control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Windows.Forms.Control.ControlCollection"/> object representing the collection of controls contained within the grid control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.CreateSplitContainer">
|
|
<summary>
|
|
<para>Creates a Split Container and places the current GridControl to it.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.GridSplitContainer"/> that is the created Split Container.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.CreateView(System.String)">
|
|
<summary>
|
|
<para>Creates a View of the specified type.
|
|
</para>
|
|
</summary>
|
|
<param name="name">
|
|
A <see cref="T:System.String"/> that specifies the View type.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the new View.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.DataMember">
|
|
<summary>
|
|
<para>Gets or sets a data source member whose data is supplied for the grid control's main View.
|
|
</para>
|
|
</summary>
|
|
<value>A string value representing the data source member.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.DataSource">
|
|
<summary>
|
|
<para>Gets or sets the grid control's data source.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the grid control's data source.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.DataSourceChanged">
|
|
<summary>
|
|
<para>Fires when changing the <see cref="P:DevExpress.XtraGrid.GridControl.DataSource"/> property value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.DefaultView">
|
|
<summary>
|
|
<para>Gets the currently maximized View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the currently maximized Pattern and Clone Views.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.DefaultViewChanged">
|
|
<summary>
|
|
<para>Fires when zooming a View in or out.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.Dock">
|
|
<summary>
|
|
<para>Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Windows.Forms.DockStyle"/> value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.EmbeddedNavigator">
|
|
<summary>
|
|
<para>Provides access to the embedded data navigator.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.ControlNavigator"/> descendant representing the grid control's embedded data navigator.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.EndUpdate">
|
|
<summary>
|
|
<para>Unlocks the GridControl object after a call to the <b>BeginUpdate</b> method and causes an immediate visual update.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToCsv(System.IO.Stream,DevExpress.XtraPrinting.CsvExportOptions)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified stream in CSV format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A stream to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.CsvExportOptions"/> object which specifies the CSV export options to be applied when the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToCsv(System.String)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified file in CSV format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> containing the full path to the file to which the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToCsv(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified stream in CSV.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A stream to which the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToCsv(System.String,DevExpress.XtraPrinting.CsvExportOptions)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified file in CSV format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> containing the full path to the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.CsvExportOptions"/> object which specifies the CSV export options to be applied when the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToExcelOld(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in XLS format.
|
|
</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
A string that specifies the full path to the file the default View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtml(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in HTML format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file which the default View's data will be exported to.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtml(System.String,System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in HTML format using the specified character encoding.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file which the default View's data will be exported to.
|
|
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the name of the character encoding (e.g. "UTF-8").
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtml(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in HTML format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtml(System.String,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified HTML file with the specified title, using the specified character encoding. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the default View's data will be exported.
|
|
|
|
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the name of the character encoding (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created HTML document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the HTML code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtml(System.IO.Stream,DevExpress.XtraPrinting.HtmlExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in HTML format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.HtmlExportOptions"/> object which specifies the export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtml(System.String,DevExpress.XtraPrinting.HtmlExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in HTML format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.HtmlExportOptions"/> object which specifies the export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtml(System.IO.Stream,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in HTML format with the specified title, using the specified character encoding. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the name of the character encoding (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created HTML document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the HTML code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToHtmlOld(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in HTML format.
|
|
</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
A string that specifies the full path to the file to which the default View's data will be exported.
|
|
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToMht(System.IO.Stream,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the data is exported.
|
|
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the MHT file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created MHT document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToMht(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in MHT format
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToMht(System.String,System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in MHT format using the specified character encoding.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the MHT file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToMht(System.String,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the MHT file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created MHT document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToMht(System.IO.Stream,DevExpress.XtraPrinting.MhtExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in MHT format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.MhtExportOptions"/> object which specifies the export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToMht(System.String,DevExpress.XtraPrinting.MhtExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in MHT format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.MhtExportOptions"/> object which specifies the export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToPdf(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToPdf(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file which the default View's data will be exported to.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToRtf(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to a file in RTF format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToRtf(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in RTF format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, which the data is exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in TXT format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file which the default View's data will be exported to.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.String,System.String,System.Boolean,System.Text.Encoding)">
|
|
<summary>
|
|
<para>Exports the default View's data to a file in TXT format using the specified separator string, quotation and text encoding settings.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the default View's data will be exported.
|
|
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) separator string text elements; otherwise, <b>false</b>.
|
|
|
|
|
|
|
|
</param>
|
|
<param name="encoding">
|
|
A <see cref="T:System.Text.Encoding"/> class descendant specifying the encoding of the created text document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in TXT format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created text file will be sent.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.IO.Stream,System.String,System.Boolean,System.Text.Encoding)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in TXT format using the specified separator string, quotation and text encoding settings.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created text file should be sent.
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) separator string text elements; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
<param name="encoding">
|
|
A <see cref="T:System.Text.Encoding"/> class descendant specifying the encoding of the created text document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.IO.Stream,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in TXT format using the specified separator string and quotation settings.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created text file should be sent.
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) separator string text elements; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.IO.Stream,System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in TXT format using the specified separator string.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created text file should be sent.
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.String,System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to a file in TXT format using the specified separator string.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the default View's data will be exported.
|
|
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to a file in TXT format using the specified separator string and quotation settings.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the default View's data will be exported.
|
|
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) separator string text elements; otherwise, <b>false</b>.
|
|
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.IO.Stream,DevExpress.XtraPrinting.TextExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified sream in Text format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.TextExportOptions"/> object which specifies the export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToText(System.String,DevExpress.XtraPrinting.TextExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in Text format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.TextExportOptions"/> object which specifies the export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToTextOld(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in TXT format.
|
|
</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXls(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to a file in XLS format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXls(System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to a file in XLS format with the specified formatting settings.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
<param name="useNativeFormat">
|
|
<b>true</b> to use the data format of the exported data fields for the cells in the XLS document; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXls(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in XLS format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXls(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the default View's data to a stream in XLS format with the specified formatting settings.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created document is exported.
|
|
|
|
|
|
</param>
|
|
<param name="useNativeFormat">
|
|
<b>true</b> to use the data format of the exported data fields for the cells in the XLS document; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXls(System.IO.Stream,DevExpress.XtraPrinting.XlsExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in XLS format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.XlsExportOptions"/> object which specifies the XLS export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXls(System.String,DevExpress.XtraPrinting.XlsExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in XLS format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.XlsExportOptions"/> object which specifies the XLS export options to be applied when the default View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXlsx(System.IO.Stream,DevExpress.XtraPrinting.XlsxExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in XLSX (MS Excel 2007) format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which data is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.XtraPrinting.XlsxExportOptions"/> object that contains export options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXlsx(System.String,DevExpress.XtraPrinting.XlsxExportOptions)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in XLSX (MS Excel 2007) format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the data is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.XtraPrinting.XlsxExportOptions"/> object that contains export options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXlsx(System.String)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified file in XLSX (MS Excel 2007) format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ExportToXlsx(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the default View's data to the specified stream in XLSX (MS Excel 2007) format
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.FireChanged">
|
|
<summary>
|
|
<para>Forces an update to the control's properties that are listed within the property grid at design time.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.FocusedView">
|
|
<summary>
|
|
<para>Gets or sets the View which is currently focused.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant which represents the focused View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.FocusedViewChanged">
|
|
<summary>
|
|
<para>Fires in response to focus moving between Views.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ForceInitialize">
|
|
<summary>
|
|
<para>Forces the grid control to finish its initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.FormsUseDefaultLookAndFeel">
|
|
<summary>
|
|
<para>Gets or sets whether the grid control's external forms are painted according to the Default LookAndFeel, or according to a View's painting scheme.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>if the grid control's external forms are painted according to the Default LookAndFeel; <b>false</b> if the forms are painted according to a View's painting scheme.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.GetViewAt(System.Drawing.Point)">
|
|
<summary>
|
|
<para>Gets the View owning the specific point.
|
|
</para>
|
|
</summary>
|
|
<param name="point">
|
|
A <see cref="T:System.Drawing.Point" /> structure specifying the test point. The point is relative to the top left grid corner.
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.GridDisposing">
|
|
<summary>
|
|
<para>Gets a value indicating whether the current <see cref="T:DevExpress.XtraGrid.GridControl"/> is being unloaded from memory.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the current <see cref="T:DevExpress.XtraGrid.GridControl"/> is being disposed of; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.InternalGetService(System.Type)">
|
|
<summary>
|
|
<para>The function supports the internal infrastructure and is not intended to be called from your code.
|
|
</para>
|
|
</summary>
|
|
<param name="service">
|
|
[To be supplied]
|
|
</param>
|
|
<returns>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle">
|
|
<summary>
|
|
<para>Contains the value representing the invalid row handle. This value is returned when an attempt to obtain a particular row fails, etc. Please refer to the Identifying Rows and Cards topic for more information regarding row handles.
|
|
</para>
|
|
</summary>
|
|
<returns>$
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.IsDesignMode">
|
|
<summary>
|
|
<para>Gets a value indicating whether the grid control is currently in design mode.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the grid control is in design mode; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.IsFocused">
|
|
<summary>
|
|
<para>Tests whether the grid control has input focus.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the grid control has input focus; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.IsLoaded">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure, and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>@nbsp;
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.IsPrinting">
|
|
<summary>
|
|
<para>Gets whether the grid control is sending information to the print/export engine.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the grid is sending information to the print/export engine; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.IsPrintingAvailable">
|
|
<summary>
|
|
<para>Indicates whether the grid control can be printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the grid control can be printed/exported; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.IsSplitGrid">
|
|
<summary>
|
|
<para>Gets whether the GridControl belongs to a <see cref="T:DevExpress.XtraGrid.GridSplitContainer"/>.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the GridControl belongs to a GridSplitContainer; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.IsVisibleView(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Indicates whether a specific View is currently visible.
|
|
</para>
|
|
</summary>
|
|
<param name="gv">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object that corresponds to the inspected View.
|
|
|
|
</param>
|
|
<returns><b>true</b>, if a specific View is visible onscreen, otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.KeyboardFocusView">
|
|
<summary>
|
|
<para>Gets or sets the View that currently has keyboard focus.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that has keyboard focus.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.KeyboardFocusViewChanged">
|
|
<summary>
|
|
<para>Fires when moving focus between Views.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.LevelTree">
|
|
<summary>
|
|
<para>Provides access to a hierarchical structure that associates pattern Views with specific master-detail relationships.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridLevelTree"/> object that associates pattern Views with specific master-detail relationships.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.Load">
|
|
<summary>
|
|
<para>Fires when a grid control is displayed for the first time.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.LockFireChanged">
|
|
<summary>
|
|
<para>Prevents change notifications from being sent until the <see cref="M:DevExpress.XtraGrid.GridControl.UnlockFireChanged"/> method is called.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.LookAndFeel">
|
|
<summary>
|
|
<para>Provides access to settings controlling the grid control's look and feel.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.LookAndFeel.UserLookAndFeel"/> object whose properties specify the grid control's look and feel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.MainView">
|
|
<summary>
|
|
<para>Gets or sets the View that displays data at the top hierarchy level.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that displays data at the top hierarchy level.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.GridControl.NewItemRowHandle">
|
|
<summary>
|
|
<para>Contains a value which represents the handle of the New Item Row/Card. For more information on row handles refer to the Identifying Rows and Cards section.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>$
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.Print">
|
|
<summary>
|
|
<para>Prints the grid control's Default View (the <see cref="P:DevExpress.XtraGrid.GridControl.MainView"/> or the currently maximized detail View).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.PrintDialog">
|
|
<summary>
|
|
<para>Displays the standard Print dialog to print the data displayed in the GridControl's <see cref="P:DevExpress.XtraGrid.GridControl.DefaultView"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.ProcessGridKey">
|
|
<summary>
|
|
<para>Enables you to process key presses before they are processed by the grid control.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.RefreshDataSource">
|
|
<summary>
|
|
<para>Updates the <see cref="T:DevExpress.XtraGrid.GridControl"/> to reflect changes made to a data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.RemoveSplitContainer">
|
|
<summary>
|
|
<para>Removes the Grid Control from a Split Container and disposes of this Split Container.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.ServerMode">
|
|
<summary>
|
|
<para>Gets whether server mode is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if server mode is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.ShowOnlyPredefinedDetails">
|
|
<summary>
|
|
<para>Gets or sets whether the XtraGrid displays only the relationships that exist in the <see cref="P:DevExpress.XtraGrid.GridControl.LevelTree"/>.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if only the relationships that exist in the <see cref="P:DevExpress.XtraGrid.GridControl.LevelTree"/> are displayed by the grid; <b>false</b> if all the relationships in the bound data source are displayed by the grid.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ShowPreview">
|
|
<summary>
|
|
<para>Opens the Print Preview window for the grid control's Default View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ShowPrintPreview">
|
|
<summary>
|
|
<para>Opens the Print Preview window with a Bars UI.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.ShowRibbonPrintPreview">
|
|
<summary>
|
|
<para>Displays the Print Preview window with a Ribbon UI.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.SwitchPaintStyle(System.String)">
|
|
<summary>
|
|
<para>Applies the specified paint style to all Views.
|
|
</para>
|
|
</summary>
|
|
<param name="newPaintStyleName">
|
|
A string value specifying the paint style name.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.GridControl.UnlockFireChanged">
|
|
<summary>
|
|
<para>Re-enables change notifications after a call to the <see cref="M:DevExpress.XtraGrid.GridControl.LockFireChanged"/> method.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.UseDisabledStatePainter">
|
|
<summary>
|
|
<para>Gets or sets whether the control is painted grayed out, when it's in the disabled state.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the control is painted grayed out, when it's in the disabled state; otherwise, <b>false</b>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.UseEmbeddedNavigator">
|
|
<summary>
|
|
<para>Gets or sets whether the embedded data navigator is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to make the embedded navigator visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.ViewCollection">
|
|
<summary>
|
|
<para>Provides access to the collection of Views in the grid's View repository.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Repository.ViewRepositoryCollection"/> object that represents the collection of Views within the grid's View repository.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.ViewRegistered">
|
|
<summary>
|
|
<para>Fires when a new detail clone is created.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.GridControl.ViewRemoved">
|
|
<summary>
|
|
<para>Fires when a detail clone is being disposed of.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.GridControl.Views">
|
|
<summary>
|
|
<para>Gets the collection of Views currently displayed by the grid control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridControlViewCollection"/> object containing Views that are currently displayed by the grid control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardView">
|
|
|
|
<summary>
|
|
<para>Represents a View displaying data using cards.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Card.CardView"/> object with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.#ctor(DevExpress.XtraGrid.GridControl)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Card.CardView"/> object with the specified owner.
|
|
</para>
|
|
</summary>
|
|
<param name="ownerGrid">
|
|
A <see cref="T:DevExpress.XtraGrid.GridControl"/> object representing a grid control that will own the created View. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.GridControl"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.Appearance">
|
|
<summary>
|
|
<para>Provides access to the properties that control the appearance of the Card View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.CardViewAppearances"/> object providing the appearance settings for the View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.AppearancePrint">
|
|
<summary>
|
|
<para>Provides access to the properties that specify the appearances of View elements when they are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.CardViewPrintAppearances"/> object that provides appearance settings for View elements when they are printed/exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.Assign(DevExpress.XtraGrid.Views.Base.BaseView,System.Boolean)">
|
|
<summary>
|
|
<para>Copies property values and, optionally, event handlers from the View specified as a parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="v">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose settings should be copied to the current View.
|
|
|
|
</param>
|
|
<param name="copyEvents">
|
|
<b>true</b> to copy event handlers; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CalcFieldHeight">
|
|
<summary>
|
|
<para>Allows you provide custom height for individual card fields.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.CalcHitInfo(System.Drawing.Point)">
|
|
<summary>
|
|
<para>Returns information about View elements located at a specified point.
|
|
</para>
|
|
</summary>
|
|
<param name="pt">
|
|
A <see cref="T:System.Drawing.Point"/> structure specifying the test point coordinates relative to the grid control's top-left corner.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo"/> object that contains information about View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.CalcHitInfo(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns information about the View elements located at the specified point.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="x">
|
|
An integer representing the X coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<param name="y">
|
|
An integer representing the Y coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo"/> object that contains information on the View elements located at the test point.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.CanResizeCards">
|
|
<summary>
|
|
<para>Indicates whether it is possible to resize cards.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a user can resize cards; otherwise <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.CardCaptionFormat">
|
|
<summary>
|
|
<para>Gets or sets card caption text patterns.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the card caption's text pattern.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CardCollapsed">
|
|
<summary>
|
|
<para>Fires immediately after a card has been collapsed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CardCollapsing">
|
|
<summary>
|
|
<para>Provides the ability to prevent particular cards from being collapsed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CardExpanded">
|
|
<summary>
|
|
<para>Fires immediately after a card has been expanded.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CardExpanding">
|
|
<summary>
|
|
<para>Provides the ability to prevent particular cards from being expanded.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.CardInterval">
|
|
<summary>
|
|
<para>Gets or sets the distance between neighboring cards.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the distance between cards in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.CardScrollButtonBorderStyle">
|
|
<summary>
|
|
<para>Gets or sets the scroll buttons' paint style.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Controls.BorderStyles"/> enumeration value specifying the scroll buttons' paint style.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.CardWidth">
|
|
<summary>
|
|
<para>Gets or sets card width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying card width in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.CollapseAll">
|
|
<summary>
|
|
<para>Collapses all the cards within the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.CollapseCard(System.Int32)">
|
|
<summary>
|
|
<para>Collapses the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that identifies the card by its handle.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.CreateExportLink(DevExpress.XtraExport.IExportProvider)">
|
|
<summary>
|
|
<para>Returns an object that enables you to export a View's data in a number of different formats.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object implementing the <b>DevExpress.XtraExport.IExportProvider</b> interface that exports data to a particular format.
|
|
|
|
</param>
|
|
<returns>A <b>BaseExportLink</b> descendant (a <b>CardViewExportLink</b> object) providing exporting facilities.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CustomCardCaptionImage">
|
|
<summary>
|
|
<para>Enables custom images to be shown in card captions.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardCaption">
|
|
<summary>
|
|
<para>Enables card captions to be custom painted.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardField">
|
|
<summary>
|
|
<para>Enables you to custom paint card fields.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldCaption">
|
|
<summary>
|
|
<para>Enables you to custom paint card field captions.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.CustomDrawCardFieldValue">
|
|
<summary>
|
|
<para>Enables you to custom paint card field value cells.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.ExpandAll">
|
|
<summary>
|
|
<para>Expands all the cards within the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.ExpandCard(System.Int32)">
|
|
<summary>
|
|
<para>Expands the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that identifies the card by its handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.FocusedCardTopFieldIndex">
|
|
<summary>
|
|
<para>Gets or sets the index of the top visible field within the focused card.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the zero-based index of the focused card's top visible field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.GetCardCaption(System.Int32)">
|
|
<summary>
|
|
<para>Gets the specified card's caption text.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card by its row handle.
|
|
|
|
</param>
|
|
<returns>A string value representing the specified card's caption text.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.GetCardCollapsed(System.Int32)">
|
|
<summary>
|
|
<para>Gets whether the specified card is collapsed.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card's handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the card is collapsed; <b>false</b> if the card is expanded.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.GetVisibleIndex(System.Int32)">
|
|
<summary>
|
|
<para>Gets the specified card's visible index.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the card to inspect.
|
|
|
|
</param>
|
|
<returns>An integer value representing the card's visible index. <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> if there isn't any card with the specified handle.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.GetVisibleRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Returns the handle of the card displayed at the specified position.
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value representing the card's visible index.
|
|
|
|
</param>
|
|
<returns>An integer value representing the card's handle. <see cref="F:DevExpress.XtraGrid.GridControl.NewItemRowHandle"/> if no card is found or the specified index corresponds to a newly added card which is currently being edited.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.HideEditor">
|
|
<summary>
|
|
<para>Hides the currently active editor discarding changes made.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.InvalidateCard(System.Int32)">
|
|
<summary>
|
|
<para>Invalidates the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card by its row handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.InvalidateCardField(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Invalidates the specified card field.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the card by its row handle.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object specifying the column that corresponds to the card field.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.InvalidateHitObject(DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo)">
|
|
<summary>
|
|
<para>Invalidates the View element located at the point specified by the hit information object.
|
|
</para>
|
|
</summary>
|
|
<param name="hit">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/> descendant (a <see cref="T:DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo"/> object) containing hit information.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.IsCardVisible(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether a card is visible, partially visible or hidden.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The row handle of a card.
|
|
|
|
</param>
|
|
<returns>The <see cref="T:DevExpress.XtraGrid.Views.Card.CardVisibleState"/> enumerator value that specifies the visibility state of a card.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.IsDefaultState">
|
|
<summary>
|
|
<para>Gets a value indicating whether the View is in its normal state.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if no specific operation is performed within the Card View; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.IsEditing">
|
|
<summary>
|
|
<para>Gets a value indicating whether a cell editor is presently active.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is in edit mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.IsSizingState">
|
|
<summary>
|
|
<para>Gets a value indicating whether the end-user is presently resizing cards.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the end-user is dragging a card separator; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.IsVisible">
|
|
<summary>
|
|
<para>Gets a value indicating whether the View is visible on screen.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is visible on screen; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.LayoutChanged">
|
|
<summary>
|
|
<para>Updates the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.MaximumCardColumns">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of card columns which can be displayed simultaneously within a View.
|
|
</para>
|
|
</summary>
|
|
<value>The maximum number of card columns displayed simultaneously within a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.MaximumCardRows">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of card rows.
|
|
</para>
|
|
</summary>
|
|
<value>The maximum number of card rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.OptionsBehavior">
|
|
<summary>
|
|
<para>Provides access to the View's behavior options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.CardOptionsBehavior"/> object containing the View's behavior options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.OptionsPrint">
|
|
<summary>
|
|
<para>Provides options that control how the View is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.CardOptionsPrint"/> object containing the View's print and export options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.OptionsView">
|
|
<summary>
|
|
<para>Provides access to the View's appearance options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.CardOptionsView"/> object containing the View's appearance options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.PaintAppearance">
|
|
<summary>
|
|
<para>Provides access to the appearance settings currently used to paint the Card View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.CardViewAppearances"/> object which provides the appearance settings currently used to paint the Card View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.PrintMaximumCardColumns">
|
|
<summary>
|
|
<para>Gets or sets a value defining the maximum number of card columns for printing/exporting.
|
|
</para>
|
|
</summary>
|
|
<value>The maximum number of printed/exported card columns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.RowCount">
|
|
<summary>
|
|
<para>Gets the number of visible cards within a Card View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the number of visible cards within a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.SetCardCollapsed(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<para>Collapses or expands the specified card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the card's handle.
|
|
|
|
</param>
|
|
<param name="collapsed">
|
|
<b>true</b> to collapse the specified card; <b>false</b> to expand the specified card.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.ShowEditor">
|
|
<summary>
|
|
<para>Invokes the focused cell's editor.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.ShowFilterPopup(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Displays a Filter DropDown for the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column for which the filter popup must be invoked.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.State">
|
|
<summary>
|
|
<para>Obtains the View's current state.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Card.CardState"/> enumeration member indicating the View's current state.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Card.CardView.SynchronizeVisual(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes a View's appearance settings with the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose appearance settings should be copied to the current View.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Card.CardView.TopLeftCardChanged">
|
|
<summary>
|
|
<para>Occurs when a Card View is being scrolled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.TopLeftCardIndex">
|
|
<summary>
|
|
<para>Gets or sets which card is displayed within the View's top-left corner.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the visible index of the card located at the top-left corner.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.VertScrollVisibility">
|
|
<summary>
|
|
<para>Gets or sets a value specifying the Card Up And Down Buttons availability.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ScrollVisibility"/> enumeration value specifying the card's scroll buttons availability.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Card.CardView.ViewRect">
|
|
<summary>
|
|
<para>Gets the bounding rectangle of the View's visible area.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Rectangle"/> structure representing the View's bounding rectangle. Coordinates are specified relative to the grid control's top-left corner.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardVisibleState">
|
|
|
|
<summary>
|
|
<para>Contains values representing the visibility state of a card.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardVisibleState.Hidden">
|
|
<summary>
|
|
<para>The card is hidden.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardVisibleState.Partially">
|
|
<summary>
|
|
<para>The card is partially visible.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardVisibleState.Visible">
|
|
<summary>
|
|
<para>The card is entirely visible.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Card.CardState">
|
|
|
|
<summary>
|
|
<para>Contains values indicating all available Card View states.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.CardDownButtonPressed">
|
|
<summary>
|
|
<para>The bottom card scroll button is presently pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.CardExpandButtonPressed">
|
|
<summary>
|
|
<para>The card's expand button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.CardUpButtonPressed">
|
|
<summary>
|
|
<para>The top card scroll button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.CloseZoomButtonPressed">
|
|
<summary>
|
|
<para>The Card View's zoom button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.Editing">
|
|
<summary>
|
|
<para>A cell editor is presently active.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.FilterPanelActiveButtonPressed">
|
|
<summary>
|
|
<para>A check box residing in a filter panel is pressed. This implies that the filter criteria applied to a Card View is going to be enabled or disabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.FilterPanelCloseButtonPressed">
|
|
<summary>
|
|
<para>A filter close button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.FilterPanelCustomizeButtonPressed">
|
|
<summary>
|
|
<para>A filter panel customize button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.FilterPanelMRUButtonPressed">
|
|
<summary>
|
|
<para>The button which is used to display a dropdown window with a list of the most recently used filter criteria is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.FilterPanelTextPressed">
|
|
<summary>
|
|
<para>The string in the filter panel which represents the filter criteria applied to a Card View is pressed. This shows/hides a dropdown window with a list of the most recently used filter criteria.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.Normal">
|
|
<summary>
|
|
<para>The View is in its normal state. No specific action is being performed at present.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.QuickCustomizeButtonPressed">
|
|
<summary>
|
|
<para>The customization button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.Scrolling">
|
|
<summary>
|
|
<para>A Card View is being scrolled. This means that an end-user has depressed the mouse wheel and moved the mouse to scroll the View's contents.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Card.CardState.Sizing">
|
|
<summary>
|
|
<para>A Card Separator is being dragged by the end-user at present. This action results in changing card width.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedRowChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedRowChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event sender. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedRowChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="prevFocusedRowHandle">
|
|
An integer value representing the handle of the previously focused row. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs.PrevFocusedRowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="focusedRowHandle">
|
|
An integer value representing the focused row handle. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs.FocusedRowHandle"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs.FocusedRowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the currently focused row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the handle of the currently focused row. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> field value if no row is currently focused.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs.PrevFocusedRowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the previously focused row.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the handle of the previously focused row. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> field value if no row was previously focused.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedColumnChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedColumnChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event sender. Identifies the View that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedColumnChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs.#ctor(DevExpress.XtraGrid.Columns.GridColumn,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="prevFocusedColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the previously focused column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs.PrevFocusedColumn"/> property.
|
|
|
|
</param>
|
|
<param name="focusedColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the currently focused column. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs.FocusedColumn"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs.FocusedColumn">
|
|
<summary>
|
|
<para>Gets the currently focused column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the currently focused column. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column s currently focused.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.FocusedColumnChangedEventArgs.PrevFocusedColumn">
|
|
<summary>
|
|
<para>Gets the previously focused column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the previously focused column. <b>null</b> (<b>Nothing</b> in Visual Basic) if no column was previously focused.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ColumnView">
|
|
|
|
<summary>
|
|
<para>Serves as the base for Views that display data in a tabular format and allow editing of cell values by using inplace editors.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.ActiveEditor">
|
|
<summary>
|
|
<para>Gets a View's active editor.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.BaseEdit"/> object representing the currently active editor. <b>null</b> (<b>Nothing</b> in Visual Basic) if no cell is being edited at the moment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.ActiveFilter">
|
|
<summary>
|
|
<para>Gets an object which represents the filter criteria for the current View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewFilter"/> object representing the filter criteria for the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.ActiveFilterCriteria">
|
|
<summary>
|
|
<para>Gets or sets the current filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object which represents the total filter criteria.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.ActiveFilterEnabled">
|
|
<summary>
|
|
<para>Gets or sets whether the filtering functionality is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the filtering functionality is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.ActiveFilterString">
|
|
<summary>
|
|
<para>Gets or sets the total filter expression for the current View.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies the total filter expression applied to the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.AddNewRow">
|
|
<summary>
|
|
<para>Adds a new record.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ApplyColumnsFilter">
|
|
<summary>
|
|
<para>Enables the filtering functionality.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ApplyFindFilter(System.String)">
|
|
<summary>
|
|
<para>Searches for the specified string, using the search functionality provided by the Find Panel.
|
|
</para>
|
|
</summary>
|
|
<param name="filter">
|
|
A string to be located within the grid's data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.Assign(DevExpress.XtraGrid.Views.Base.BaseView,System.Boolean)">
|
|
<summary>
|
|
<para>Copies properties and, optionally, event handlers from another View to the current one.
|
|
</para>
|
|
</summary>
|
|
<param name="v">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object representing a View whose properties and event handlers are to be copied.
|
|
|
|
</param>
|
|
<param name="copyEvents">
|
|
<b>true</b> if event handlers should be copied; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.AsyncCompleted">
|
|
<summary>
|
|
<para>Fires when async data loading has finished.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.BeforeLeaveRow">
|
|
<summary>
|
|
<para>Enables you to prevent row focus changes.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.BeginDataUpdate">
|
|
<summary>
|
|
<para>Prevents visual and internal data updates until the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.EndDataUpdate"/> method is called.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.BeginSort">
|
|
<summary>
|
|
<para>Prevents visual and internal data updates until the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.EndDataUpdate"/> method is called.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.CalcColumnBestWidth(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the minimum width that the specified column needs to display its contents completely.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object which represents the grid column.
|
|
|
|
</param>
|
|
<returns>An integer value which specifies the minimum width which is required to display the column's contents completely. <b>0</b> if the specified column is a null reference.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.CancelUpdateCurrentRow">
|
|
<summary>
|
|
<para>Cancels changes made to focused row cells.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.CanGroupColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether grouping by a specific column is enabled.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object specifying the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b>, if rows can be grouped by specific column values; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.CanResizeColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether end-users can resize a specific column by dragging its right edge.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can resize the specified column; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.CanShowEditor">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View can activate cell editors.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View can activate cell editors; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.CanSortColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Indicates whether end-users can sort data by the specified column's values.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the tested column.
|
|
|
|
</param>
|
|
<returns><b>true</b> if end-users can involve the specified column in sorting; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanged">
|
|
<summary>
|
|
<para>Fires immediately after a cell's value has been changed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanging">
|
|
<summary>
|
|
<para>Fires in response to changing the edit value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ClearColumnErrors">
|
|
<summary>
|
|
<para>Removes error descriptions for the focused row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ClearColumnsFilter">
|
|
<summary>
|
|
<para>Removes any filter conditions applied to the View's columns.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ClearSelection">
|
|
<summary>
|
|
<para>Unselects any selected rows in the current View when multiple row selection is enabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ClearSorting">
|
|
<summary>
|
|
<para>Clears sorting applied to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ColumnChanged">
|
|
<summary>
|
|
<para>Fires when changing a column's properties.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ColumnFilterChanged">
|
|
<summary>
|
|
<para>Occurs when a column's filter condition is changed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ColumnPositionChanged">
|
|
<summary>
|
|
<para>Allows you to respond to changing a column's position within the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.Columns">
|
|
<summary>
|
|
<para>Provides access to a View's column collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnCollection"/> object representing a collection of all columns within a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ColumnUnboundExpressionChanged">
|
|
<summary>
|
|
<para>Fires after a column's <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.UnboundExpression"/> property has been changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnDisplayText">
|
|
<summary>
|
|
<para>Enables you to provide custom display text for column values displayed within cells, group rows and filter dropdowns.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomColumnSort">
|
|
<summary>
|
|
<para>Provides the ability to sort data using custom rules.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawEmptyForeground">
|
|
<summary>
|
|
<para>Enables a View's empty space to be custom painted when there aren't any rows displayed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomDrawFilterPanel">
|
|
<summary>
|
|
<para>Enables you to paint the filter panel manually.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomFilterDialog">
|
|
<summary>
|
|
<para>Enables the Custom Filter Dialog to be replaced with custom filtering facilities.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomFilterDisplayText">
|
|
<summary>
|
|
<para>Allows you to customize the display text representing the current filter within the filter panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomRowFilter">
|
|
<summary>
|
|
<para>Enables you to hide particular rows that exist in the data source or make them visible (regardless of the grid's filter).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.CustomUnboundColumnData">
|
|
<summary>
|
|
<para>Enables data to be provided to, and modified data to be saved from <b>visible</b> unbound columns.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.DataManagerReset">
|
|
<summary>
|
|
<para>Fires when significant data source changes occur.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.DefaultEdit">
|
|
<summary>
|
|
<para>The property is obsolete and you should not use it in your code.
|
|
</para>
|
|
</summary>
|
|
<value><b>null</b> (<b>Nothing</b> in Visual Basic) always.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.DeleteRow(System.Int32)">
|
|
<summary>
|
|
<para>Deletes a data record or group row (in Grid Views) from the View.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that represents the handle of the row to be deleted.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.DeleteSelectedRows">
|
|
<summary>
|
|
<para>Deletes the selected rows/cards in multiple selection mode or focused row/card in single selection mode.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.DisableCurrencyManager">
|
|
<summary>
|
|
<para>Gets or sets whether the View's focused record is synchronized with the current position of the corresponding CurrencyManager object.
|
|
</para>
|
|
</summary>
|
|
<value><b>false</b> if the View's focused record is synchronized with the current position of the corresponding CurrencyManager object; otherwise, <b>true</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.Editable">
|
|
<summary>
|
|
<para>Determines whether end-users can modify the View's cell values.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can activate cell editors and modify their contents; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.EditingValue">
|
|
<summary>
|
|
<para>Gets or sets the currently edited value.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the currently edited cell value. <b>null</b> (<b>Nothing</b> in Visual Basic) if no cell is presently being edited.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.EditingValueModified">
|
|
<summary>
|
|
<para>Determines whether the edited cell value has been changed since the cell editor was activated.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the edit value has been changed; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.EndGrouping">
|
|
<summary>
|
|
<para>Fires after the grouping operation has been completed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.EndSort">
|
|
<summary>
|
|
<para>Enables visual and internal data updates after the <see cref="M:DevExpress.XtraGrid.Views.Base.ColumnView.BeginSort"/> method call, and forces an immediate View update.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.EndSorting">
|
|
<summary>
|
|
<para>Fires after the sorting operation has been completed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.EnsureRowLoaded(System.Int32,DevExpress.Data.OperationCompleted)">
|
|
<summary>
|
|
<para>Loads a row (if it is not already loaded) and calls your callback method after that. This method is in effect in Instant Feedback Mode.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that specifies the handle of the row to be loaded.
|
|
|
|
</param>
|
|
<param name="completed">
|
|
A <b>DevExpress.Data.OperationCompleted</b> method that will be called when the requested row has been loaded. The method's argument will contain an array of the loaded row's field values.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FilteredColumnsCount">
|
|
<summary>
|
|
<para>Gets the number of columns that specify filtering conditions.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the number of columns whose <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.FilterInfo"/> property specifies a filter condition.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.FilterEditorCreated">
|
|
<summary>
|
|
<para>Allows you to customize the Filter Editor before it is displayed on screen.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FilterPanelText">
|
|
<summary>
|
|
<para>Gets the text displayed within the filter panel.
|
|
</para>
|
|
</summary>
|
|
<value>A string value representing the text displayed within the filter panel.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FilterPopupMaxRecordsCount">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of records whose field values can be displayed within filter dropdowns.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the maximum number of records whose field values can be displayed within filter dropdowns.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FilterPopupRowCount">
|
|
<summary>
|
|
<para>Gets or sets the maximum number of items filter dropdowns can display at once.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the maximum height of filter dropdowns. The height is specified in rows.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FindFilterText">
|
|
<summary>
|
|
<para>Gets the text displayed in the Find Panel's edit box.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies the text displayed in the Find Panel's edit box.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FindPanelVisible">
|
|
<summary>
|
|
<para>Gets or sets whether the Find Panel is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Find Panel is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedColumn">
|
|
<summary>
|
|
<para>Gets or sets the focused column/card field (in CardView and LayoutView Views).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing the currently focused column/card field.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedColumnChanged">
|
|
<summary>
|
|
<para>Fires in response to changing column focus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedRowChanged">
|
|
<summary>
|
|
<para>Fires in response to changing row focus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedRowHandle">
|
|
<summary>
|
|
<para>Gets or sets the focused record by its handle.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the handle of the focused record.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedRowLoaded">
|
|
<summary>
|
|
<para>Fires when the focused row's data has been loaded (in Instant Feedback Mode).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedRowModified">
|
|
<summary>
|
|
<para>Gets a value indicating whether the focused row's cell values have been modified since the row last received focus.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the focused row's data has been changed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.FocusedValue">
|
|
<summary>
|
|
<para>Gets the focused cell value.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the focused cell value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetColumnError(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Gets the error description for a specific cell or the entire focused row.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object identifying the cell within the focused row. <b>null</b> (<b>Nothing</b> in Visual Basic) to return the error description for the entire row.
|
|
|
|
</param>
|
|
<returns>A string value representing an error description.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetColumnErrorType(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Gets the type of the error associated with the specified cell in the currently focused row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object identifying the cell within the focused row.
|
|
|
|
</param>
|
|
<returns>An <see cref="T:DevExpress.XtraEditors.DXErrorProvider.ErrorType"/> value that specifies the type of error.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetDataRow(System.Int32)">
|
|
<summary>
|
|
<para>Returns a <see cref="T:System.Data.DataRow"/> object that represents the specified row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the row handle.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.Data.DataRow"/> object representing the specified row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetDataSourceRowIndex(System.Int32)">
|
|
<summary>
|
|
<para>Returns the index of the data source record which the specified row handle corresponds to.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the row handle.
|
|
|
|
</param>
|
|
<returns>An integer value representing the zero-based index of the data record to which the specified row handle corresponds.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetDisplayTextByColumnValue(DevExpress.XtraGrid.Columns.GridColumn,System.Object)">
|
|
<summary>
|
|
<para>Formats a value according to the specified column's format settings.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing a column whose settings are used for formatting.
|
|
|
|
</param>
|
|
<param name="val">
|
|
An object representing the value to be formatted.
|
|
|
|
</param>
|
|
<returns>A string value representing the formatted value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFilterDisplayText(DevExpress.Data.Filtering.CriteriaOperator)">
|
|
<summary>
|
|
<para>Returns the textual representation of the specified <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object.
|
|
</para>
|
|
</summary>
|
|
<param name="filter">
|
|
A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object which specifies the filter whose text representation needs to be obtained.
|
|
|
|
</param>
|
|
<returns>A string which specifies the textual representation of the specified <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFilterDisplayText(DevExpress.XtraGrid.Views.Base.ViewFilter)">
|
|
<summary>
|
|
<para>Returns the textual representation of the specified filter.
|
|
</para>
|
|
</summary>
|
|
<param name="filter">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewFilter"/> object representing the filter whose text representation needs to be obtained.
|
|
|
|
</param>
|
|
<returns>The textual representation of the specified filter.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedDataRow">
|
|
<summary>
|
|
<para>Returns a <see cref="T:System.Data.DataRow"/> object that represents the focused row.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:System.Data.DataRow"/> object representing the focused row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedDataSourceRowIndex">
|
|
<summary>
|
|
<para>Returns the index of the data source record that corresponds to the focused grid row (card).
|
|
</para>
|
|
</summary>
|
|
<returns>An integer value representing the zero-based index of the data record that corresponds to the focused grid row (card)
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedDisplayText">
|
|
<summary>
|
|
<para>Returns the focused cell's display value.
|
|
</para>
|
|
</summary>
|
|
<returns>A string representing the text displayed within the View's focused cell.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedRow">
|
|
<summary>
|
|
<para>Returns an object representing the focused row.
|
|
</para>
|
|
</summary>
|
|
<returns>An object representing the focused row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedRowCellDisplayText(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the text displayed in the specified column within the focused row.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column which contains the required cell. A <see cref="T:System.ArgumentNullException"/> exception will be thrown if this parameter is set to <b>null</b>.
|
|
|
|
</param>
|
|
<returns>A string representing the text displayed within the specified column in the focused row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedRowCellDisplayText(System.String)">
|
|
<summary>
|
|
<para>Gets the display value of the specified cell in the focused row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string identifying the field name of the column which contains the required cell. A <see cref="T:System.ArgumentNullException"/> exception will be thrown if the current View does not contain a column with the specified field name.
|
|
|
|
</param>
|
|
<returns>A string representing the text displayed within the specified column in the focused row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedRowCellValue(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the specified column's edit value within the focused row.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column which contains the required cell.
|
|
|
|
</param>
|
|
<returns>An object representing the cell's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedRowCellValue(System.String)">
|
|
<summary>
|
|
<para>Returns the edit value of the specified cell within the focused row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string identifying the field name of the column which contains the required cell. A <see cref="T:System.NullReferenceException"/> exception will be thrown if the underlying data source does not contain a column with the specified field name.
|
|
|
|
</param>
|
|
<returns>An object representing the cell's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetFocusedValue">
|
|
<summary>
|
|
<para>Returns the focused cell's value.
|
|
</para>
|
|
</summary>
|
|
<returns>An object that is the focused cell's value.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetIncrementalText">
|
|
<summary>
|
|
<para>Returns the text being searched during an incremental search.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that represents the text being searched.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetListSourceRowCellValue(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Returns the value of the specified cell, which is identified by a field name and the index of a record in the data source.
|
|
</para>
|
|
</summary>
|
|
<param name="listSourceRowIndex">
|
|
An integer value representing the index of the record in the underlying data source.
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string representing the field name.
|
|
|
|
</param>
|
|
<returns>An object representing the required cell's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetListSourceRowCellValue(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the value of the specified cell, which is identified by a column and the index of a record in the data source.
|
|
</para>
|
|
</summary>
|
|
<param name="listSourceRowIndex">
|
|
An integer value representing the index of the record in the underlying data source.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object identifying a field in the data source.
|
|
|
|
</param>
|
|
<returns>An object representing the required cell's value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetNearestCanFocusedColumn(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns the nearest column to the specified one that can be focused.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column which will be used as the search point.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the nearest column that can be focused.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetNextVisibleRow(System.Int32)">
|
|
<summary>
|
|
<para>Returns the visible index of the row that follows a specific row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value specifying a specific row's visible index, whose next visible row's index is to be obtained. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value is returned if the <i>rowVisibleIndex</i> parameter is equal to or greater than <see cref="P:DevExpress.XtraGrid.Views.Base.BaseView.RowCount"/>.
|
|
|
|
|
|
</param>
|
|
<returns>An integer value specifying the following row's visible index.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetPrevVisibleRow(System.Int32)">
|
|
<summary>
|
|
<para>Gets the visible index of the row that is located prior to the specified row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value specifying the visible index of the row located below the required row.
|
|
|
|
</param>
|
|
<returns>An integer value which specifies the visible index of the previous row. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value is returned if the <i>rowVisibleIndex</i> parameter is equal to or less then <b>0</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetRow(System.Int32)">
|
|
<summary>
|
|
<para>Returns an object that represents the specified row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the desired row handle.
|
|
|
|
</param>
|
|
<returns>An object representing a specific row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetRowCellDisplayText(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns a specific cell's display value from the current View.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the row where the desired cell resides.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing a column containing the desired cell.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> value representing a cell's display text.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetRowCellDisplayText(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Gets the display value of the specified cell.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the handle of the row in which the desired cell resides.
|
|
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string representing the field name of the column that contains the required cell. A <see cref="T:System.ArgumentNullException"/> exception will be thrown if the current View does not contain a column with the specified field name.
|
|
|
|
</param>
|
|
<returns>A string representing the required cell's display text.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetRowCellValue(System.Int32,DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Returns a specific cell value from the current View.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing a handle of the row where the desired cell resides.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing a column that contains the desired cell.
|
|
|
|
</param>
|
|
<returns>An object representing a specific cell value.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetRowCellValue(System.Int32,System.String)">
|
|
<summary>
|
|
<para>Gets the value of the specified cell in the grid's data source.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row in which the desired cell resides.
|
|
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string representing the field name of the column that contains the required cell. A <see cref="T:System.NullReferenceException"/> exception will be thrown if the underlying data source does not contain a column with the specified field name.
|
|
|
|
</param>
|
|
<returns>An object representing the specified cell's value.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Returns the handle of the row which represents the specified record in the data source.
|
|
</para>
|
|
</summary>
|
|
<param name="dataSourceIndex">
|
|
The zero-based index of a record in the data source.
|
|
|
|
|
|
</param>
|
|
<returns>An integer value which represents the handle of the row which corresponds to the specified record in the data source.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetSelectedRows">
|
|
<summary>
|
|
<para>Returns the handles of the selected rows or cards.
|
|
</para>
|
|
</summary>
|
|
<returns>An array of integer values representing the handles of the selected rows or cards. An empty array if no rows are selected.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetShowEditorMode">
|
|
<summary>
|
|
<para>Returns a value that specifies how an in-place editor is activated for a grid cell.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.Utils.EditorShowMode"/> enumeration value which specifies how a cell editor is activated.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetVisibleColumn(System.Int32)">
|
|
<summary>
|
|
<para>Returns the column displayed at a specific position.
|
|
</para>
|
|
</summary>
|
|
<param name="visibleIndex">
|
|
An integer value representing the visible index of the desired column. This parameter value corresponds to the <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.VisibleIndex"/> property of columns.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing a column displayed at a specific position. <b>null</b> (<b>Nothing</b> in Visual Basic) if there are no columns with the specified visible index.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetVisibleIndex(System.Int32)">
|
|
<summary>
|
|
<para>Returns the visible index of the row specified by its handle.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the row's handle.
|
|
|
|
</param>
|
|
<returns>An integer value representing the specified record's visible index. <b>-1</b> if the specified record is hidden within a collapsed group (in Grid Views).
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.GetVisibleRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Returns the handle of the row which is displayed at the specified position.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowVisibleIndex">
|
|
An integer value specifying the row's visible index.
|
|
|
|
|
|
</param>
|
|
<returns>An integer value representing the corresponding row handle. The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value is returned if an invalid index is passed as the parameter.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.GroupCount">
|
|
<summary>
|
|
<para>Gets or sets how many columns are used to group data.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>The number of columns used to group data.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.GroupedColumns">
|
|
<summary>
|
|
<para>Gets the collection of columns involved in data grouping.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection"/> object representing a read-only collection of columns involved in grouping.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.HasColumnErrors">
|
|
<summary>
|
|
<para>Indicates whether the focused row or at least a single cell within the focused row has an error assigned.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the focused row has errors; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.HiddenEditor">
|
|
<summary>
|
|
<para>Fires immediately after an inplace editor has been closed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.HideEditor">
|
|
<summary>
|
|
<para>Closes the currently active inplace editor discarding changes made to the edited value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.HideFindPanel">
|
|
<summary>
|
|
<para>Hides the Find Panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.Images">
|
|
<summary>
|
|
<para>Gets or sets a collection of images that can be displayed within column headers and band headers.
|
|
</para>
|
|
</summary>
|
|
<value>An object that is an image collection providing images for the View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.InitNewRow">
|
|
<summary>
|
|
<para>Enables you to initialize added rows.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.InvalidRowException">
|
|
<summary>
|
|
<para>Fires when a row fails validation or when it cannot be saved to the data source.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.InvertRowSelection(System.Int32)">
|
|
<summary>
|
|
<para>Toggles the specified row's selected state.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the row by its handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsAsyncInProgress">
|
|
<summary>
|
|
<para>Gets whether async data loading is in progress. This property is in effect in Instant Feedback Mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if async data loading is in progress; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.IsDataRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified record is a regular data row/card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the tested record by its handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified record is a regular data row/card; otherwise, <b>false</b>.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsEditorFocused">
|
|
<summary>
|
|
<para>Gets a value indicating whether the active editor has input focus.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the active editor has input focus; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsEmpty">
|
|
<summary>
|
|
<para>Determines whether a View contains any rows.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if there are no rows within a specific view; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsFindPanelVisible">
|
|
<summary>
|
|
<para>Gets whether the Find Panel is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the Find Panel is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsFirstRow">
|
|
<summary>
|
|
<para>Determines whether the first visible data or group row is focused.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the first visible data or group row is focused; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsFocusedRowLoaded">
|
|
<summary>
|
|
<para>Gets whether the focused row's data has been loaded (in Instant Feedback Mode).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the data has been loaded; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsFocusedView">
|
|
<summary>
|
|
<para>Determines whether a View has input focus.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View has input focus; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsLastRow">
|
|
<summary>
|
|
<para>Determines whether the last visible data or group row is focused.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the last visible data or group row is focused; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsLastVisibleRow">
|
|
<summary>
|
|
<para>Determines whether the last visible row is focused.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the last visible row is focused; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsMultiSelect">
|
|
<summary>
|
|
<para>Indicates whether multiple rows (cards) can be selected.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if multiple rows (cards) can be selected; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.IsNewItemRow(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row/card is the New Item Row/Card.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the inspected row/card.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row/card is used to enter a new record; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.IsRowLoaded(System.Int32)">
|
|
<summary>
|
|
<para>Gets whether the specified row's data has been loaded (in Instant Feedback Mode).
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer that specifies the handle of the required row.
|
|
|
|
|
|
</param>
|
|
<returns><b>true</b> if the data has been loaded; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.IsRowSelected(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row is selected.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
The handle of the inspected row.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the specified row is selected; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsShowFilterPanel">
|
|
<summary>
|
|
<para>Determines whether the filter panel is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the filter panel is visible; otherwise <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.IsValidRowHandle(System.Int32)">
|
|
<summary>
|
|
<para>Indicates whether the specified row handle is valid.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value specifying the row's handle.
|
|
|
|
</param>
|
|
<returns><b>true</b> if the row's handle is valid; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.IsZoomedView">
|
|
<summary>
|
|
<para>Determines whether the current detail View is maximized.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current detail View is maximized; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.LoadRow(System.Int32)">
|
|
<summary>
|
|
<para>Loads a row in Instant Feedback Mode.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value that is the row handle of the row to be loaded.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.LocateByDisplayText(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.String)">
|
|
<summary>
|
|
<para>Locates rows by cells' display texts.
|
|
</para>
|
|
</summary>
|
|
<param name="startRowHandle">
|
|
An integer value specifying the handle of the row where the search starts.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) specifying the column whose cells' display texts are compared to the search text.
|
|
|
|
</param>
|
|
<param name="text">
|
|
A string to search for.
|
|
|
|
</param>
|
|
<returns>An integer value specifying the handle of the row found. If no matching row found, the <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> field value is returned instead.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.LocateByValue(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Object,DevExpress.Data.OperationCompleted[])">
|
|
<summary>
|
|
<para>Locates rows by cell values.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="startRowHandle">
|
|
An integer value specifying the handle of the row where the search starts. In server mode, this parameter must be set to 0.
|
|
|
|
</param>
|
|
<param name="column">
|
|
The <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object (or descendant) that is the column whose cells' values are compared to the search value.
|
|
|
|
|
|
</param>
|
|
<param name="val">
|
|
An object representing the value to search for.
|
|
|
|
</param>
|
|
<param name="completed">
|
|
A <b>DevExpress.Data.OperationCompleted</b> method that will be called when the requested operation is completed. The method's argument will contain the requested value.
|
|
|
|
</param>
|
|
<returns>If the specified value is loaded, the method returns an integer value specifying the handle of the row found.
|
|
<para>
|
|
In Instant Feedback Mode (async server mode), the <b>DevExpress.Data.DataController.OperationInProgress</b> value is returned if the requested search value is not currently loaded.
|
|
</para>
|
|
<para>
|
|
The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value, if no row is found that matches the specified condition.
|
|
</para>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.LocateByValue(System.String,System.Object,DevExpress.Data.OperationCompleted[])">
|
|
<summary>
|
|
<para>Locates rows by cell values.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string that specifies the target column's field name.
|
|
|
|
</param>
|
|
<param name="val">
|
|
An object that is the value to search for.
|
|
|
|
|
|
</param>
|
|
<param name="completed">
|
|
A <b>DevExpress.Data.OperationCompleted</b> method that will be called when the requested operation is completed. The method's argument will contain the requested value.
|
|
|
|
</param>
|
|
<returns>If the specified value is loaded, the method returns an integer value specifying the handle of the row found.
|
|
<para>
|
|
In Instant Feedback Mode (async server mode), the <b>DevExpress.Data.DataController.OperationInProgress</b> value is returned if the requested search value is not currently loaded.
|
|
</para>
|
|
<para>
|
|
The <see cref="F:DevExpress.XtraGrid.GridControl.InvalidRowHandle"/> value, if no row is found that matches the specified condition.
|
|
</para>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MoveBy(System.Int32)">
|
|
<summary>
|
|
<para>Moves row focus by the specified number of rows.
|
|
</para>
|
|
</summary>
|
|
<param name="delta">
|
|
An integer value representing a row focus offset.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MoveFirst">
|
|
<summary>
|
|
<para>Moves focus to the first row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MoveLast">
|
|
<summary>
|
|
<para>Moves focus to the last data record.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MoveLastVisible">
|
|
<summary>
|
|
<para>Moves focus to the last visible row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MoveNext">
|
|
<summary>
|
|
<para>Moves focus to the row which is after the focused row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MoveNextPage">
|
|
<summary>
|
|
<para>Moves focus to the next page.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MovePrev">
|
|
<summary>
|
|
<para>Moves focus to the previous row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.MovePrevPage">
|
|
<summary>
|
|
<para>Moves focus to the previous page.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.MRUFilters">
|
|
<summary>
|
|
<para>Provides access to the View's most recently used filters.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.MRUViewFilterCollection"/> object that stores the filters recently used on the View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.NormalView">
|
|
<summary>
|
|
<para>Cancels View zooming.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.OptionsBehavior">
|
|
<summary>
|
|
<para>Provides access to the View's behavior options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsBehavior"/> object containing the View's behavior options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.OptionsFilter">
|
|
<summary>
|
|
<para>Provides access to the View's filtering options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFilter"/> object containing the View's filtering options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.OptionsFind">
|
|
<summary>
|
|
<para>Provides access to settings controlling the behavior and visibility of the Find Panel and its elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsFind"/> object.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.OptionsLayout">
|
|
<summary>
|
|
<para>Provides options which control how the current View's layout is stored to/restored from a data store (a stream, xml file or system registry).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.OptionsLayoutGrid"/> descendant which provides options for controlling how the layout is stored and restored.
|
|
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.OptionsSelection">
|
|
<summary>
|
|
<para>Provides access to the View's selection options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsSelection"/> object containing the View's selection options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.OptionsView">
|
|
<summary>
|
|
<para>Provides access to the View's display options.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnViewOptionsView"/> object which contains the View's display options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.PopulateColumns(System.Data.DataTable)">
|
|
<summary>
|
|
<para>Creates columns for all the fields of the specified <see cref="T:System.Data.DataTable"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="dt">
|
|
A <see cref="T:System.Data.DataTable"/> object representing a data table whose fields will provide data for the created columns.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.PopulateColumns">
|
|
<summary>
|
|
<para>Creates columns for all fields in the bound data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.PopulateColumns(System.Object)">
|
|
<summary>
|
|
<para>Creates columns for all the fields in the specified data source (<see cref="T:System.Data.DataTable"/>, DevExpress.XtraGrid.IXtraList or <see cref="T:System.ComponentModel.ITypedList"/>).
|
|
</para>
|
|
</summary>
|
|
<param name="list">
|
|
An object providing data for the columns created.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.PopulateColumns(DevExpress.Data.DataColumnInfo[])">
|
|
<summary>
|
|
<para>Creates columns for the specified <b>DataColumnInfo</b> objects.
|
|
</para>
|
|
</summary>
|
|
<param name="columns">
|
|
An array of <b>DataColumnInfo</b> objects containing information on the columns to be created.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.RefreshData">
|
|
<summary>
|
|
<para>Reloads data into View from the data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.RefreshEditor(System.Boolean)">
|
|
<summary>
|
|
<para>Refreshes the active editor.
|
|
</para>
|
|
</summary>
|
|
<param name="updateEditorValue">
|
|
<b>true</b> if the editor should update the value it displays; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.RefreshRow(System.Int32)">
|
|
<summary>
|
|
<para>Refreshes the specified row.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value which identifies the row.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowCellDefaultAlignment">
|
|
<summary>
|
|
<para>Enables you to specify content alignment for individual cells.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.RowFilter">
|
|
<summary>
|
|
<para>Gets the expression used to filter the records displayed within the View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A string value representing the expression used to filter records. An empty string if no filtering is currently applied.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowLoaded">
|
|
<summary>
|
|
<para>Fires when a row's data has been loaded (in Instant Feedback Mode).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.RowUpdated">
|
|
<summary>
|
|
<para>Occurs after the modified focused row has been saved to the underlying data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SelectAll">
|
|
<summary>
|
|
<para>Selects all rows (cards) within the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.SelectedRowsCount">
|
|
<summary>
|
|
<para>Gets the number of selected rows (cards).
|
|
</para>
|
|
</summary>
|
|
<value>An integer value indicating the number of selected rows (cards).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.SelectionChanged">
|
|
<summary>
|
|
<para>Fires when row/cell selection is changed in multiple selection mode.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SelectRange(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Selects the visible rows (cards) in the specified range.
|
|
</para>
|
|
</summary>
|
|
<param name="startRowHandle">
|
|
An integer value specifying the row handle at which the selection starts.
|
|
|
|
</param>
|
|
<param name="endRowHandle">
|
|
An integer value specifying the row handle at which the selection ends.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SelectRow(System.Int32)">
|
|
<summary>
|
|
<para>Adds a row (card) to the current selection.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the row (card) to be selected by its handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetColumnError(DevExpress.XtraGrid.Columns.GridColumn,System.String)">
|
|
<summary>
|
|
<para>Sets an error description for a cell within the focused row or for the entire focused row.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing a column that contains an error cell. <b>null</b> (<b>Nothing</b> in Visual Basic) if the error description should be assigned to the entire focused row.
|
|
|
|
</param>
|
|
<param name="errorText">
|
|
A string value representing an error description. An empty string to clear the assigned error.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetColumnError(DevExpress.XtraGrid.Columns.GridColumn,System.String,DevExpress.XtraEditors.DXErrorProvider.ErrorType)">
|
|
<summary>
|
|
<para>Sets an error description and an error type for the specified cell within the focused row.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> that identifies the cell to which an error is set.
|
|
|
|
</param>
|
|
<param name="errorText">
|
|
A string value representing an error description. An empty string to clear the assigned error.
|
|
|
|
|
|
</param>
|
|
<param name="errorType">
|
|
An <see cref="T:DevExpress.XtraEditors.DXErrorProvider.ErrorType"/> value that specifies the type of the error. Error types correspond to specific error icons.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetFocusedRowCellValue(DevExpress.XtraGrid.Columns.GridColumn,System.Object)">
|
|
<summary>
|
|
<para>Assigns a value to the specified column within the currently focused row.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column in which the required cell resides.
|
|
|
|
</param>
|
|
<param name="value">
|
|
An object representing the value to be assigned.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetFocusedRowCellValue(System.String,System.Object)">
|
|
<summary>
|
|
<para>Assigns a value to the specified field within the currently focused row.
|
|
</para>
|
|
</summary>
|
|
<param name="fieldName">
|
|
A string identifying the field name of the column which contains the required cell.
|
|
|
|
</param>
|
|
<param name="value">
|
|
An object representing the value to be assigned.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetFocusedRowModified">
|
|
<summary>
|
|
<para>Marks the focused row as modified.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetFocusedValue(System.Object)">
|
|
<summary>
|
|
<para>Assigns a value to the focused cell.
|
|
</para>
|
|
</summary>
|
|
<param name="value">
|
|
An object representing the value to be assigned.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetRowCellValue(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Object)">
|
|
<summary>
|
|
<para>Assigns a value to a specific cell.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing a row handle containing the desired cell.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object or descendant representing a column containing the desired cell.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
An object representing the value to be assigned.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SetRowCellValue(System.Int32,System.String,System.Object)">
|
|
<summary>
|
|
<para>Sets the value of the specified cell in the current View.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row which contains the desired cell.
|
|
|
|
|
|
</param>
|
|
<param name="fieldName">
|
|
A string representing the field name that identifies the required cell.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
An object representing the value to be assigned.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.ShowButtonMode">
|
|
<summary>
|
|
<para>Gets or sets a value specifying editor button display mode.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum"/> enumeration value specifying the manner in which editor buttons are displayed within a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ShowCustomFilterDialog(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Displays the custom filter dialog.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column whose filtering settings will be modified by the custom filter dialog.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterEditor(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Displays the Filter Editor.
|
|
</para>
|
|
</summary>
|
|
<param name="defaultColumn">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column to which a filter is applied in the Filter Editor.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopup(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Displays a Filter DropDown for the specified column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> column for which the filter popup must be invoked.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupCheckedListBox">
|
|
<summary>
|
|
<para>Allows you to customize checked filter dropdown lists before they are displayed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupDate">
|
|
<summary>
|
|
<para>Allows you to customize the filter dropdown for date-time columns.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFilterPopupListBox">
|
|
<summary>
|
|
<para>Enables you to customize a particular column's filter dropdown list.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ShowFindPanel">
|
|
<summary>
|
|
<para>Displays the Find Panel.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShowingEditor">
|
|
<summary>
|
|
<para>Allows you to cancel editor activation.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ShownEditor">
|
|
<summary>
|
|
<para>Fires immediately after a cell editor has been invoked.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ShowUnboundExpressionEditor(DevExpress.XtraGrid.Columns.GridColumn)">
|
|
<summary>
|
|
<para>Invokes an <b>Expression Editor</b> that enables editing an expression for the specified unbound column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> that represents an unbound column whose expression will be edited in the Expression Editor.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.SortedColumns">
|
|
<summary>
|
|
<para>Gets the collection of columns involved in sorting.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection"/> object representing the collection of columns involved in sorting.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.SortInfo">
|
|
<summary>
|
|
<para>Provides access to the collection of sorted and grouping columns within the current View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnSortInfoCollection"/> collection containing information on the sorted and grouping columns within the View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.StartGrouping">
|
|
<summary>
|
|
<para>Fires before a grouping operation is started.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.StartSorting">
|
|
<summary>
|
|
<para>Fires before a sorting operation is started.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SynchronizeData(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes a View's data representation settings with the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose data representation settings should be copied to the current View.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.SynchronizeVisual(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes a View's visual settings with the specified View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View whose visual settings should be copied to the current View.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.UnboundExpressionEditorCreated">
|
|
<summary>
|
|
<para>Fires after an <b>Expression Editor</b> has been created for an unbound column.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.UnselectRow(System.Int32)">
|
|
<summary>
|
|
<para>Removes a row (card) from the current selection.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value identifying the row (card) by its handle.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.UpdateCurrentRow">
|
|
<summary>
|
|
<para>Validates the focused row and saves its values to the data source.
|
|
</para>
|
|
</summary>
|
|
<returns><b>true</b> if the row has been successfully updated; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ValidateEditor">
|
|
<summary>
|
|
<para>Validates the active editor.
|
|
</para>
|
|
</summary>
|
|
<returns><b>true</b> if editor validation succeeded; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.ColumnView.ValidateRow">
|
|
<summary>
|
|
<para>Enables you to specify whether a modified row's data is valid, and whether the row can lose focus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.ViewCaptionHeight">
|
|
<summary>
|
|
<para>Gets or sets the height of the View Caption region.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the height of the View Caption region.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.ViewRowHandleToDataSourceIndex(System.Int32)">
|
|
<summary>
|
|
<para>Converts the specified row handle to a data source record index.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the row handle to convert.
|
|
|
|
</param>
|
|
<returns>An integer value representing the zero-based data record index.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.ColumnView.VisibleColumns">
|
|
<summary>
|
|
<para>Gets the visible columns collection.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumnReadOnlyCollection"/> object representing the visible columns collection.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.ColumnView.WaitForAsyncOperationEnd">
|
|
<summary>
|
|
<para>This member supports the internal infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CellValueChangedEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanging"/> and <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanged"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CellValueChangedEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanging"/> and <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanged"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event sender (the <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing the View that raised the event).
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanging"/> and <see cref="E:DevExpress.XtraGrid.Views.Base.ColumnView.CellValueChanged"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs.#ctor(System.Int32,DevExpress.XtraGrid.Columns.GridColumn,System.Object)">
|
|
<summary>
|
|
<para>Creates an instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs"/> class.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the handle of the row where a cell resides. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs.RowHandle"/> property.
|
|
|
|
</param>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column where the cell resides. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs.Column"/> property.
|
|
|
|
</param>
|
|
<param name="value">
|
|
An object representing the new cell value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs.Column">
|
|
<summary>
|
|
<para>Gets the column that contains the processed cell.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object representing the column whose cell is processed by the event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs.RowHandle">
|
|
<summary>
|
|
<para>Gets the handle of the row that contains the processed cell.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value indicating the handle of the row whose cell is processed by the event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs.Value">
|
|
<summary>
|
|
<para>Gets the current cell value.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing the current cell value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.BaseView">
|
|
|
|
<summary>
|
|
<para>Serves as the base for objects representing Views in a grid control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.#ctor">
|
|
<summary>
|
|
<para>Creates a new instance of the <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.ActiveEditor">
|
|
<summary>
|
|
<para>Gets the active editor within a View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.BaseEdit"/> descendant representing the active editor within the current View. <b>null</b> (<b>Nothing</b> in Visual Basic) if no cell is being edited at the moment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.ActivePaintStyleName">
|
|
<summary>
|
|
<para>Gets the name of the currently applied painting scheme.
|
|
</para>
|
|
</summary>
|
|
<value>A string representing the name of the currently applied painting scheme.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.Appearance">
|
|
<summary>
|
|
<para>Provides access to the properties that control the appearance of the View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.BaseAppearanceCollection"/> object that provides the base appearance settings for View elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.AppearancePrint">
|
|
<summary>
|
|
<para>Provides access to the properties that specify the appearances of View elements when they are printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.BaseAppearanceCollection"/> object that provides the print/export appearance settings for View elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Assign(DevExpress.XtraGrid.Views.Base.BaseView,System.Boolean)">
|
|
<summary>
|
|
<para>Copies the settings of a View object to the current one.
|
|
</para>
|
|
</summary>
|
|
<param name="v">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object or descendant representing the source of the operation.
|
|
|
|
</param>
|
|
<param name="copyEvents">
|
|
<b>true</b>, if event handlers assigned to the source <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> object should be assigned to the corresponding events of the destination View object; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.BaseInfo">
|
|
<summary>
|
|
<para>Gets an object providing information for creating and initializing the View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Registrator.BaseInfoRegistrator"/> object containing information necessary to create and initialize the View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.BeforeLoadLayout">
|
|
<summary>
|
|
<para>Occurs before a layout is restored from storage (a stream, xml file or the system registry).
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.BeginDataUpdate">
|
|
<summary>
|
|
<para>Prevents visual and internal data updates until the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.EndDataUpdate"/> method is called.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.BeginInit">
|
|
<summary>
|
|
<para>Starts the runtime View initialization.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.BeginSelection">
|
|
<summary>
|
|
<para>Prevents selection updates until the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.EndSelection"/> or the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.CancelSelection"/> method is called.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.BeginUpdate">
|
|
<summary>
|
|
<para>Locks the BaseView by preventing visual updates of the object and its elements until the <b>EndUpdate</b> method is called.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.BorderStyle">
|
|
<summary>
|
|
<para>Gets or sets the border style for the current View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Controls.BorderStyles"/> enumeration value specifying the border style of a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CalcHitInfo(System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Returns information about the View elements located at the specified point.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="x">
|
|
An integer representing the X coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<param name="y">
|
|
An integer representing the Y coordinate of the test point relative to the top-left corner of the grid control.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/> class descendant that contains information on the View elements located at the test point.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CalcHitInfo(System.Drawing.Point)">
|
|
<summary>
|
|
<para>Returns information about the View elements located at the specified point.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="pt">
|
|
A <see cref="T:System.Drawing.Point"/> structure specifying the test point coordinates relative to the top-left corner of the grid control.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/> class descendant that contains information about the View elements located at the test point.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CancelSelection">
|
|
<summary>
|
|
<para>Enables selection updates after the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.BeginSelection"/> method call, but doesn't force an immediate update.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CheckLoaded">
|
|
<summary>
|
|
<para>Forces the grid control to finish its initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ClearDocument">
|
|
<summary>
|
|
<para>Clears a print/export document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.Click">
|
|
<summary>
|
|
<para>Occurs when a View is clicked.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CloseEditor">
|
|
<summary>
|
|
<para>Hides the active editor saving changes made.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Connect(System.Object)">
|
|
<summary>
|
|
<para>Connects the View to the specified object.
|
|
</para>
|
|
</summary>
|
|
<param name="connector">
|
|
An object representing the control to connect the current View to.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CopyToClipboard">
|
|
<summary>
|
|
<para>Copies the selected record(s) to the clipboard as text.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CreateDocument">
|
|
<summary>
|
|
<para>Creates a print/export document based on the View's current data.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.CreateExportLink(DevExpress.XtraExport.IExportProvider)">
|
|
<summary>
|
|
<para>Returns an object that enables you to export a View's data in a number of different formats.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object implementing the <see cref="T:DevExpress.XtraExport.IExportProvider"/> interface that exports the data.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Export.BaseExportLink"/> object (or descendant) providing exporting facilities.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.DataController">
|
|
<summary>
|
|
<para>Gets the data controller which implements data-aware operations.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.BaseGridController"/> object which represents the data controller.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.DataRowCount">
|
|
<summary>
|
|
<para>Gets how many data rows are contained within the View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value providing a count of the number of data rows in the View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.DataSource">
|
|
<summary>
|
|
<para>Gets the data source whose data is displayed by a View.
|
|
</para>
|
|
</summary>
|
|
<value>A data source object whose data is displayed by the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.DataSourceChanged">
|
|
<summary>
|
|
<para>Occurs when the data source of the current View changes.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.DetailHeight">
|
|
<summary>
|
|
<para>Gets or sets the height of a View when it serves as a detail View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the View height in pixels.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.DetailLevel">
|
|
<summary>
|
|
<para>Gets the nesting level of a View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the nesting level of a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.DetailTabHeaderLocation">
|
|
<summary>
|
|
<para>Gets or sets the position of detail tabs within detail sections.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraTab.TabHeaderLocation"/> enumeration value specifying the position of detail tabs.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Disconnect(System.Object)">
|
|
<summary>
|
|
<para>Removes the connection between the View and the specified object.
|
|
</para>
|
|
</summary>
|
|
<param name="connector">
|
|
An object representing the control which the View is to be disconnected from.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.DoubleClick">
|
|
<summary>
|
|
<para>Occurs when a View is double-clicked.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.Editable">
|
|
<summary>
|
|
<para>Determines whether end-users can modify the View's cell values.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if end-users can activate cell editors and modify their contents; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.EndDataUpdate">
|
|
<summary>
|
|
<para>Enables visual and internal data updates after the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.BeginDataUpdate"/> method call, and forces an immediate View update.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.EndInit">
|
|
<summary>
|
|
<para>Ends the runtime View initialization.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.EndSelection">
|
|
<summary>
|
|
<para>Enables selection updates after calling the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.BeginSelection"/> method and forces an immediate update.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.EndUpdate">
|
|
<summary>
|
|
<para>Unlocks the BaseView object after a call to the <b>BeginUpdate</b> method and causes an immediate visual update.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Export(DevExpress.XtraPrinting.ExportTarget,System.IO.Stream,DevExpress.XtraPrinting.ExportOptionsBase)">
|
|
<summary>
|
|
<para>Exports the View's data in the specified format to a stream, using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="target">
|
|
An <see cref="T:DevExpress.XtraPrinting.ExportTarget"/> value that specifies the format in which the View's data is exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the data is exported.
|
|
|
|
|
|
</param>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.XtraPrinting.ExportOptionsBase"/> descendant that provides export options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Export(DevExpress.XtraPrinting.ExportTarget,System.String)">
|
|
<summary>
|
|
<para>Exports the View's data in the specified format to a file.
|
|
</para>
|
|
</summary>
|
|
<param name="target">
|
|
An <see cref="T:DevExpress.XtraPrinting.ExportTarget"/> value that specifies the format in which the View's data is exported.
|
|
|
|
</param>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Export(DevExpress.XtraPrinting.ExportTarget,System.String,DevExpress.XtraPrinting.ExportOptionsBase)">
|
|
<summary>
|
|
<para>Exports the View's data in the specified format to a file, using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="target">
|
|
An <see cref="T:DevExpress.XtraPrinting.ExportTarget"/> value that specifies the format in which the View's data is exported.
|
|
|
|
</param>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.XtraPrinting.ExportOptionsBase"/> descendant that provides export options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Export(DevExpress.XtraPrinting.ExportTarget,System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the View's data in the specified format to a stream.
|
|
</para>
|
|
</summary>
|
|
<param name="target">
|
|
An <see cref="T:DevExpress.XtraPrinting.ExportTarget"/> value that specifies the format in which the View's data is exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the data is exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToCsv(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified stream in CSV format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A Stream to which the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToCsv(System.String)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified file in CSV format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> containing the full path to the file to which the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToCsv(System.IO.Stream,DevExpress.XtraPrinting.CsvExportOptions)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified stream in CSV format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A stream to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.CsvExportOptions"/> object which specifies the CSV export options to be applied when the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToCsv(System.String,DevExpress.XtraPrinting.CsvExportOptions)">
|
|
<summary>
|
|
<para>Exports the control's data to the specified file in CSV format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> containing the full path to the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.CsvExportOptions"/> object which specifies the CSV export options to be applied when the control is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToExcelOld(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in MS Excel format.
|
|
</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
A string that specifies the full path to the file to which the default View's data will be exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtml(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in HTML format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtml(System.String,System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to an HTML file using the specified character encoding.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> containing the full path (including the file name and extension) specifying where the HTML file will be created.
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the name of the character encoding (e.g. "UTF-8").
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtml(System.IO.Stream,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in HTML format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, which the created document is exported to.
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the HTML file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created HTML document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the HTML code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtml(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in HTML format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, which the data is exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtml(System.String,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified HTML file with the specified title, using the specified character encoding. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> containing the full path (including the file name and extension) specifying where the HTML file will be created.
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the HTML file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created HTML document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the HTML code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtml(System.IO.Stream,DevExpress.XtraPrinting.HtmlExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified stream in HTML format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.HtmlExportOptions"/> object which specifies the export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtml(System.String,DevExpress.XtraPrinting.HtmlExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in HTML format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.HtmlExportOptions"/> object which specifies the export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToHtmlOld(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in HTML format.
|
|
</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToMht(System.IO.Stream,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the data is exported.
|
|
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the MHT file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created MHT document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToMht(System.String,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the MHT file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
<param name="title">
|
|
A <see cref="T:System.String"/> containing the name shown as the title of the created MHT document.
|
|
|
|
</param>
|
|
<param name="compressed">
|
|
<b>true</b> if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToMht(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in MHT format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToMht(System.String,System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in MHT format using the specified character encoding.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
<param name="htmlCharSet">
|
|
A <see cref="T:System.String"/> representing the encoding name set in the MHT file (e.g. "UTF-8").
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToMht(System.IO.Stream,DevExpress.XtraPrinting.MhtExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified stream in MHT format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.MhtExportOptions"/> object which specifies the export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToMht(System.String,DevExpress.XtraPrinting.MhtExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in MHT format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.MhtExportOptions"/> object which specifies the export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToPdf(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToPdf(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, which the data is exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToPdf(System.String,DevExpress.XtraPrinting.PdfExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.PdfExportOptions"/> object which specifies the export options to be applied when the View's data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToRtf(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in RTF format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, which the data is exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToRtf(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to a file in RTF format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in TXT format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to a file in TXT format using the specified separator string and quotation settings.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) text elements that contain symbols which coincide with the specified separator string; otherwise, <b>false</b>.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.IO.Stream,System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in TXT format using the specified separator string.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object which the created text file should be sent to.
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in TXT format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created text file will be sent.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.String,System.String,System.Boolean,System.Text.Encoding)">
|
|
<summary>
|
|
<para>Exports the View's data to a file in TXT format using the specified separator string, quotation and text encoding settings.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file the View's data will be exported to.
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) text elements that contain symbols which coincide with the specified separator string; otherwise, <b>false</b>.
|
|
|
|
|
|
</param>
|
|
<param name="encoding">
|
|
A <see cref="T:System.Text.Encoding"/> class descendant specifying the encoding of the created text document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.IO.Stream,System.String,System.Boolean,System.Text.Encoding)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in TXT format using the specified separator string, quotation and text encoding settings.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created text file should be sent.
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) text elements that contain symbols which coincide with the specified separator string; otherwise, <b>false</b>.
|
|
|
|
|
|
</param>
|
|
<param name="encoding">
|
|
A <see cref="T:System.Text.Encoding"/> class descendant specifying the encoding of the created text document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.IO.Stream,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in TXT format using the specified separator string and quotation settings.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created text file should be sent.
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
<param name="quoteStringsWithSeparators">
|
|
<b>true</b> to quote (place quotation marks around) separator string text elements; otherwise, <b>false</b>.
|
|
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.String,System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to a file in TXT format using the specified separator string.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
<param name="separator">
|
|
A <see cref="T:System.String"/> containing symbols which will be used to separate the document's text elements in the created text file.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.IO.Stream,DevExpress.XtraPrinting.TextExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified stream in Text format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.TextExportOptions"/> object which specifies the export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToText(System.String,DevExpress.XtraPrinting.TextExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in Text format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.TextExportOptions"/> object which specifies the export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToTextOld(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in TXT format.
|
|
</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXls(System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to a file in XLS format with the specified formatting settings.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
<param name="useNativeFormat">
|
|
<b>true</b> to use the data format of the exported data fields for the cells in the XLS document; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXls(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to a file in XLS format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the View's data will be exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXls(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in XLS format with the specified formatting settings.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
|
|
</param>
|
|
<param name="useNativeFormat">
|
|
<b>true</b> to use the data format of the exported data fields for the cells in the XLS document; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXls(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the View's data to a stream in XLS format
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXls(System.IO.Stream,DevExpress.XtraPrinting.XlsExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified stream in XLS format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.XlsExportOptions"/> object which specifies the XLS export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXls(System.String,DevExpress.XtraPrinting.XlsExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in XLS format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A <see cref="T:System.String"/> which specifies the name (including the full path) of the file to which the control is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.XtraPrinting.XlsExportOptions"/> object which specifies the XLS export options to be applied when the View is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXlsx(System.IO.Stream,DevExpress.XtraPrinting.XlsxExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified stream in XLSX (MS Excel 2007) format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which data is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.XtraPrinting.XlsxExportOptions"/> object that contains export options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXlsx(System.String,DevExpress.XtraPrinting.XlsxExportOptions)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in XLSX (MS Excel 2007) format using the specified options.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the data is exported.
|
|
|
|
</param>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.XtraPrinting.XlsxExportOptions"/> object that contains export options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXlsx(System.String)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified file in XLSX (MS Excel 2007) format.
|
|
</para>
|
|
</summary>
|
|
<param name="filePath">
|
|
A string that specifies the full path to the file to which the data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ExportToXlsx(System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the View's data to the specified stream in XLSX (MS Excel 2007) format.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which data is exported.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Focus">
|
|
<summary>
|
|
<para>Focuses the Grid Control and current View within it.
|
|
</para>
|
|
</summary>
|
|
<returns><b>true</b> if the operation was a success; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.ForceDoubleClick">
|
|
<summary>
|
|
<para>Gets or sets whether double-clicking within the View fires the <b>DoubleClick</b> event, even if a data cell has been double-clicked and its editor has been invoked on the first click.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the <b>DoubleClick</b> event fires when double-clicking within the View even if a data cell has been double-clicked;
|
|
<b>false</b> if the <b>DoubleClick</b> event fires when double-clicking on any element except for the data cells which allow their in-place editors to be invoked on mouse clicking.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.FormatConditions">
|
|
<summary>
|
|
<para>Gets the collection of <b>style format conditions</b> for a View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.StyleFormatConditionCollection"/> object representing a collection of style format conditions for a View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.GetRow(System.Int32)">
|
|
<summary>
|
|
<para>Returns an object representing a row specified by its handle.
|
|
</para>
|
|
</summary>
|
|
<param name="rowHandle">
|
|
An integer value representing the desired row handle.
|
|
|
|
</param>
|
|
<returns>An object representing a specific row.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.GetViewCaption">
|
|
<summary>
|
|
<para>Gets the View's display caption.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>A string representing the View's display caption.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.GetViewInfo">
|
|
<summary>
|
|
<para>Returns the object which contains the internal information used to render the View.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseViewInfo "/> descendant which contains the internal information used to render the View.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.GotFocus">
|
|
<summary>
|
|
<para>Occurs when a View receives focus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.GridControl">
|
|
<summary>
|
|
<para>Gets the grid control that owns a specific View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridControl"/> object that owns the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.HideEditor">
|
|
<summary>
|
|
<para>Hides the currently active editor discarding changes made.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.HtmlImages">
|
|
<summary>
|
|
<para>Gets or sets a collection of images to be inserted into column headers and group rows using HTML tags.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.ImageCollection"/> object that stores a collection of images.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Invalidate">
|
|
<summary>
|
|
<para>Invalidates the region occupied by the current View (adds it to the control's update region that will be repainted during the next paint operation), and causes a paint message to be sent to the grid control.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.InvalidateHitObject(DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo)">
|
|
<summary>
|
|
<para>Invalidates the View element located at the point specified by the hit information object.
|
|
</para>
|
|
</summary>
|
|
<param name="hitInfo">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewInfo.BaseHitInfo"/> descendant containing hit information.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.InvalidateRect(System.Drawing.Rectangle)">
|
|
<summary>
|
|
<para>Invalidates the specified region of a View (adds it to the control's update region, which will be repainted during the next paint operation), and causes a paint message to be sent to the grid control.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="r">
|
|
A <b>System.Drawing.Rectangle</b> structure representing the region to invalidate.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.InvalidValueException">
|
|
<summary>
|
|
<para>Enables you to provide a proper response to entering an invalid cell value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsDefaultState">
|
|
<summary>
|
|
<para>Gets a value indicating whether the View is in normal state.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> always.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsDetailView">
|
|
<summary>
|
|
<para>Gets a value indicating whether the current View is a detail View.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current View is a detail View; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsDisposing">
|
|
<summary>
|
|
<para>Gets whether the current object is being disposed of.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current object is being disposed of; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsDraggingState">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View element is currently being dragged.
|
|
</para>
|
|
</summary>
|
|
<value><b>false</b> always.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsEditing">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View is in edit mode.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View is in edit mode; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsFocusedView">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View is currently focused.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View has input focus; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsLevelDefault">
|
|
<summary>
|
|
<para> [To be supplied] </para>
|
|
</summary>
|
|
<value> [To be supplied] </value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsLoading">
|
|
<summary>
|
|
<para>Gets a value indicating whether a specific View is being initialized at present time.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View is being initialized; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsServerMode">
|
|
<summary>
|
|
<para>Gets whether the View obtains data in Server Mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View obtains data in server mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsSizingState">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View element is currently being resized.
|
|
</para>
|
|
</summary>
|
|
<value><b>false</b> always.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsVisible">
|
|
<summary>
|
|
<para>Gets a value indicating whether a View is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if a View is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.IsZoomedView">
|
|
<summary>
|
|
<para>Gets a value indicating whether the current View is maximized.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the current View is maximized, otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.KeyDown">
|
|
<summary>
|
|
<para>Fires when a key is pressed while the View has focus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.KeyPress">
|
|
<summary>
|
|
<para>Fires when a character key is pressed while the View has focus.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.KeyUp">
|
|
<summary>
|
|
<para>Occurs when releasing the pressed key.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.Layout">
|
|
<summary>
|
|
<para>Fires immediately after a View's layout has been changed.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.LayoutChanged">
|
|
<summary>
|
|
<para>Updates the current View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.LayoutUpgrade">
|
|
<summary>
|
|
<para>Occurs when a layout is restored from storage (a stream, xml file or system registry) and its version differs from the version of the current View's layout.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.LevelName">
|
|
<summary>
|
|
<para>Gets the name of the master-detail relationship corresponding to the current detail View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value indicating the relationship name represented by the current detail View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.LinkCount">
|
|
<summary>
|
|
<para>Gets how many objects are connected to the View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the number of connections to the View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.LostFocus">
|
|
<summary>
|
|
<para>Occurs when a View loses focus.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.BaseView.MaxRowCopyCount">
|
|
<summary>
|
|
<para>Allows you to limit the maximum number of rows that are copied to the clipboard when the <see cref="M:DevExpress.XtraGrid.Views.Base.BaseView.CopyToClipboard"/> method is called, or when an end-user presses the CTRL+C shortcut.
|
|
</para>
|
|
</summary>
|
|
<returns> [To be supplied] </returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.MouseDown">
|
|
<summary>
|
|
<para>Occurs when the mouse pointer is over a View and a mouse button is pressed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.MouseEnter">
|
|
<summary>
|
|
<para>Occurs when the mouse pointer enters the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.MouseLeave">
|
|
<summary>
|
|
<para>Occurs when the mouse pointer leaves the View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.MouseMove">
|
|
<summary>
|
|
<para>Occurs when the mouse pointer moves over a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.MouseUp">
|
|
<summary>
|
|
<para>Occurs when the mouse button is released if it was pressed within a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.MouseWheel">
|
|
<summary>
|
|
<para>Occurs when the mouse wheel is moved while a View has focus.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.Name">
|
|
<summary>
|
|
<para>Gets or sets the View name.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value representing the View name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.NormalView">
|
|
<summary>
|
|
<para>Restores View layout after the View has been maximized.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.OptionsLayout">
|
|
<summary>
|
|
<para>Provides options that control how the current View's layout is stored to/restored from a stream, xml file or system registry.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.OptionsLayoutBase"/> descendant, providing options that control how the layout is stored and restored.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.OptionsPrint">
|
|
<summary>
|
|
<para>Provides options that control how the View is printed/exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ViewPrintOptionsBase"/> object containing the View's print and export options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.PaintAppearance">
|
|
<summary>
|
|
<para>Provides access to the appearance settings currently used to paint the View's elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.BaseAppearanceCollection"/> object which provides the appearance settings currently used to paint the View's elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.PaintStyleName">
|
|
<summary>
|
|
<para>Gets or sets the paint style name for the current View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value specifying the name of the paint style applied to the current View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.ParentView">
|
|
<summary>
|
|
<para>Gets or sets a master View for the current View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing a parent View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.PopulateColumns">
|
|
<summary>
|
|
<para>Creates grid columns/card fields from all fields of a View's bound data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.PostEditor">
|
|
<summary>
|
|
<para>Posts the value being edited to the associated data source without closing the active in-place editor.
|
|
</para>
|
|
</summary>
|
|
<returns><b>true</b> if the value being edited has been successfully saved to the associated data source; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Print">
|
|
<summary>
|
|
<para>Prints the specified View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.PrintDialog">
|
|
<summary>
|
|
<para>Displays the standard Print dialog to print the data displayed in the specified View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.PrintExportProgress">
|
|
<summary>
|
|
<para>Fires repeatedly while the View's data is being printed/exported.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.PrintInitialize">
|
|
<summary>
|
|
<para>Allows you to customize general print/export settings when the View is about to be printed/exported.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.RefreshData">
|
|
<summary>
|
|
<para>Reloads data into View from the data source.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ResetCursor">
|
|
<summary>
|
|
<para>Sets the mouse cursor to the grid's <b>Cursor</b> property value.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.RestoreLayoutFromRegistry(System.String)">
|
|
<summary>
|
|
<para>Restores a View's layout stored at the specified system registry path.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="path">
|
|
A string value specifying the system registry path. If the specified path doesn't exist, calling this method has no effect.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.RestoreLayoutFromRegistry(System.String,DevExpress.Utils.OptionsLayoutBase)">
|
|
<summary>
|
|
<para>Restores the View's layout using the specified settings stored at the specified system registry path.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="path">
|
|
A string value specifying the system registry path. If the specified path doesn't exist, calling this method does nothing.
|
|
|
|
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.OptionsLayoutBase"/> descendant specifying which options should be restored.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.RestoreLayoutFromStream(System.IO.Stream)">
|
|
<summary>
|
|
<para>Restores a View's layout from the specified stream.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> descendant from which View settings are read.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.RestoreLayoutFromStream(System.IO.Stream,DevExpress.Utils.OptionsLayoutBase)">
|
|
<summary>
|
|
<para>Restores the View's layout using the specified settings which are stored in the specified stream.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> descendant containing the layout settings.
|
|
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.OptionsLayoutBase"/> descendant specifying which options should be restored.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.RestoreLayoutFromXml(System.String)">
|
|
<summary>
|
|
<para>Restores a View's layout from a specific XML file.
|
|
</para>
|
|
</summary>
|
|
<param name="xmlFile">
|
|
A string value specifying the path to the XML file from which View settings are read. If the specified file doesn't exist, <b>System.IO.FileNotFoundException</b> type exception is raised.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.RestoreLayoutFromXml(System.String,DevExpress.Utils.OptionsLayoutBase)">
|
|
<summary>
|
|
<para>Restores the View's layout using the specified settings from the specified XML file.
|
|
</para>
|
|
</summary>
|
|
<param name="xmlFile">
|
|
A string value specifying the path to the XML file which contains the layout settings. If the specified file doesn't exist a <b>System.IO.FileNotFoundException</b> type exception is raised.
|
|
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.OptionsLayoutBase"/> descendant specifying which options should be restored.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.RowCount">
|
|
<summary>
|
|
<para>Gets a count of the total number of visible rows contained within the current View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value providing a count of the total number of visible rows in the View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.RowCountChanged">
|
|
<summary>
|
|
<para>Occurs when the number of visible records is changed within a View.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SaveLayoutToRegistry(System.String)">
|
|
<summary>
|
|
<para>Saves a View's layout to a system registry path.
|
|
</para>
|
|
</summary>
|
|
<param name="path">
|
|
A string value specifying the system registry path to which the layout is saved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SaveLayoutToRegistry(System.String,DevExpress.Utils.OptionsLayoutBase)">
|
|
<summary>
|
|
<para>Saves the View's layout using the specified settings to the specified system registry path.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="path">
|
|
A string value specifying the system registry path to which the layout is saved.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.OptionsLayoutBase"/> descendant specifying which options should be saved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SaveLayoutToStream(System.IO.Stream)">
|
|
<summary>
|
|
<para>Saves a View's layout to a specific stream.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> descendant to which a View's layout is written.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SaveLayoutToStream(System.IO.Stream,DevExpress.Utils.OptionsLayoutBase)">
|
|
<summary>
|
|
<para>Saves the View's layout using the specified settings to the specified stream.
|
|
</para>
|
|
</summary>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> descendant to which the View's layout is written.
|
|
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.OptionsLayoutBase"/> descendant specifying which options should be saved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SaveLayoutToXml(System.String)">
|
|
<summary>
|
|
<para>Saves a View's layout to a specific XML file.
|
|
</para>
|
|
</summary>
|
|
<param name="xmlFile">
|
|
A string value specifying the path to the file where a View layout should be stored. If an empty string is specified, an exception is raised.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SaveLayoutToXml(System.String,DevExpress.Utils.OptionsLayoutBase)">
|
|
<summary>
|
|
<para>Saves the View's layout using the specified settings to the specified XML file.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="xmlFile">
|
|
A string value specifying the path to the file where the View's layout settings should be stored. If an empty string is specified, an exception is raised.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.Utils.OptionsLayoutBase"/> descendant specifying which options should be saved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ShowEditor">
|
|
<summary>
|
|
<para>Activates the focused cell's editor.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ShowEditorByKey(System.Windows.Forms.KeyEventArgs)">
|
|
<summary>
|
|
<para>Activates an editor for the focused row cell and passes a specific key to it.
|
|
</para>
|
|
</summary>
|
|
<param name="e">
|
|
A <see cref="T:System.Windows.Forms.KeyEventArgs"/> object identifying the key to be passed to the inplace editor.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ShowEditorByKeyPress(System.Windows.Forms.KeyPressEventArgs)">
|
|
<summary>
|
|
<para>Activates an editor for the focused row cell and passes a specific key to it.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="e">
|
|
A <see cref="T:System.Windows.Forms.KeyPressEventArgs"/> object identifying the key to be passed to the inplace editor.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ShowEditorByMouse">
|
|
<summary>
|
|
<para>Activates an editor for the focused row cell and passes a mouse click to it.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ShowPrintPreview">
|
|
<summary>
|
|
<para>Displays the Print Preview window with a Bars UI.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ShowRibbonPrintPreview">
|
|
<summary>
|
|
<para>Displays the Print Preview window with a Ribbon UI.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.SourceRow">
|
|
<summary>
|
|
<para>Gets a master row for a View.
|
|
</para>
|
|
</summary>
|
|
<value>An object representing a master row for the current detail View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.SourceRowHandle">
|
|
<summary>
|
|
<para>Gets the handle of a master row for a View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing a master row handle for the current detail View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.SourceView">
|
|
<summary>
|
|
<para>Gets the pattern View used to create a clone View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant representing a pattern View containing settings of a clone View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Synchronize(DevExpress.XtraGrid.Views.Base.BaseView,DevExpress.XtraGrid.Views.Base.SynchronizationMode)">
|
|
<summary>
|
|
<para>Copies the specified settings of a View to the current View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant specifying the View whose settings are copied to the current View.
|
|
|
|
</param>
|
|
<param name="mode">
|
|
A <b>SynchronizationMode</b> enumeration value specifying whether data representation settings, visual settings or both should be copied.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.Synchronize(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Copies the visual and data representation settings of a specific View to the current View.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant whose visual and data representation settings should be copied to the current View.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.SynchronizeClones">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether this View's clones have synchronized appearance and data representation settings.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> to synchronize this View's clones; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SynchronizeData(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes the data representation settings of the current view with a another View object.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant whose data representation settings should be copied to the current View.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.SynchronizeVisual(DevExpress.XtraGrid.Views.Base.BaseView)">
|
|
<summary>
|
|
<para>Synchronizes the visual representation settings of the current view with a specific View object.
|
|
</para>
|
|
</summary>
|
|
<param name="viewSource">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Base.BaseView"/> descendant whose appearance settings should be copied to the current View.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.Tag">
|
|
<summary>
|
|
<para>Gets or sets the data associated with the current View.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An object containing information which is associated with the current View.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.UpdateCurrentRow">
|
|
<summary>
|
|
<para>Validates the currently focused row's value/data.
|
|
</para>
|
|
</summary>
|
|
<returns><b>true</b> if the row has been successfully updated; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ValidateEditor">
|
|
<summary>
|
|
<para>Validates the active editor.
|
|
</para>
|
|
</summary>
|
|
<returns><b>true</b> if the active editor's value is accepted; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.XtraGrid.Views.Base.BaseView.ValidatingEditor">
|
|
<summary>
|
|
<para>Enables you to perform manual validation of cell values.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.ViewCaption">
|
|
<summary>
|
|
<para>Gets or sets the View's caption.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the View's caption.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.ViewRect">
|
|
<summary>
|
|
<para>Gets the bounding rectangle of the View's visible area.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Rectangle"/> structure representing the bounding rectangle of the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.ViewRepository">
|
|
<summary>
|
|
<para>Gets the View repository that owns the current View.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Repository.ViewRepository"/> object representing the repository that owns the current View.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Views.Base.BaseView.WorkAsLookup">
|
|
<summary>
|
|
<para>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
|
|
</para>
|
|
</summary>
|
|
<value>A Boolean value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Base.BaseView.ZoomView">
|
|
<summary>
|
|
<para>Maximizes the current detail View clone.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum">
|
|
|
|
<summary>
|
|
<para>Lists values specifying the cells that should display editor buttons.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum.Default">
|
|
<summary>
|
|
<para>If a column's <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.ShowButtonMode"/> property is set to this value, the column uses the View's settings. Assigning this value to the View's <see cref="P:DevExpress.XtraGrid.Views.Base.ColumnView.ShowButtonMode"/> property is equivalent to assigning the <b>ShowForFocusedCell</b> value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum.ShowAlways">
|
|
<summary>
|
|
<para><para>Editor buttons are displayed for all cells within the column/view.</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum.ShowForFocusedCell">
|
|
<summary>
|
|
<para><para>Editor buttons are displayed for the focused cell only.</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum.ShowForFocusedRow">
|
|
<summary>
|
|
<para><para>Buttons are displayed for cells that reside within the focused row.</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum.ShowOnlyInEditor">
|
|
<summary>
|
|
<para><para>Buttons are displayed only when a cell editor is active.</para>
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.GridColumn">
|
|
|
|
<summary>
|
|
<para>Represents an individual column in Grid Views and Card Views.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.AbsoluteIndex">
|
|
<summary>
|
|
<para>Gets or sets the column's position within the View's column collection.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the zero-based column index within the collection.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.AllowSummaryMenu">
|
|
<summary>
|
|
<para>Gets or sets whether all supported summaries or only the Count summary are enabled in the column's footer context menu.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if all supported summaries are enabled in the column's footer context menu; <b>false</b> if only the Count summary is enabled.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.AppearanceCell">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the column's data cells.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.AppearanceObjectEx"/> object which provides the appearance settings used to paint the column's data cells.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.AppearanceHeader">
|
|
<summary>
|
|
<para>Gets the appearance settings used to paint the column header.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.Utils.AppearanceObject"/> object representing the column header's appearance settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.BestFit">
|
|
<summary>
|
|
<para>Resizes the column to the minimum width required to display the column's contents completely.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.CanShowInCustomizationForm">
|
|
<summary>
|
|
<para>Gets a value indicating whether the column's header can be displayed within the customization form.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's header can be displayed within the customization form; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Caption">
|
|
<summary>
|
|
<para>Gets or sets the column's display caption.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value specifying the column's display caption.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.ClearFilter">
|
|
<summary>
|
|
<para>Clears filtering applied to the column.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ColumnEdit">
|
|
<summary>
|
|
<para>Gets or sets the repository item specifying the editor used to edit a column's cell values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> descendant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ColumnEditName">
|
|
<summary>
|
|
<para>Gets or sets the name of the column's editor.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying editor name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ColumnHandle">
|
|
<summary>
|
|
<para>Gets or sets the column's bound data field by its index within the associated data source.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the bound data field's zero-based index.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ColumnType">
|
|
<summary>
|
|
<para>Gets the column's data type.
|
|
</para>
|
|
</summary>
|
|
<value>A <b>System.Type</b> value representing column data type.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.CustomizationCaption">
|
|
<summary>
|
|
<para>Gets or sets the column's caption when its header is displayed within the Customization Form.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value which specifies the column's caption when its header is displayed within the customization form.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.DisplayFormat">
|
|
<summary>
|
|
<para>Provides access to the object specifying the formatting applied to column values.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.FormatInfo"/> object that specifies format settings for column values.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.FieldName">
|
|
<summary>
|
|
<para>Gets or sets the name of the database field assigned to the current column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the name of a data field.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.FieldNameSortGroup">
|
|
<summary>
|
|
<para>Gets or sets another field, by which data is sorted/grouped/filtered when sorting/grouping/filtering is applied to the current column.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies a field name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.FilterInfo">
|
|
<summary>
|
|
<para>Gets or sets the filter condition applied to the column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object specifying the filter condition applied to the column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.FilterMode">
|
|
<summary>
|
|
<para>Gets or sets how column values are filtered via the auto filter row and filter dropdown.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.ColumnFilterMode"/> enumeration value that specifies how the column values are filtered.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Fixed">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether the column takes part in horizontal View scrolling or is anchored to a View edge.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.FixedStyle"/> enumeration value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.GetBestWidth">
|
|
<summary>
|
|
<para>Returns the minimum width that the column can have and still display its contents completely.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>An integer value that specifies the column's minimum width which is required to display its contents completely.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.GetCaption">
|
|
<summary>
|
|
<para>Returns the actual display caption for the current column.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that specifies the column's actual display caption.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.GetTextCaption">
|
|
<summary>
|
|
<para>Returns the non formatted column caption.
|
|
</para>
|
|
</summary>
|
|
<returns>A string value that represents the column's non formatted caption.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.Group">
|
|
<summary>
|
|
<para>Groups data by the values of the current column.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.GroupFormat">
|
|
<summary>
|
|
<para>Provides access to the formatting settings for the column's values which are displayed within group rows.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.FormatInfo"/> object containing the formatting settings for the column's values that are displayed within group rows.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.GroupIndex">
|
|
<summary>
|
|
<para>Gets or sets the value specifying whether the column takes part in grouping and at which level.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the column's position among grouping columns. <b>-1</b> if the View is not grouped by this column's values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.GroupInterval">
|
|
<summary>
|
|
<para>Gets or sets how data rows are grouped when grouping by the current column is applied. Not supported in Server Mode.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.ColumnGroupInterval"/> value that determines how data rows are grouped when grouping by the current column is applied.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ImageAlignment">
|
|
<summary>
|
|
<para>Gets or sets the column header image alignment.
|
|
</para>
|
|
</summary>
|
|
<value>A <b>System.Drawing.StringAlignment</b> enumeration member specifying the image alignment.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ImageIndex">
|
|
<summary>
|
|
<para>Gets or sets a value specifying the image displayed within the column header.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the image by its zero-based index within the source collection. <b>-1</b> to display no image.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Images">
|
|
<summary>
|
|
<para>Gets an image collection whose images can be displayed within the column's header.
|
|
</para>
|
|
</summary>
|
|
<value>An object which provides images for column headers.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.IsLoading">
|
|
<summary>
|
|
<para>Indicates whether the View that owns the current column is currently being initialized.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the View is being initialized; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.IsUnboundExpressionValid">
|
|
<summary>
|
|
<para>Gets whether the column's <see cref="P:DevExpress.XtraGrid.Columns.GridColumn.UnboundExpression"/> specifies a valid expression.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column's UnboundExpression specifies a valid expression; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.MaxWidth">
|
|
<summary>
|
|
<para>Gets or sets the column's maximum width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the column's maximum width.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.MinWidth">
|
|
<summary>
|
|
<para>Gets or sets the column's minimum allowed width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the column's minimum width in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.MRUFilters">
|
|
<summary>
|
|
<para>Provides access to the column's recently used filters.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfoCollection"/> object that stores the recently used filters for the column.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Name">
|
|
<summary>
|
|
<para>Gets or sets the column name.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value specifying the column name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.OptionsColumn">
|
|
<summary>
|
|
<para>Provides access to the column's options.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.XtraGrid.Columns.OptionsColumn"/> object containing the column's options.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.OptionsFilter">
|
|
<summary>
|
|
<para>Provides access to the filter options for the current column.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.XtraGrid.Columns.OptionsColumnFilter"/> object specifying a set of filter options for the current column.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ReadOnly">
|
|
<summary>
|
|
<para>Gets a value indicating whether the column's <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.ReadOnly"/> option is enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the <see cref="P:DevExpress.XtraGrid.Columns.OptionsColumn.ReadOnly"/> option is enabled; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.RealColumnEdit">
|
|
<summary>
|
|
<para>Gets the repository item that actually represents the column's editor.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> descendant representing the actual column's editor.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.Resize(System.Int32)">
|
|
<summary>
|
|
<para>Specifies a new width for the column.
|
|
</para>
|
|
</summary>
|
|
<param name="newWidth">
|
|
An integer value representing the column's new width.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ShowButtonMode">
|
|
<summary>
|
|
<para>Gets or sets a value specifying which column cells display editor buttons.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ShowButtonModeEnum"/> enumeration value specifying which column cells display editor buttons.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ShowUnboundExpressionMenu">
|
|
<summary>
|
|
<para>Gets or sets whether an end-user can open an Expression Editor for the current unbound column, using a context menu.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if an end-user can open an Expression Editor for the current unbound column, using a context menu; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.SortIndex">
|
|
<summary>
|
|
<para>Gets or sets the column's position among sorted columns.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value representing the zero-based column's index among sorted columns. <b>-1</b> if data is not sorted by this column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.SortMode">
|
|
<summary>
|
|
<para>Gets or sets how the column's data is sorted when sorting is applied to it.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.ColumnSortMode"/> value specifying how the column's data is sorted in sort mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.SortOrder">
|
|
<summary>
|
|
<para>Gets or sets the column's sort order.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.ColumnSortOrder"/> enumeration value specifying the column's sort order.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.StyleName">
|
|
<summary>
|
|
<para>Gets or sets the column's data cell style by its name.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value representing the name of a style applied to the column's data cells.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Summary">
|
|
<summary>
|
|
<para>Allows you to add multiple total summaries for a column. These summaries are displayed within the View Footer.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridColumnSummaryItemCollection"/> object that is a collection of column total summaries.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.SummaryItem">
|
|
<summary>
|
|
<para>Provides access to the column's footer summary settings.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.GridSummaryItem"/> object containing the column's footer summary settings.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.SummaryText">
|
|
<summary>
|
|
<para>Gets the summary text displayed within the View footer cell located under this column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value which is the formatted textual representation of this column's total summary value.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Tag">
|
|
<summary>
|
|
<para>Gets or sets the data associated with the column.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An object containing information which is associated with the column.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.ToolTip">
|
|
<summary>
|
|
<para>Gets or sets a custom tooltip for the column.
|
|
</para>
|
|
</summary>
|
|
<value>A string representing a custom tooltip for the column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.ToString">
|
|
<summary>
|
|
<para>Gets the column's caption.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that specifies the column's caption.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.UnboundExpression">
|
|
<summary>
|
|
<para>Gets or sets an expression used to evaluate values for the current unbound column.
|
|
</para>
|
|
</summary>
|
|
<value>A string that specifies an expression used to evaluate values for the current column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.UnboundType">
|
|
<summary>
|
|
<para>Gets or sets the data type and binding mode of the column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.UnboundColumnType"/> enumeration value representing the data type and binding mode of the column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.GridColumn.UnGroup">
|
|
<summary>
|
|
<para>Ungroups data by the values of the current column.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.View">
|
|
<summary>
|
|
<para>Gets the View that owns the column.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Views.Base.ColumnView"/> descendant representing the View that owns the column.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Visible">
|
|
<summary>
|
|
<para>Gets or sets whether the column is visible.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b> if the column is visible; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.VisibleIndex">
|
|
<summary>
|
|
<para>Gets or sets the column's visible state and position within the View.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the column's zero-based index among visible columns. <b>-1</b> if the column is invisible.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.VisibleWidth">
|
|
<summary>
|
|
<para>Gets the current column width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying the current column width in pixels.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.GridColumn.Width">
|
|
<summary>
|
|
<para>Gets or sets column width.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value specifying a column's width.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo">
|
|
|
|
<summary>
|
|
<para>Contains column filter settings.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.XtraGrid.Columns.ColumnFilterType,System.Object,System.String,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterType"/> enumeration value specifying the filter type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Type"/> property.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> representing the filter value. This parameter is in effect when the <I>type</I> parameter is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Value"/> and the <I>filter</I> parameter is either an empty string or <b>null</b> (<b>Nothing</b> in Visual Basic). When in effect, the column is filtered by the specified value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="filterString">
|
|
A string value specifying the filter criteria. This string should be composed in compliance with ANSI SQL standards. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property value.
|
|
If this parameter has a value (it's not <b>null</b> or an empty string) the <i>val</i> parameter is ignored.
|
|
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A string value specifying the text to be displayed within the filter panel. If set to an empty string, the text representation of the filter criteria is calculated automatically. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Object)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> representing the filter value. The specified value is compared to column values. When filtering is active, records are only displayed when values within the column match this parameter. The parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.String,System.String)">
|
|
<summary>
|
|
<para>Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter condition and its text representation.
|
|
</para>
|
|
</summary>
|
|
<param name="filterString">
|
|
A string value specifying the filter criteria. This string should be composed in compliance with SQL syntax requirements. This parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property.
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A string value specifying the text representation of the filter criteria. This text is displayed within the View's filter panel. If the parameter is set to an empty string, the filter condition's text representation is constructed automatically. This parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Object,System.String)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value and filter text representation.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> representing the filter value. The specified value is compared to column values. Records whose values within the column do not match this parameter are not displayed when filtering is applied. This parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A string value specifying the text representation of the filter criteria. This text is displayed within the View's filter panel. If the parameter is set to an empty string, the filter condition's text representation is constructed automatically. This parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.XtraGrid.Columns.ColumnFilterType,System.Object,System.String,System.String,System.String)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterType"/> enumeration value specifying the filter type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Type"/> property.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> representing the filter value. This parameter is in effect when the <I>type</I> parameter is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Value"/> and the <I>filter</I> parameter is either an empty string or <b>null</b> (<b>Nothing</b> in Visual Basic). When in effect, the column is filtered by the specified value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="filterString">
|
|
A string value specifying the filter criteria. This string should be composed in compliance with ANSI SQL standards. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property value.
|
|
If this parameter has a value (it's not <b>null</b> or an empty string) the <i>val</i> parameter is ignored.
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A string value specifying the text to be displayed within the filter panel. If set to an empty string, the text representation of the filter criteria is calculated automatically. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText"/> property.
|
|
|
|
</param>
|
|
<param name="valueDisplayText">
|
|
A string representing the current filter condition in the filter dropdown list. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.ValueDisplayText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.String,System.String,System.Object,DevExpress.XtraGrid.Columns.ColumnFilterType)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class with the specified settings.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="filterString">
|
|
A string value specifying the filter criteria. This string should be composed in compliance with ANSI SQL standards. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property value.
|
|
If this parameter has a value (it's not <b>null</b> or an empty string) the <i>val</i> parameter is ignored.
|
|
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A string value specifying the text to be displayed within the filter panel. If set to an empty string, the text representation of the filter criteria is calculated automatically. This parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText"/> property.
|
|
|
|
</param>
|
|
<param name="val">
|
|
A <see cref="T:System.Object"/> representing the filter value. This parameter is in effect when the <I>type</I> parameter is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Value"/> and the <I>filter</I> parameter is either an empty string or <b>null</b> (<b>Nothing</b> in Visual Basic). When in effect, the column is filtered by the specified value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
<param name="filterType">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterType"/> enumeration value specifying the filter type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Type"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.XtraGrid.Columns.ColumnFilterType,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ColumnFilterInfo class with the specified filter type and filter expression.
|
|
</para>
|
|
</summary>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterType"/> enumeration value which specifies the filter type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Type"/> property.
|
|
|
|
</param>
|
|
<param name="filterString">
|
|
A <see cref="T:System.String"/> value that represents the filter expression. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ColumnFilterInfo class with the specified filter expression.
|
|
</para>
|
|
</summary>
|
|
<param name="filterString">
|
|
A <see cref="T:System.String"/> value that represents the filter expression. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.XtraGrid.Columns.ColumnFilterType,System.Object,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ColumnFilterInfo class with the specified settings.
|
|
</para>
|
|
</summary>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterType"/> enumeration value which specifies the filter type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Type"/> property.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> object that represents the filter value. This parameter is in effect when the <i>type</i> parameter is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Value"/> and the <i>filter</i> parameter is either an empty string or <b>null</b> (<b>Nothing</b> in Visual Basic). When in effect, the column is filtered by the specified value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
<param name="filterString">
|
|
A <see cref="T:System.String"/> value that represents the filter expression. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.String,System.Object)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ColumnFilterInfo class with the specified filter expression and filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="filterString">
|
|
A <see cref="T:System.String"/> value that represents the filter expression. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString"/> property.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> object that represents the filter value. This parameter is in effect when the <i>type</i> parameter is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Value"/> and the <i>filter</i> parameter is either an empty string or <b>null</b> (<b>Nothing</b> in Visual Basic). When in effect, the column is filtered by the specified value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.XtraGrid.Columns.GridColumn,System.Object)">
|
|
<summary>
|
|
<para>Creates a new ColumnFilterInfo class instance with the specified filter value and column.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object whose values are compared against the specified value.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> representing the filter value. The specified value is compared to the column's values. Records, whose values within the column do not match this parameter, are not displayed when filtering is applied. This parameter value is assigned to the Value property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.Data.Filtering.CriteriaOperator)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class with the specified filter criteria.
|
|
</para>
|
|
</summary>
|
|
<param name="filter">
|
|
A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object which represents filter criteria.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.XtraGrid.Columns.ColumnFilterType,System.Object,DevExpress.Data.Filtering.CriteriaOperator,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class with the specified filter settings.
|
|
</para>
|
|
</summary>
|
|
<param name="type">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterType"/> enumeration value specifying the filter type. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Type"/> property.
|
|
|
|
|
|
</param>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> representing the filter value. This parameter is in effect when the <I>type</I> parameter is set to <see cref="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Value"/> and the <I>filter</I> parameter is <b>null</b> (<b>Nothing</b> in Visual Basic). When in effect, the column is filtered by the specified value. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
|
|
|
|
</param>
|
|
<param name="filter">
|
|
A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object which represents the filter criteria. If this parameter is not <b>null</b> the <i>_value</i> parameter is ignored.
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A string value specifying the text to be displayed within the filter panel. If set to an empty string, the text representation of the filter criteria is calculated automatically. This value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Int32)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Guid)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Single)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.TimeSpan)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Int16)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Int64)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Char)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Byte[])">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Byte)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Double)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.Decimal)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(System.DateTime)">
|
|
<summary>
|
|
<para><font color="red">Obsolete.</font> Creates a new <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> class instance with the specified filter value.
|
|
</para>
|
|
</summary>
|
|
<param name="_value">
|
|
A filter value that is used to initialize the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.#ctor(DevExpress.XtraGrid.Columns.GridColumn,System.Object,System.String)">
|
|
<summary>
|
|
<para>Creates a new ColumnFilterInfo class instance with the specified grid column, filter value and display text.
|
|
</para>
|
|
</summary>
|
|
<param name="column">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.GridColumn"/> object whose values are compared against the specified value.
|
|
|
|
</param>
|
|
<param name="_value">
|
|
A <see cref="T:System.Object"/> representing the filter value. The specified value is compared to the column's values. Records, whose values within the column do not match this parameter, are not displayed when filtering is applied. This parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value"/> property.
|
|
|
|
</param>
|
|
<param name="displayText">
|
|
A <see cref="T:System.String"/> specifying the text representation of the filter criteria. This text is displayed within the View's filter panel. If the parameter is set to an empty string, the filter condition's text representation is constructed automatically. This parameter value is assigned to the <see cref="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText"/> property.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Clone">
|
|
<summary>
|
|
<para>Returns a copy of the current <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:System.Object"/> representing a clone of the current <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.DisplayText">
|
|
<summary>
|
|
<para>Gets the filter condition's textual representation.
|
|
</para>
|
|
</summary>
|
|
<value>A string value representing the filter condition's textual representation.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Empty">
|
|
<summary>
|
|
<para>Gets an empty filter condition.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object representing the empty filter condition.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Equals(DevExpress.XtraGrid.Columns.ColumnFilterInfo)">
|
|
<summary>
|
|
<para>Determines whether the current object has the same settings as that specified.
|
|
</para>
|
|
</summary>
|
|
<param name="filter">
|
|
A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object to compare with the current object.
|
|
|
|
</param>
|
|
<returns><b>true</b> if an object specified by the parameter has the same settings as the current object; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterCriteria">
|
|
<summary>
|
|
<para>Gets the current filter criteria.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Data.Filtering.CriteriaOperator"/> object which represents the current filter criteria.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.FilterString">
|
|
<summary>
|
|
<para>Gets the filter expression specified by this <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterInfo"/> object.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value representing the filter expression.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.GetDisplayText">
|
|
<summary>
|
|
<para>Returns the actual textual representation of the filtering condition applied.
|
|
</para>
|
|
</summary>
|
|
<returns>A string that represent the filtering condition within the filter panel.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.GetValueDisplayText">
|
|
<summary>
|
|
<para>Returns the same value as the <see cref="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.GetDisplayText"/> method.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>A string returned by the <see cref="M:DevExpress.XtraGrid.Columns.ColumnFilterInfo.GetDisplayText"/> method.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Kind">
|
|
<summary>
|
|
<para>Gets whether the current filter condition has been created by the XtraGrid or is a custom condition.
|
|
</para>
|
|
</summary>
|
|
<value><b>ColumnFilterKind.Predefined</b> if the filter item was created by the XtraGrid; <b>ColumnFilterKind.User</b> if the filter item was created via code.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Type">
|
|
<summary>
|
|
<para>Controls whether the current object filters data by a particular value, uses a custom filter string or provides no filtering condition.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraGrid.Columns.ColumnFilterType"/> enumeration value indicating the filtering type.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.Value">
|
|
<summary>
|
|
<para>Gets the value by which data is filtered.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Object"/> representing the value by which data is filtered.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.XtraGrid.Columns.ColumnFilterInfo.ValueDisplayText">
|
|
<summary>
|
|
<para>This member is obsolete.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An empty string.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Columns.ColumnFilterType">
|
|
|
|
<summary>
|
|
<para>Contains values specifying filtering types.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.ColumnFilterType.AutoFilter">
|
|
<summary>
|
|
<para>Indicates that a column's values are filtered via the automatic filtering row.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Custom">
|
|
<summary>
|
|
<para>Indicates that filtering is applied based on a custom filter string. The string should be constructed in compliance with SQL requirements.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.ColumnFilterType.None">
|
|
<summary>
|
|
<para>Indicates that filtering is disabled.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.XtraGrid.Columns.ColumnFilterType.Value">
|
|
<summary>
|
|
<para>Indicates that a column should be filtered by a specific value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomRowCellEditEventHandler">
|
|
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomRowCellEdit"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomRowCellEditEventHandler.Invoke(System.Object,DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomRowCellEditEventArgs)">
|
|
<summary>
|
|
<para>Represents a method that will handle the <see cref="E:DevExpress.XtraGrid.Views.Layout.LayoutView.CustomRowCellEdit"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source. Identifies the <see cref="T:DevExpress.XtraGrid.Views.Layout.LayoutView"/> that raised the event.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.XtraGrid.Views.Layout.Events.LayoutViewCustomRowCellEditEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
</members>
|
|
</doc>
|