Syncfusion.Grid.Grouping.Windows
The Syncfusion namespace contains classes that defines the value and reference data types, events and event handlers, interfaces, attributes and processing the exceptions.
This class holds the name of the Syncfusion.Grid.Grouping.Windows assembly and provides a helper
routine that helps with resolving types when loading a serialization stream and when
the framework probes for assemblies by reflection.
The full name of this assembly without version information: "Syncfusion.Grid.Grouping.Windows"
A reference to the for the Grid assembly.
The root namespace of this assembly. Used internally for locating resources within the assembly.
Initializes the class.
This delegate helps with resolving types and can be used as a eventhandler
for a event.
The source of the event.
The event data with information about the type.
A reference to the assembly where the type is located.
Use this handler when reading back types from a serialization stread
saved with an earlier version of this assembly.
public static GridModel LoadSoap(Stream s)
{
try
{
AppDomain.CurrentDomain.AssemblyResolve += new ResolveEventHandler(GridGroupingWindowsAssembly.AssemblyResolver);
SoapFormatter b = new SoapFormatter();
b.AssemblyFormat = FormatterAssemblyStyle.Simple;
GridModel t = b.Deserialize(s) as GridModel;
t.Modified = false;
return t;
}
finally
{
AppDomain.CurrentDomain.AssemblyResolve -= new ResolveEventHandler(GridGroupingWindowsAssembly.AssemblyResolver);
}
}
AssemblyInformation for internal use.
The Syncfusion.Windows.Forms.Grid.Grouping namespace contains classes that implements the Essential GridGroupingControl and its events and event handlers, interfaces, attributes and processing the exceptions.
GridCellModelFactory creates objects to be used in a .
Initializes a new instance of the class.
Overrides and creates an instance of to be used in the class.
A cell type name that identifies the cell model to be instantiated.
The instance of the class.
An instance of the class.
Implements the DataModel part for an indent cell in a .
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instance of the class.
Initializes a new instance of the class from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Initializes a new instance of the class.
and stores a reference to the that the cell belongs to.
The for this cell model.
You can typically access cell models through the
property of the class.
Overrides and creates a cell renderer for class.
The grid control.
An instance of the class.
Implements the renderer part of an indent cell which is used inside the grouping grid
to display indention of groups or tables and optionally draw tree-lines.
The property is used to indicate which
part of a tree-line to be drawn. Possible line part types are:
TextDescriptions
- TA T-node.
- LThe last node.
- IA continues line.
Initializes a new instance of the class for the given GridControlBase
and .
The that displays this cell renderer.
The which holds data for class that should be shared among views.
References to and will be saved.
Overrides and raises the OnDraw() method to draw the contents of the cells.
Points to the device context.
Specifies the client rectangle. It is the cell rectangle without buttons and borders.
Specifies the row index.
Specifies the column index.
An instance of the that holds the values of style properties.
When drawing cells, it is necessary to determine if the
specified cell (with rowIndex and colIndex) is the current cell and if
it is active.
If your control is associated with a control and supports in-place editing
and the specified cell is the current cell, you should position the control. Take a look at the GridTextBoxCellRenderer
implementation of this method for an example.
Otherwise, you can simply draw the cell.
Overrides and draws the contents of a specified cell.
Graphics context.
Cell rectangle.
Row index.
Column index.
An instance of the that holds the values of style properties.
Overrides and triggered when the event is done.
The row index.
The column index.
The contains the event data.
you can suppress this event while clicking inside of the cell.
Gets the value of the instance
which is a reference to the parent grid.
Gets the value of the default border style used for tree lines.
Implements the DataModel part of a column header with sort indicator.
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instance of the class.
Initializes a new instance of the class.
and stores a reference to the this cell belongs to.
The for this cell model.
You can typically access cell models through the
property of the class.
Initializes a new instance of the class from a serialization stream.
An instance of the that holds all the data needed to serialize or deserialize this instance.
An instance of the that describes the source and destination of the serialized stream specified by .
Overrides and gets the formatted string.
An instance of the that holds the values of style properties.
The value to be formatted.
Specifies the hint of who is calling, By default is calls.
The formatted text of the specified value.
Overrides and creates a cell renderer for class.
The grid control.
An instance of the class.
Overrides and calculates the preferred size of the cell based on its contents without margins
and any buttons.
An instance of the class.
The row index.
The column index.
An instance of the that holds the values of style properties.
The grid query bounds
The optimal size of the cell.
Implements the renderer part of a column header with sort indicator.
The header cell is XP Themes enabled. It will be drawn themed if is True.
The registers "ColumnHeaderCell" as identifier in
of a cell's
to associate this cell type with a cell.
The sort indicator is defined through the of a cell's . The
will be cast to .
A renderer is created for each
and . There can be several renderer.
associated with one if several views display the same
.
The following table lists some characteristics about the TableColumnHeader cell type:
Item
Description
-
CellType
ColumnHeaderCell
-
Renderer
-
Model
-
XP Themes Support
Yes
-
Interactive
Click Only
-
Floating Support
No
-
Base Type
The cell's behavior and appearance can be customized with the following properties of the class:
PropertyName
Description
-
()
The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
-
()
Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
-
()
When set to , the header will be drawn with slightly raised edges typical for cell headers. If the grid is XP Themes enabled, the headers will be drawn with XP Themes look. If you specify Sunken or Raised, the header will be drawn with sunken or raised edges and not XP Themed. (Default: GridCellAppearance.Flat)
-
()
ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
-
()
ColumnHeaderCell (Default: TextBox)
-
()
If empty, the standard header text will be drawn as specified with the and properties in . If is not NULL the cell value will be displayed as header text. (Default: String.Empty)
-
()
Specifies the preferred for cell values. When you assign a value to the object, the value will be converted to this type. If the value cannot be converted, will contain error information. (Default: NULL)
-
()
The culture information holds rules for parsing and formatting the cell's value. (Default: NNULL)
-
()
Specifies if the header cell can be activated as current cell when the user clicks onto the header. Usually you do not want a header to be activated as current cell unless you want to have editing capabilities like allowing user to rename header text in place. (You would have to implement a custom header cell for this.) (Default: True)
-
()
Holds error information if a value could not be converted to the specified with . (Default: String.Empty)
-
()
The font for drawing text. (Default: GridFontInfo.Default)
-
()
Gets or sets the format mask for formatting the cell value. You can specify numeric format strings,
date format strings, or enumeration format strings as discussed in the section "Format Specifies and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty)
-
()
Specifies horizontal alignment of text in the cell. (Default: GridHorizontalAlignment.Left)
-
()
Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable a hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show)
-
()
Specifies an index for an image in the of a
instance. (Default: -1)
-
()
The that holds a collection of images. Cells can choose images with the property in a
instance. (Default: NULL)
-
()
Lets you specify a solid back color, gradient, or pattern style with both back and fore color for a cell's
background. If grid is XP Themes enabled, this color will be ignored and the header will be drawn with default XP Themes header background. (Default: SystemColors.Window)
-
()
Specifies merge behavior for an individual cell when the merging cell's feature has been enabled in a with . (Default: GridMergeCellDirection.None)
-
()
The sort indicator is defined through the of a cell's . The
will be cast to . (Default: NULL)
-
()
If empty, the standard header text will be drawn as specified with the and properties in . If is not NULL, the cell value will be displayed as header text. (Default: String.Empty)
-
()
Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
-
()
Holds text margins in pixels. When drawing a cell, this specifies the empty area between the
text rectangle and the client rectangle of the cell without borders and cell buttons. (Default: GridMarginsInfo.Default)
-
()
Specifies if cell should be drawn using Windows XP themes when has been set. (Default: True)
-
()
Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
-
()
Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top)
-
()
Specifies if text should be wrapped when it does not fit into a single line. (Default: True)
Implements the renderer part of a column or row header.
There can be several renderers.
associated with one if several views display the same
.
The header cell is XP Themes enabled. It will be drawn themed if is True.
The following table lists some characteristics about the Header cell type:
Item
Description
-
CellType
Header
-
Renderer
-
Model
-
XP Themes Support
Yes
-
Interactive
Click Only
-
Floating Support
No
-
Base Type
The cell's behavior and appearance can be customized with the following properties of the class:
PropertyName
Description
-
()
The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
-
()
Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
-
()
When set to , the header will be drawn with slightly raised edges typical for cell headers. If the grid is XP Themes enabled, the headers will be drawn with an XP Themes look. If you specify Sunken or Raised, the header will be drawn with sunken or raised edges and not XP Themed. (Default: GridCellAppearance.Flat)
-
()
ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
-
()
Header (Default: TextBox)
-
()
If empty, the standard header text will be drawn as specified with the and properties in . If is not NULL, the cell value will be displayed as header text. (Default: String.Empty)
-
()
Specifies the preferred for cell values. When you assign a value to the object, the value will be converted to this type. If the value cannot be converted, will contain error information. (Default: NULL)
-
()
The culture information holds rules for parsing and formatting the cell's value. (Default: NULL)
-
()
Specifies if the header cell can be activated as current cell when the user clicks onto the header. Usually you do not want a header to be activated as current cell unless you want to have editing capabilities such as allowing the user to rename header text in place. (You would have to implement a custom header cell for this.) (Default: True)
-
()
Holds error information if a value could not be converted to the specified with . (Default: String.Empty)
-
()
The font for drawing text. (Default: GridFontInfo.Default)
-
()
Gets or sets the format mask for formatting the cell value. You can specify numeric format strings,
date format strings, or enumeration format strings as discussed in the section "Format Specifiers and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty)
-
()
Specifies horizontal alignment of text in the cell. (Default: GridHorizontalAlignment.Left)
-
()
Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable a hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show)
-
()
Specifies an index for an image in the of a
instance. (Default: -1)
-
()
The that holds a collection of images. Cells can choose images with the property in a
instance. (Default: NULL)
-
()
Lets you specify a solid backcolor, gradient, or pattern style with both back and forecolor for a cell's
background. If grid is XP Themes enabled, this color will be ignored and the header will be drawn with default XP Themes header background. (Default: SystemColors.Window)
-
()
Specifies merge behavior for an individual cell when the merging cell's feature has been enabled in a with . (Default: GridMergeCellDirection.None)
-
()
If empty, the standard header text will be drawn as specified with the and properties in . If is not NULL, the cell value will be displayed as header text. (Default: String.Empty)
-
()
Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
-
()
Holds text margins in pixels. When drawing a cell, this specifies the empty area between the
text rectangle and the client rectangle of the cell without borders and cell buttons. (Default: GridMarginsInfo.Default)
-
()
Specifies if cell should be drawn using Windows XP themes when has been set. (Default: True)
-
()
Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
-
()
Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top)
-
()
Specifies if text should be wrapped when it does not fit into a single line. (Default: True)
Initializes a new instance of the class for the given instance of the
and classes.
The that displays this cell renderer.
The that holds data for this cell renderer that should
be shared among views.
References to
and classes will be saved.
Wires the grid.
UnWire the grid.
Overrides and manages the unwanted resources.
If True then the method call comes from the base Dispose method; Otherwise False indicating the method call comes from the finalizer.
Overrides and called to determine whether the cell renderer wants to receive mouse events
for the give cell at the given coordinates.
The row index.
The column index.
A contains the event data.
The that handles the mouse events.
Non-zero hit context value if you request to handle the mouse event; zero if you vote
not to handle the mouse event.
Overrides and triggered when the event is done.
The row index.
The column index.
The contains the event data.
Overrides and triggered when the event is done.
The row index.
The column index.
The contains the event data.
The column index.
The row index.
Overrides and triggered when the event is done.
The row index.
The column index.
The contains the event data.
Overrides and triggered when the event is done.
The row index.
The column index.
The contains the event data.
Overrides and triggered when the event is done.
The row index.
The column index.
The contains the event data..
Overrides and draws contents of the cell.
The instance of the class.
Specifies the client rectangle. It is the cell rectangle without buttons and borders.
The row index.
The column index.
An instance of the that holds the values of style properties.
When drawing cells, it is necessary to determine if the
specified cell (with rowIndex and colIndex) is the current cell and if
it is active.
If your control is associated with a control and supports in-place editing
and the specified cell is the current cell, you should position the control. Take a look at the GridTextBoxCellRenderer
implementation of this method for an example.
Otherwise, you can simply draw the cell.
Allows custom formatting of a cell by changing its style object.
Event data.
Override to draw the cell background.
The contains an event data.
This method is called from to draw the face text of the header cell after
its background has been drawn.
The instance of the class.
Specifies the text rectangle. It is the cell rectangle without buttons and borders and text margins.
The row index.
The column index.
An instance of the that holds the values of style properties.
Overrides and highlights the current cell by inverting the cells border or drawing a thick border.
The instance of the class.
The instance of the that specifies the cell rectangle values.
This method handles the default highlighting.
of your cell.
Initializes a new instance of the class for the given instances of
and classes.
The that display this cell renderer.
The that holds data for this cell renderer that should
be shared among views.
References to
and will be saved.
Overrides and raises the to draw the face text of the header cell after
its background has been drawn.
The instance of the class.
Specifies the text rectangle. It is the cell rectangle without buttons and borders and text margins.
Specifies the row index.
Specifies the column index.
An instance of the that holds the values of style properties.
Overrides and triggered when the event is done.
Specifies the row index.
Specifies the column index.
A contains the event data.
you can suppress this event while clicking on the cell.
Implements the DataModel part for a TableFilterBar cell.
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instances of the class.
Initializes a new instance of the class
and stores a reference to the this cell belongs to.
The for model.
You can typically access cell models through the
property of the class.
Initializes a new instances of the class from a serialization stream.
An instance of the that holds all the data needed to serialize or deserialize this instance.
An instance of the that describes the source and destination of the serialized stream specified by parameter.
Overrides and creates an instance of the for class that is specific to the .
The for which the cell renderer is created.
A new specified by the instance of the class.
Gets the unique choices to be displayed in the filter bar cell.
An instance of the class that identifies the table cell.
Filter bar choices.
Overrides and initializes the ListBox with data binding information from a
object.
The list box to be initialized with data binding information.
An instance of the that holds the values of style properties.
A place holder that indicates whether the list box is filled with an exclusive
list of possible choices or if non-standard values are allowed.
Gets the FilterCell style and datasource.
the TableCellStyle of the FilterCell.
Data of the filterbar cell with display and value member.
GridComboBoxHelper to get the DataSource of the cell.
Style of the ComboBox cell to get display values.
Gets the items based on FilterMode options.
filter value to update in the dropdown.
the TableCellStyle of the FilterCell.
GridComboBoxHelper to get the DataSource of the cell.
Style of the ComboBox cell to get display values.
Applies the filter criteria. Note: The first two entries are reserved for (All) and (Custom).
An index greater than one represents a valid choice found with GetFilterBarChoices.
Identity for the table cell.
Index of the filter bar choice to be selected.
Gets the value for the unique columns. Internal only.
The table cell identity.
Returns the unique group id for every column.
Gets the value. Internal only.
The table cell identity.
returns the UniqueGroupId
Gets an array of instances of the class for the specific column
with respect to the particular value.
Record filters collection.
Specified grid table cell.
Name of the filter.
Array of instances of the class.
Selects the item at the specified index from respective cell identifier.
An instance of the class that identifies the cell.
Index of the selected item.
Applies the record filter for table. Internal only.
Resets the filter of respective cell identifier.
An instance of the class that identifies the cell.
Initiate the collection dialog editor while selecting custom option from the filter.
An instance of the class that identifies the cell.
Shows the collection dialog.
The object instance.
Name of the property.
An instance of the interface.
The instance of the class.
An instance of the instance.
Triggered when the RecordFilterCollectionEditor is being displayed. Used internally.
Gets or sets the value of FilterBar string "(All)".
Gets or sets the value of FilterBar string "(Custom)".
Gets or sets the value of FilterBar string "(Empty)".
Occurs immediately before the RecordFilterCollectionEditor dialog is being displayed.
Implements the renderer part of a TableFilterBar cell.
can be customized with
, ,
and properties of a instance.
If you do not have a data source object, you can also fill the drop-down list contents
with a and optionally specify .
The TableFilterBar cell is XP Themes enabled. It will be drawn themed if is True.
There can be several renderers.
associated with one if several views display the same
.
Use "TableFilterBar" as identifier in of a cell's
to associate this cell type with a cell.
The cell's behavior and appearance can be customized with the following properties of the class.
Initializes a new instance of the class for the given instances of the
and classes.
The that displays this cell renderer.
The that holds data for this cell renderer that should
be shared among views.
References to
and will be saved.
Overrides and initializes the current cell.
Row index for the current cell.
Column index for the current cell.
Overrides and triggered when user pressed key down.
The contains the event data.
Overrides and triggered when the event is done in the list box.
The Control.
A contains the event data.
Overrides and triggered for custom formatting of a cell by changing its style object.
The contains the event data.
Gets the text from record filter criteria that should be displayed in filter bar cell.
An instance of the that holds the values of style properties.
The filtered item's text value.
Overrides and draws the of the client bounds for the cell.
The instance of the class.
Specifies the client rectangle. It is the cell rectangle without buttons and borders.
Specifies the row index.
Specifies the column index.
An instance of the that holds the values of style properties.
Overrides and triggered when the drop down is about to be shown.
The Control.
The contains the event data.
Gets a value for reference to the parent grid.
Gets a value for reference to the filterbar cell model.
Gets or sets the value to be specified to the active text that is being displayed on the cell.
Defines a class that provides data for the event which occurs
when is initializing columns with is set to "True" and gives
you the options to handle filterbarchoices through custom code. In such case the event is also raised
when the user clicks on dropdown button of a
In event handler code you should check whether Element is null (Nothing).
If it is null then only set to "false" if you want to
provide your own choice list.
If it is not null then you should initialize the with choices to
be displayed to the user.
Initialize a new instance of the class.
Column name.
True if summary descriptor should be created.
The element at the filter row.
Gets the values of the column in which the choices to be shown.
Gets or sets a value indicating whether to create summary descriptor or not.
Set this property false if you do not want a summary being created for the specified column. The
engine will raise the event with = null (Nothing) in order to investigate
for which columns it should create internal summaries.
Gets the value of the element from the filter drop down.
When a user clicks on the drop down button of a FilterBarCell then this event is raised and
the Element will contain the element at the given filter bar row. You can check Element.ParentGroup
to find out which group the element belongs to. If Element is null (Nothing) you should simply
set as needed.
Gets or sets the unique filter bar values that is being displayed in the filter drop down.
When a user clicks on the drop down button of a FilterBarCell then this event is raised and
the Element will contain the element at the given filter bar row. You should then initialize
this array with values that should be displayed in the drop down.
Defines the class that provides data for event that occurs after
an item is selected through the filtered dropdown.
Initialize a new instance of the class.
Index of the selected item.
Text of the selected item.
The FilteredColumn information.
Gets the value of current-selected column descriptor.
Gets the zero-based index of the currently selected item in a filter bar.
Gets the value of selected text of the filtered item.
Defines the class that provides data for event that occurs when
an item is selected through the filtered dropdown.
Initializes a new instance of the class.
The index of the selected item.
The text value of the selected item.
The List box.
The column name.
Initializes a new instances of the class.
An instance of the class.
The column name.
The index of the selected item.
The text value of the selected item.
Gets the value of currently selected column descriptor.
Gets or sets the zero-based index of the currently selected item in a Filter bar.
Gets or sets the value for selected text of the filtered item.
Handles the event.
The Control.
The contains the event data.
Handles the event.
The Control.
The contains the event data.
Handles the event.
The object instance
The contains the event data.
Implements the DataModel part for a TableFilterBar GridListControl cell.
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instance of the class.
Initializes a new instance of the object
and stores a reference to the this cell belongs to.
The for this cell model.
You can typically access cell models through the
property of the class.
Initializes a new instance class.
Initializes a new object
and stores a reference to the this cell belongs to.
The for this cell model.
To set GridListControl's appearance as Combobox
You typically access cell models through the
property of the class.
Initializes a new from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Overrides and creates a for the cell model that is specific to the .
The the cell renderer is created for.
A new specific for a .
Gets the unique choices to be displayed in the filter bar cell.
Identity for the table cell.
Filter bar choices.
Gets the datasource for filter bar choices.
An instance of the that holds the values of style properties.
The data source instance associated withe the filterbar cell.
Overrides and gets the data to fill with choices.
The to be initialized with data binding information.
An instance of the that holds the values of style properties.
If True then the list box values will be filled with unique values; Otherwise False and allows non-standard values.
Initializes a with data binding information from an instance of the
class.
The to be initialized with data binding information.
The style object with binding information.
A place holder that indicates whether the GridListControl is filled with an exclusive
list of possible choices or if non-standard values are allowed.
Applies a filter criteria. Note: The first two entries are reserved for (All) and (Custom).
An index greater than one represents a valid choice found with GetFilterBarChoices.
Identifies the table cell.
Index of the filter bar choice to be selected.
Gets the unique group id value for the column. Internal only.
The table cell identity.
Returns the value.
Gets an array of unique group id for the top level group. Internal only.
The table cell identity.
Returns the value.
Gets an array of RecordFilterDescriptors for the specific column
with respect to the particular GroupUniqueID
An instance of the .
Specified grid table cell.
Name of the filter.
Array of instance value.
Selects the item at the selected index in respective cell identifier.
The index of the selected item.
An instance of the that identifies the table cell.
Initialize the record filters. Internal only.
Resets the filter for the specified cell identifier.
An instance of the that identifies the table cell.
A method to initiate collection dialog editor while selecting custom filter option.
An instance of the that identifies the table cell.
Shows the collection dialog.
An object.
Name of the property.
An instance of the value.
An instance of the value.
Returns the DialogResult.
Triggered when the custom filter dialog is being displayed. Used internally
The Control.
The contains the event data.
Gets or sets the value "(Select All)" text.
Gets or sets the values of the "(Custom...)" text.
Gets or sets the value of the "(Empty)" text.
Occurs immediately before the RecordFilterCollectionEditor Dialog is displayed. The ControlEventArgs.Control
the form.
Implements the renderer part of the filterbar cell.
can be customized with
, ,
and properties of a instance.
If you do not have a datasource object, you can also fill the drop-down list contents
with a and optionally specify .
The TableFilterBar cell is XP Themes enabled. It will be drawn themed if is True.
There can be several renderers
associated with one if several views display the same
.
Use "TableFilterBar" as identifier in of a cell's
to associate this cell type with a cell.
The cell's behavior and appearance can be customized with the following properties of the class.
Initializes a new instance of the class for the given instance of the
and classes.
The that displays this cell renderer.
The that holds data for this cell renderer that should
be shared among views.
References to
and classes will be saved.
Initialize the instance of the class.
RowIndex of the FilterBarCell.
ColumnIndex of the FilterBarCell.
Occur this event while pressing the key on filter bar cell.
The contains the event data.
Overrides and initiates the style information for drop down table.
The Control.
The contains the event data.
Overrides and raises the event of the list box.
The Control.
A contains the event data.
Overrides and performs the BeginEdit() method.
Overrides and allows custom formatting of a cell by changing its style object.
The contains the event data.
Gets the text value of the selected item to be displayed in the filterbar cell.
An instance of the that holds the values of style properties.
Filter bar text.
Overrides and draws the contents
of the client bounds for the cell.
Points to the device context.
Specifies the client rectangle. It is the cell rectangle without buttons and borders.
Specifies the row index.
Specifies the column index.
An instance of the that holds the values of style properties.
Overrides and draws the cell buttons.
The cell button.
The instance of the class.
Row index.
Column index.
If True draws the active cell button; Otherwise False.
An instance of the that holds the values of style properties.
Gets a value of reference to the parent grid.
Gets a value of reference to the cell model.
Gets or sets the value of the active text that should be displayed on the cell.
Implements the DataModel part of a column or row header.
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instance of the class.
Initializes a new instance of the class.
and stores a reference to the this cell belongs to.
The for this cell model.
You can typically access cell models through the
property of the class.
Initializes a new instance of the class from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Creates a cell renderer for this cell model.
The grid control.
An instance of the .
Calculates the preferred size of the cell based on its contents without margins
and any buttons.
The instance of the class.
The row index.
The column index.
An instance of the that holds the values of style properties.
The value of the enumerator.
The optimal size of the cell.
Implements the DataModel part for a row header cell in a . The
row header cell will display an arrow for the current row, a star for the append row, and
a pencil when the row is being edited.
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instance of the class.
Initializes a new instance of the class from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Initializes a new instance of the class
and stores a reference to the this cell belongs to.
The for this cell model.
You can typically access cell models through the
property of the class.
Overrides and creates a cell renderer for the given instance of the class.
The grid control.
Returns the instance of the class.
Overrides and calculates the preferred size of the cell based on its contents without margins.
and any buttons.
The System.Drawing.Graphics context of the canvas.
The row index.
The column index.
An instance of the that holds the values of style properties.
The GridQueryBounds
The optimal size of the cell.
Implements the renderer part of a row header.
There can be several renderer
associated with one if several views display the same
.
The header cell is XP Themes enabled. It will be drawn themed if is true.
The following table lists some characteristics about the Header cell type:
Item
Description
-
CellType
Header
-
Renderer
-
Model
-
XP Themes Support
Yes
-
Interactive
Click Only
-
Floating Support
No
-
Base Type
The cell's behavior and appearance can be customized with the following properties of the class:
PropertyName
Description
-
()
The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
-
()
Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
-
()
When set to , the header will be drawn with slightly raised edges typical for cell headers. If the grid is XP Themes enabled the headers will be drawn with XP Themes look. If you specify Sunken or Raised, the header will be drawn with sunken or raised edges and not XP Themed. (Default: GridCellAppearance.Flat)
-
()
ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
-
()
Header (Default: Text Box)
-
()
If empty, the standard header text will be drawn as specified with the and properties in . If is not NULL, the cell value will be displayed as header text. (Default: String.Empty)
-
()
Specifies the preferred for cell values. When you assign a value to the object, the value will be converted to this type. If the value cannot be converted, will contain error information. (Default: NULL)
-
()
The culture information holds rules for parsing and formatting the cell's value. (Default: NNULL)
-
()
Specifies if the header cell can be activated as current cell when the user clicks onto the header. Usually you do not want a header to be activated as current cell unless you want to have editing capabilities such as allowing a user to rename header text in place. (You would have to implement a custom header cell for this.) (Default: true)
-
()
Holds error information if a value could not be converted to the specified with . (Default: String.Empty)
-
()
The font for drawing text. (Default: GridFontInfo.Default)
-
()
Gets or sets the format mask for formatting the cell's value. You can specify numeric format strings,
date format strings, or enumeration format strings as discussed in the section "Format Specifiers and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty)
-
()
Specifies horizontal alignment of text in the cell. (Default: GridHorizontalAlignment.Left)
-
()
Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable a hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show)
-
()
Specifies an index for an image in the of a
instance. (Default: -1)
-
()
The that holds a collection of images. Cells can choose images with the property in a
instance. (Default: NULL)
-
()
Lets you specify a solid backcolor, gradient, or pattern style with both back and forecolor for a cell's
background. If grid is XP Themes enabled, this color will be ignored and the header will be drawn with default XP Themes header background. (Default: SystemColors.Window)
-
()
Specifies merge behavior for an individual cell when the merging cell's feature has been enabled in a with . (Default: GridMergeCellDirection.None)
-
()
If empty, the standard header text will be drawn as specified with the and properties in . If is not NULL, the cell value will be displayed as header text. (Default: String.Empty)
-
()
Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
-
()
Holds text margins in pixels. When drawing a cell, this specifies the empty area between the
text rectangle and the client rectangle of the cell without borders and cell buttons. (Default: GridMarginsInfo.Default)
-
()
Specifies if cell should be drawn using Windows XP themes when has been set. (Default: True)
-
()
Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
-
()
Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top)
-
()
Specifies if text should be wrapped when it does not fit into a single line. (Default: True)
Initializes a new instance of the class for the given GridControlBase
and .
The that displays this cell renderer.
The that holds data for this cell renderer that should
be shared among views.
References to
and will be saved.
This method is called from the cell renderer's draw method to draw the contents
of the client bounds for the cell, e.g. the text for a static cell.
Points to the device context.
Specifies the client rectangle. It is the cell rectangle without buttons and borders.
The row index.
The column index.
An instance of the that holds the values of style properties.
When drawing cells, it is necessary to determine if the
specified cell (with rowIndex and colIndex) is the current cell and if
it is active.
If your control is associated with a control and supports in-place editing
and the specified cell is the current cell, you should position the control. Take a look at the GridTextBoxCellRenderer
implementation of this method for an example.
Otherwise, you can simply draw the cell.
Overrides and triggered to determine whether the mouse events should be handled by the renderer at the given coordinates for the specified cell.
The row index.
The column index.
A with data about the mouse event.
The requested to handle this mouse event.
Non-zero hit context value if you request to handle the mouse event; zero if you vote
not to handle the mouse event.
Overrides and draws the display text on the headers.
its background has been drawn.
The instance of the class.
Specifies the text rectangle. It is the cell rectangle without buttons and borders and text margins.
The row index.
The column index.
An instance of the that holds the values of style properties.
Overrides and triggered when the event is done.
The row index.
The column index.
A contains the event data.
Paints the specified bitmap substituting black pixels with a new color.
The instance of the class.
A instance which contains the boundary data of the rectangle.
A that specifies pixel to offset the bitmap from its origin point.
The Bitmap to be drawn on the screen.
The new color used to substitute black pixels.
A Rectangle which contains the boundary data of the drawn bitmap.
The PaintIcon routine
will substitute black pixels of the original bitmap and draw them with the
specified fore color. The bitmap is centered inside the specified bounds.
Use the offset if you want to display a "pressed button" state. If the button is
pressed, specify offset = new Point(1, 1).
Loads the bitmap from manifest and paint it substituting black pixels with a new color.
The instance of the class.
A instance which contains the boundary data of the rectangle.
A that specifies pixel to offset the bitmap from its origin point.
The name of the bitmap.
The new color used to substitute black pixels. ///
A Rectangle which contains the boundary data of the drawn bitmap.
The PaintIcon routine
will substitute black pixels of the original bitmap and draw them with the
specified fore color. The bitmap is centered inside the specified bounds.
Use the offset if you want to display a "pressed button" state. If the button is
pressed, specify offset = new Point(1, 1).
Gets a value of reference to the parent grid.
Defines a class that provides the typed list collections for the record in the table of class.
Used internally.
Initialize a new instance of the class. Used internally.
Gets the collection for property descriptor. Used internally.
Represents a collection of PropertyDescriptor objects.
The listAccessors
The property values.
Gets the count of visible columns. Used internally.
The visible column count.
Gets the width for specified column. Used internally.
The column index.
The column width.
Sets the width for specified column. Used internally.
The column index.
specifies the column width.
Gets the style values for the specified cell. Used internally.
The row index.
The column index.
An instance of the that holds the values of style properties.
Triggered when the table descriptor's property values gets changed.
The Control.
The contains the event data.
Gets the value of the table descriptor.Used internally.
maintains schema information for a table. Collections define columns, fields, expressions,
sorted, grouped columns, and related tables
Gets the value of the table. Used internally
Manages all the records from the underlying source list. The source list can be any IList collection.
If it implements IBindingList, the will listen to the ListChangedEvent and update its internal
data whenever changes are made to the source list.
Occurs when the properties of the items in the collection gets changed. Used internally.
Handles through contains the event data..
Represents a control that provides support for displaying ADO.NET data and other datasources in a grid. Data will be
loaded from the given datasource and changes will be written back to the datasource. Both
flat tables and hierarchical data can be displayed. Records can be grouped into categories and
summaries can be displayed for each group.
To display a table in the at run-time, set the
and properties to a valid datasource. The following datasources are valid:
- A DataTable
- A DataView
- A DataSet
- A single dimension array
- Any component that implements the IListSource interface
- Any component that implements the IList interface.
GridGroupingControl is a user control that hosts a ,
a , and a .
Its main properties for the DataModel are: , ,
, , and .
Properties for user display controls are: , , and .
The provides properties to get / set the DataSource using the
and properties. The DataSource can be set through the designer.
The property gives access to the hosted .
The is a grid derived from .
The property gives access to the hosted control.
Its purpose is to allow dragging header columns from the
for user-interactive grouping of records. You can hide and show this area with the
property.
The property gives access to the hosted control.
You can show or hide the record navigation bar with the property.
The is the main element in the . The
displays the rows from the collection
of the using schema information stored in the .
gives access to the table schema information of the
root table in the datasource.
The object is instantiated by the class
and initialized with default schema information from the list assigned to .
The is accessed through the property.
The object is instantiated with the virtual method.
If you want to subclass the , you should override this method.
The object is the main grouping engine object. It is derived from the
base class and adds Windows Forms specific functionality such as support
for a Forms BindingContext and CurrencyManager. GridEngine also has special overrides of the virtual
Engine.CreateTableDescriptor and Engine.CreateTable methods so that the grid-specific derived GridTable class
(derived from Syncfusion.Grouping.Engine) and GridTableDescriptor class (derived from Syncfusion.Grouping.TableDescriptor)
are instantiated.
There is only one object for a .
and objects on the other side can be more than one when
hierarchies are displayed. For each hierarchy level, a and
are initialized. For example, if you have an ADO.NET DataSet with three tables: "Products", "Orders", and "OrderDetails", there will be three GridTableDescriptors and GridTables.
Relations between tables are defined with a collection of a .
Each TableDescriptor can have one or multiple objects. A
defines the foreign key columns in the parent table, a child with information about the
related child table and the primary key columns in the child table.
The object is instantiated by the class. The Table object manages the
records from the engine's DataSource and provides access to records and grouped elements through several collection classes.
The most important collection used by the GridTableControl is the DisplayElements collection. This collection provides
the GridTableControl with information on which element to display at a row.
It returns elements such as CaptionSection, RecordRow, SummaryRow, and others.
Based on the elements returned by this collection, the GridTableControl will display a record, a summary or a group caption bar.
There are several collections returned such as Records which contains all records in the table. FilterRecords contains all
visible records.
Determines whether SortIconPlacement has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the SortIconPlacement back to its default value.
Determines whether ShowDefaultValuesInAddNewRecord has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the ShowDefaultValuesInAddNewRecord back to its default value.
Determines whether BrowseOnly has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the BrowseOnly back to its default value.
Determines if the has been modified from its
default state.
True if CacheRecordValues was manually modified
Resets the back to its default value.
Determines a value whether the has been modified from its
default state or not.
True if TableDirtyOnSourceListReset was manually modified;
Resets the back to its default value.
Determines a value indicating whether the value was modified or not.
True if content is changed; False otherwise.
Discards any changes for the property value.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Initializes this object and copies properties from another object. The
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Improves the Grouping performance with IList datasource.
The source object.
A contains the event data.
Improves the Grouping performance with IList datasource.
The source object.
A contains the event data.
Required designer variable.
Initializes a new instance of the class.
Initializes a new instance of the class and creates a new empty engine object.
Determines a value that indicates whether to serialize the touch mode or not.
If True touch mode is serialized; Otherwise False.
Resets the touch mode.
Applies the scaling to the control.
The scaling value.
Initializes a new instance of the class and attaches it to the specified grid
engine.
The engine to be used by the GridGroupingControl.
Creates an instance of the class with grid grouping control to optimize list changed.
Determines whether FreezeCaption has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the FreezeCaption object.
Creates the grid grouping control optimize list changed.
An instance of the class.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when mouse down event is done in the scroll control.
The Control.
The contains the even data.
Triggered when the application is in idle state.
The Control.
The contains the event data.
Overrides and triggered when the size gets changed.
The contains the event data.
Initializes a new instance of the class in a special mode where
it is only used to hold state information. This is used for XML serialization
and saving and restoring state of a GridGroupingControl.
The state information.
Overrides and triggered to create control.
Overrides and cleans up any resources being used.
Creates a table control associated with the class.
An instance of the class.
The table control.
Creates a table model associated with the table control.
The table model used by the .
Creates an instance of the class.
An instance of the class.
The parent grid.
The class.
The table control.
Creates the instance of the that have a splitter frame at the bottom of the scrollbar control.
The RecordNavigationControl.
Creates an instance of the group drop area associated with the engine.
The instance of the class.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Triggered when th visibility of the caption gets changed.
The Control.
The contains the event data.
Override this method if you would like to have a derived engine object. The method is called
to create a default engine object when no engine objects were manually
instantiated. See also the discussion in .
If the CreateEngine method is not overridden, a new
object is returned, otherwise an object derived from GridEngine might be returned.
Overrides and forces the control to invalidate its client area and immediately redraws itself and any child controls.
Overrides and raises the event.
The contains the event data.
Determines whether DefaultGridBorderStyle has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the DefaultGridBorderStyle back to its default value.
Determines whether AllowScrollCurrentCellInView has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the AllowScrollCurrentCellInView back to its default value.
Determines whether AlphaBlendSelectionColor has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the AlphaBlendSelectionColor back to its default value.
Determines whether ClickedOnDisabledCellBehavior has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the ClickedOnDisabledCellBehavior back to its default value.
Determines whether ShowCurrentCellBorderBehavior has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the ShowCurrentCellBorderBehavior back to its default value.
Determines whether UseRightToLeftCompatibleTextBox has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the UseRightToLeftCompatibleTextBox back to its default value.
Determines whether MarkColHeader has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the MarkColHeader back to its default value.
Determines whether MarkRowHeader has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the MarkRowHeader back to its default value.
Determines whether ShowColumnHeaders has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the ShowColumnHeaders back to its default value.
Determines whether DisplayHorizontalLines has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the DisplayHorizontalLines back to its default value.
Determines whether DisplayVerticalLines has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the DisplayVerticalLines back to its default value.
Determines whether GridLineColor has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the GridLineColor back to its default value.
Determines whether PrintColumnHeader has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the PrintColumnHeader back to its default value.
Determines whether PrintRowHeader has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the PrintRowHeader back to its default value.
Determines whether ShowRowHeaders has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the ShowRowHeaders back to its default value.
Overrides and process the Enter key press.
The contains the even data.
Overrides and performs the validating operation.
The contains the event data.
Overrides and initializes the layout.
Overrides and triggered while handle is created.
The contains the event data.
Overrides and triggered while the handle gets destroyed.
The contains the event data.
Triggered when the handle is created for the parent form.
The Control.
The contains the event data.
Triggered when the form gets loaded.
The Control.
The contains the event data.
Delays certain settings, e.g. ShowToolTips - execute them either in HandleCreated event or shortly after.
Optimizes the loading time of the grid.
Gets the engine associated with the grid.
The engine.
Overrides and raises the binding of context changed event.
The contains the event data.
Wires the engine to the grid.
Unwires the engine from the grid.
Triggered when the engine is marked for resynchronizing event.
The Control.
The contains the data.
Wires the table descriptor to the engine.
The Control.
The contains event data.
Wires the table descriptor to the grid.
Unwires the table descriptor from the engine.
Wires the table associated with the grid.
Unwires the table associated with the grid.
Triggered when the source list of the grid engine gets changed.
The Control.
The contains the event data.
Overrides and gets a string containing the current object.
A string containing the current object.
Determines whether IsDynamicData has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the IsDynamicData back to its default value.
Triggered when the fieldchooser is getting shown.
The contains the event data.
Triggered when the fieldChooser dialog had shown.
The contains the event data.
Raises the FieldChooserClosing event.
The event data.
Triggered when the fieldchooser gets closed.
The contains the event data.
Triggered when the datasource is getting change.
The contains the event data.
Triggered when the datasource gets changed.
Forces the Engine to Dispose.
Overrides and paints the grid.
The contains the event data.
Overrides and triggered when the UI gets changing.
The contains the event data.
Overrides and triggered when the control lost focus.
The contains the event data.
Handler to re-arrange the alignment of the GroupDropPanel.
The contains the event data.
The Control.
Determines whether GroupDropAreaAlignment has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the GroupDropAreaAlignment back to its default value.
Disables the scroll in GroupDropArea.
Enables the scroll in GroupDropArea..
Enables the Horizontal scroll in GroupDropArea
Disables the Horizontal scroll in GroupDropArea.
Default location of GroupDropArea.
Refreshes the GroupDropArea.
Performs the alignment in the GroupDropArea with the specified dock style.
The dock value to be aligned.
Determines whether HierarchicalGroupDropArea has been modified and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the HierarchicalGroupDropArea back to its default value.
Resets the Grouped Columns and will add again.
TChe grouped columns list.
Triggered when the grouped columns gets changed.
The Control.
The contains the event data.
Overrides and triggered when the tab key is pressed.
The contains the event data.
Gets the parent grouping grid.
The Control.
The control associated with the grid.
Overrides and determines a value indicating whether to processes a dialog key or not.
One of the values that represents the key to process.
True if the key was processed by the control; Otherwise, false.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered the event is done.
The contains the event data.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
The contains the event data.
Determines a value indicating whether to serialize collection was modified or not.
True if the collection was modified; Otherwise False.
Resets the values of property associated with the grid.
Determines whether to serialize the has been modified from its
default state or not.
True if TableDescriptor was manually modified; False if it only contains auto-populated
data.
Resets the values of the property back to its
default state and auto populates schema information on demand.
Discards current cells and current record changes.
Triggered when the table is created grid gets associated with the engine.
The Control.
The contains the event data.
Triggered when the current record context gets change.
The Control.
The contains the event data.
Gets or sets the of Skin Manager Interface.
Applies the header style based on the Office2016 theme.
font face name for header cells.
font size for header cells.
Text color for grid cells.
Applies the cell style based on the Office2016 theme.
font face name for record field cells.
font size for record field cell.
text color for recordfield cells.
gridline color for recordfield cells.
Applies the style for Group cells.
backcolor for group cells.
text color for group cells.
gridline color for group cells.
Applies the style for summary cells based on the Office2016 theme.
backcolor for summary cells.
top border color for summary cells.
right border color for summary cells.
Applies the styles for RecordNavigation control based on the Office2016 theme.
font for record RecordNavigation control.
fore color for RecordNavigation control.
Applies the theme setting for table based on the Office2016 theme.
height of header row.
height of record row.
Calculates the row height when DPI is greater than 100 then the DefaultRecordRowHeight will be set based on the font size.
The Height Value
Calculates the column header's row height when DPI is greater than 100 then the DefaultColumnHeaderRowHeight will be set based on the font size.
The Height Value
Sets the custom Metro Colors to the Grid.
Custom Metro Color.
Custom color for mouse hovering.
Custom color for mouse pressed.
Custom color for the group bars.
Sets the color for grid when metro theme applied.
Collection of metro colors.
Sets the color for grid when office2016 theme applied.
The custom colors for Office 2016 theme.
Collection of office2016ThemeColor colors.
Updates the display after changes were made to schema or data in
the engine or datasource.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Process the window messages.
The message to be processed.
Overrides and process the window message.
Performs the search operation and gets the table specified.
An instance of the associated with the grid.
The mapping name of the table.
The found instance of the class.
Gets the table for the specified current instance associated with the grid.
specified name.
The name of the table to search.
The table or NULL if not found.
This example shows how to use the method.
// Gets the given table and performs the required operations.
this.gridGroupingControl1.GetTable("myTable").DefaultRecordRowHeight= 22;
' Gets the given table and performs the required operations.
Me.gridGroupingControl1.GetTable("myTable").DefaultRecordRowHeight= 22
Performs the search operations and gets the table descriptor.
An instance of the class.
The mapping name of the table descriptor.
The found instance of the found class.
Gets the value of the property or an instance of the class of any nested relation that matches the
specified mapping name.
The mapping name of the table descriptor to be found.
The table descriptor or NULL if not found.
Gets the value of the property or the instance of the class of any nested relation that matches the
specified name.
The mapping name of the table control to search.
The table control or NULL if not found.
Gets the value of the property or an instance of the class
of any nested relation that matches the specified name.
The mapping name of the table model to search.
The table model or null if not found.
Adds the group drop area for the specified mapping name of the table.
Adds the group drop area for the specified mapping name of the table. Users have
to manually add rows for nested relations to allow end-users grouping
nested relations.
The name of the relation for which to add support for
grouping.
This example shows how to use the method.
// Adds a Group drop area for individual child tables. Make sure to set "ShowGroupDropArea=true"
this.gridGroupingControl1.AddGroupDropArea("Child_Table_Name");
' Adds a Group drop area for individual child tables. Make sure to set "ShowGroupDropArea=true"
Me.gridGroupingControl1.AddGroupDropArea("Child_Table_Name")
Adds the group drop area for the specified instance of the class. Users have
to manually add rows for nested relations to allow end-users grouping
of nested relations.
The nested table for which to add support for
grouping.
This example shows how to use the method.
// Adds a Group drop area for the child table. Make sure to set "ShowGroupDropArea=true"
GridTable myTable = new GridTable(this.gridGroupingControl1.TableDescriptor, null);
this.gridGroupingControl1.AddGroupDropArea(myTable);
' Adds a Group drop area for the child table. Make sure to set "ShowGroupDropArea=true"
Dim myTable As New GridTable(Me.gridGroupingControl1.TableDescriptor, Nothing)
Me.gridGroupingControl1.AddGroupDropArea(myTable)
Triggered when the group drop area gets disposed.
The Control.
The contains the event data.
Determines whether to serialize the changed values of the property or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines a value indicating whether the changed values of the property should were modified
and whether their contents should be serialized at design-time.
True if contents are changed; False otherwise.
Resets the modifications done in the property values.
Determines a value indicating whether were modified or not
and whether their contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the modification done in the values of the property.
Determines a value indicating whether to serialize the top level group options or not at the design-time.
True if contents were changed; False otherwise.
Resets the modified values in the property.
Determines a value indicating whether to serialize the modified values in property at design-time.
True if contents were changed; False otherwise.
Resets the modified values in the instance.
Begins the initialization of the control that is used on a form or used by another component. The initialization occurs at run-time.
Creates an engine object that is used temporarily only after BeginInit was called from
within the parent forms InitializeComponent method.
Returns the GridEngine
Ends the initialization of the control that is used on a form or used by another component. The initialization occurs at run-time.
Repaints the grid.
Triggered when the appearance gets changed.
The Control.
The contains the event data.
Triggered when the nested table's group options gets changing.
The Control.
The contains the event data.
Triggered when the child table's group options gets changing.
The Control.
The contains the event data.
Triggered when the list property gets changing.
The Control.
The contains the event data.
Triggered when the top level group options gets changing.
The Control.
The contains the event data.
Triggered when the appearance gets changed.
The Control.
The contains the event data.
Triggered when the nested table's group options gets changed.
The Control.
The contains the event data.
Triggered when the group options gets changed.
The Control.
The contains the event data.
Triggered when the default values of the property gets changed.
The Control.
The contains the event data.
Triggered when the property values gets changed.
The Control.
The contains the event data.
Triggered when the property values gets changing.
The Control.
The contains the event data.
Triggered when the property values gets changed.
The Control.
The contains the event data.
Triggered when the property values gets changing.
The Control.
The contains the event data.
Triggered when the property values gets changed.
The Control.
The contains the event data.
Triggered when the data member gets changed.
The Control.
The contains the event data.
Triggered when the data source associated with the engine gets changed.
The Control.
The contains the event data.
Triggered when the sorted columns gets changed.
The Control.
The contains the event data.
Triggered when the table group expanded.
The Control.
The contains the event data.
Reinitializes merging cells if the view layout is changed.
Loads engine settings from an XML stream.
The XML reader stream.
Writes engines settings to an XML stream.
The XML writer stream.
Writes state to an XML stream.
The XML writer stream.
Loads state from an XML stream.
The XML reader stream.
Discards changes, refreshes the counters and summaries and redraws the grid.
Determines a value that indicates whether the specified key is a regular input key or a special key that requires preprocessing.
The contains the values.
True if the specified key is a regular input key; otherwise, false.
Overrides and triggered when the event is done.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Overridden to set the background image for the grid.
The contains the event data.
Overridden to set the background image layout for the grid.
The contains the event data.
Overrides and triggered when the grid font's gets changed.
The contains the event data.
Overrides and triggered when the font gets changed.
The contains the event data.
Overrides and triggered when the text color gets changed.
The contains the event data.
Overrides and triggered when the back color values gets changed.
The contains the event data.
Triggered when the record navigation control's pane gets closed.
The Control.
The contains the event data.
Triggered when the event is done.
A that contains the event data.
Raises the event is done.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Raises the event.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Raises the event.
Raises the event.
Raises the event.
A that contains the event data.
Triggered when the event is done.
A that contains the event data.
Triggered when the property is enabled.
The class.
Triggered when the event is done.
A that contains the event data.
Triggered when the is enabled.
The contains the event data.
Triggered when the event is done..
A that contains the event data.
Triggered when the arrow keys are used for navigation.
The contains the event data.
Triggered when the event is done.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
Raises the event.
A that contains the event data.
Raises the event.
Raises the event.
A that contains the event data.
Raises the event.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Sets the default value for the GroupCaptionCell type.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Draws the display text.
A contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
compare the grid client size to change the column width with new column width allow resizing to fit.
Column Index
new column with
column width before change the size of column
returns true value.
set the column width when AllowProportionalColumnSizing is enable
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
An that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Determines whether was modified.
True if content is changed;False, otherwise.
Discards any changes for the object.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Suspends the painting of the control until the method is called.
Suspends the painting of the control until the method is called.
When many paints are made to the appearance of a control, you should invoke the
BeginUpdate method to temporarily freeze the drawing of the control. This results
in less distraction to the user, and a performance gain. After all updates have
been made, invoke the EndUpdate method to resume drawing of the control.
The BeginUpdate method will call both the method
for the and . This
suspends drawing for both child controls.
Resumes the painting of the control suspended by calling the BeginUpdate method.
Resumes the painting of the control suspended by calling the BeginUpdate method.
True if pending paint operations should be executed immediately; False if they should be discarded.
When many paints are made to the appearance of a control, you should invoke the
BeginUpdate method to temporarily freeze the drawing of the control. This results
in less distraction to the user, and a performance gain. After all updates have
been made, invoke the EndUpdate method to resume drawing of the control.
The EndUpdate method will call both the method
for the and . This
resumes drawing for both child controls.
Updates the record navigation bar properties such as maximum count, current record, etc.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event
The with event data.
Raises the event
The with event data.
Raises the event.
The with event data.
Raises the event.
The with event data.
Raises the event.
A that contains the event data.
Used internally.
Raises the event.
A that contains the event data.
Used internally.
Raises the event.
A that contains the event data.
Used internally.
Raises the event.
A that contains the event data.
Used internally.
Raises the event.
A that contains the event data.
Used internally.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Used internally.
Used internally.
Gets the current for a cell indicating whether the cells
value was increased or decreased or if the record has been recently added. The
BlinkState will be reset to BlinkState.None after the interval specified in
elapsed.
The identity for the table cell.
Blink state.
Gets the current for a cell indicating whether the cells
value was increased or decreased or if the record has been recently added. The
BlinkState will be reset to BlinkState.None after the interval specified in
elapsed.
The descriptor of the field to which the cell belongs to.
The record object.
Returns the current for the given cell.
Determines whether the UseOldListChangedHandler property was modified.
True if it was modified; Otherwise False.
Discards any changes for the UseOldListChangedHandler property.
Determines whether the EnableAutoSize property was modified or not.
True if it was modified.
Discards any changes for the EnableAutoSize property.
Determines whether the content of UseLazyUniformChildListRelation property was modified or not.
True if it was modified.
Discards any changes for the UseLazyUniformChildListRelation property.
Marks the field in the record to be repainted later when
the grid paints pending changes from ListChanged events as
specified with .
The record.
The name of the file.
This example shows how to use the method.
// Repaints the given record with respect to the field name.
Record recd = this.gridGroupingControl1.Table.CurrentRecord;
this.gridGroupingControl1.AddPendingUpdate(recd,"StateId");
' Repaints the given record with respect to the field name.
Dim recd As Record = Me.gridGroupingControl1.Table.CurrentRecord
Me.gridGroupingControl1.AddPendingUpdate(recd,"StateId")
Marks the record to be repainted later when
the grid paints pending changes from ListChanged events as
specified with .
The record.
This example shows how to use the method.
// Repaints the given record.
Record recd = this.gridGroupingControl1.Table.CurrentRecord;
this.gridGroupingControl1.AddPendingUpdate(recd);
' Repaints the given record.
Dim recd As Record = Me.gridGroupingControl1.Table.CurrentRecord
Me.gridGroupingControl1.AddPendingUpdate(recd)
Marks the whole grid to be repainted later when
the grid paints pending changes from ListChanged events as
specified with .
Sets the updated state of the grid.
Checks the grid if there are pending changes from ListChanged events
and enough time has elapsed since the last update as specified with
.
Marks a summary field to be updated next time when
the grid paints pending changes from ListChanged events as
specified with .
The group that defines a set to record that belongs to a category.
The field the summary is dependent on.
Triggered when the event is done in the grid.
The contains the event data.
Raises the event.
Event data.
Occurs when the event is done.
The contains the event data.
Occurs when the event is done.
The contains the event data.
Gets or sets the value that will be written out by CodeDom serializer to help us internally
determine the version that was used when code was generated.
Gets or sets a value indicating whether to resize the columns proportionally fit its content or not.
Gets or sets a value to assign the placement of the sort icon.
Gets or sets the value that indicates whether the list should be attached to
property or if you would like the engine to be detached from the . The default value is True.
Gets the for the assigned DataSource and DataMember.
Gets or sets a value indicating whether the engine can wrap access to a with a which provides
optimized access to the rows of the DataTable.
The Engine will access a DataTable through this wrapper class instead of accessing records through the DataTable.DefaultView
to increase performance when adding, removing and changing records when
is enabled. The default value is False.
Gets or sets if the default value for fields in the AddNewRecord should be shown when it is not in edit-mode or not. If
the is false then the default values will only be assigned when
AddNewRecord.BeginEdit is called. Prior calls to AddNewRecord will return no value in that case.
Gets or sets a value indicating whether the engine should cache copies of the old values from a record in the record object.
You can access these values with the Record.GetOldValue method. Setting this property will override
the default value returned by .
Gets or sets a value indicating whether to make the grid read-only or not.
Gets or sets a value indicating whether the engine should set to true when the data source
raises a ListChanged event with ListChangedType.Reset notification. The default is false.
Gets or sets a value indicating whether to auto-populate relations or not.
It specifies if relations should be automatically generated when you assign a
DataSource a DataTable with constraints or a DataSet with relations defined.
Default is True.
Version 4.4 also added support for automatically populated nested collections. If
you upgrade from an earlier version and relied on the engine not populating nested collections
from your strong typed collection you should set this property to be false.
With nested collection you can also specify the level of recursion allowed when self-relations
are detected. See the Engine.MaxNestedCollectionRecurseLevel property.
Gets or sets a a value indicating whether to display nested property fields or not.
This property affects the auto population of the FieldDescriptorCollection.
It specifies if individual fields should be added for every property of a type
when a type has nested properties. You can also control this behavior at run-time
with the QueryShowNestedPropertiesFields event. Default is True.
Gets or sets the show relational fields enum value.
This property affects the auto population of the FieldDescriptorCollection.
It specifies if dependent fields from a related table in a foreign key relation (or related collection)
should be added to the
main tables FieldDescriptorCollection. You can also control this behavior at run-time
with the QueryShowRelationDisplayFields event. Default is ShowRelationFields.ShowDisplayFieldsOnly.
Gets the reference to the that maintains a collection
of IList or DataTables that are used by main table or related tables as datasources.
Gets or sets a value indicting whether the culture format of numbers and dates in expressions should be in invariant format or UI culture dependent format
In invariant format numbers and dates are always in English format, e.g. use a '.' as decimal separator and dates in format mm/dd/yy.
In UI culture dependent format the decimal separator can be a ',' or some other setting specified in CultureInfo.CurrentUICulture.
Gets or sets the culture information which holds rules for parsing and formatting numbers and dates
in expression fields.
In invariant format numbers and dates are always in English format, e.g. use a '.' as decimal separator and dates in format mm/dd/yy.
In UI culture dependent format the decimal separator can be a ',' or some other setting specified in CultureInfo.CurrentUICulture.
Gets or sets the site of the control.
Occurs when a property is changed.
Occurs before a property is changed.
Gets the panel which hosts the control.
Gets the panel which hosts the control.
Gets the vertical splitter which divides the and .
Gets or sets a value that indicating whether to enable or disable the touch mode.
Gets or sets a value indicating whether the caption row is frozen or not. It works only when ShowCaption property is set to True.
Gets or sets the engine object which maintains all TableDescriptors and tables
to be displayed in the grid control.
When you assign a GridEngine object using this property, the existing engine
object is not replaced. Instead all properties and collections are copied
from the assigned engine object using the method.
initializes the object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
Gets or sets whether the grid should move the current cell to the first
visible record when the focus is moved to the grid.
Gets or sets the value to be used as default for cell borders.
Gets or sets the behavior of the current cell getting activated.
This example shows how to use the property.
// Activates the current cell on Double-clicking the cell.
this.gridGroupingControl1.ActivateCurrentCellBehavior = GridCellActivateAction.DblClickOnCell;
' Activates the current cell on Double-clicking the cell.
Me.gridGroupingControl1.ActivateCurrentCellBehavior = GridCellActivateAction.DblClickOnCell
Gets or sets the scroll cell in view behavior of the grid.
Gets or sets the color for alpha blended color value for cell selections.
This example shows how to use the property.
// Sets the selection-highlighting color.
this.gridGroupingControl1.AlphaBlendSelectionColor = Color.SteelBlue;
' Sets the selection- highlighting color.
Me.gridGroupingControl1.AlphaBlendSelectionColor = Color.SteelBlue
Gets or sets Excel-like current cell behavior. When the user clicks on a cell out of a selected range for which .Enabled has been set to false.
Gets or sets the in the GridModel class for information.
Gets or sets a value indicating whether the control can use the kind of textbox control which is compatible for RTL mode or not.
In general the original text box behaves better than the rich-text box with Hebrew and Arabic languages.
By default the grid uses the RichTextBox control for cell editing, but if you set
UseRightToLeftCompatibleTextBox to true then the grid will do editing with original TextBox controls
instead.
Gets or sets a value indicating whether the column header for the current cell should be highlighted or not.
Gets or sets a value indicating whether the row header for the current cell should be highlighted or not.
Gets or sets a value indicating whether the grid should display the column headers or not.
Gets or sets a value indicating whether horizontal lines should be displayed or not.
Gets or sets a value indicating whether vertical lines should be displayed or not.
Gets or sets a value indicating whether to enable or disable the Legacy styles in the Table Model.
The value should be false to apply ColorStyles.
Gets or sets the color of grid lines.
Gets or sets a value indicating whether column headers should be printed while printing the grid or not.
Gets or sets a value indicating whether the grid should draw horizontal lines while printing or not.
Gets or sets a value indicating whether row headers should be printed while printing the grid or not.
Gets or sets a value indicating whether the grid should draw vertical lines while printing the grid or not.
Gets or sets a value indicating whether row headers should be displayed or hidden. (Might be better to use HideCols[0] = false) instead.
Gets a value that indicates whether the window handle is destroyed or not.
Gets or sets a value indicating whether the grid should try and reduce flickering at startup.
If set to true the grid will be rendered once into a offline bitmap before the form
is shown for the first time. This offline rendering of the grid ensures that all required code is
loaded into memory (jitted) and all grid data are initialized. Default is true.
Gets or sets a value indicating whether the engine should reset the TableDescriptor, Relations
and clear out the SourceListSet or not when you set the Engine.DataSource = null.
Gets or sets the data source that the control is displaying data for.
This example shows how to use the property.
// Data source.
DataCollection dataSource = new DataCollection();
//Assigning datasource for grid.
this.gridGroupingControl1.DataSource = dataSource;
' Data source.
Dim dataSource As New DataCollection()
'Assigning datasource for grid.
Me.gridGroupingControl1.DataSource = dataSource
Gets or sets whether the bounded datasource is composed of dynamic objects or not. Applicable only for .NET Framework 4.0 and later.
Occurs immediately before the FieldChooser dialog is displayed.
Occurs after the FieldChooser dialog is displayed.
Occurs immediately before the FieldChooser dialog is closed.
Occurs immediately after the FieldChooser dialog is closed.
Occurs When the DataSource is about to Change.
Occurs When the DataSource is to Changed.
Gets or sets the specific list in a for which the control displays the data.
Gets or sets a value that indicating whether the should be visible or not.
Gets or sets whether the should be top,right,left or bottom.
This example shows how to use the property.
// Sets the alignment of the group drop area in the grid.
this.gridGroupingControl1.GroupDropAreaAlignment = GridGroupDropAreaAlignment.Top;
' Sets the alignment of the group drop area in the grid.
Me.gridGroupingControl1.GroupDropAreaAlignment = GridGroupDropAreaAlignment.Top
Gets or sets a value indicating whether the should be in Hierarchical or not.
Gets or sets a value indicating whether the Tab key should be used to move from cell to cell (= true) or
if it should select the next control in the parent form (= false). Default is true.
Gets or sets a value indicating whether to enable or disable Office2007ScrollBars.
Occurs when the property has changed.
Occurs when the property has changed.
Triggered when the property has changed.
Gets or sets the style of Office2007 scroll bars.
This example shows how to use the property.
// Enables the Office2007 scroll bars.
this.gridGroupingControl1.Office2007ScrollBars = true;
// Sets the color schemes for the Office2007 scroll bars.
this.gridGroupingControl1.Office2007ScrollBarsColorScheme = Office2007ColorScheme.Black;
' Enables the Office2007 scroll bars.
Me.gridGroupingControl1.Office2007ScrollBars = True
' Sets the color schemes for the Office2007 scroll bars.
Me.gridGroupingControl1.Office2007ScrollBarsColorScheme = Office2007ColorScheme.Black
Occurs when the property has changed.
Occurs when the property has changed.
Gets or sets the Office like scrollbars.
Gets or sets the styles of Office2010 scroll bars.
Gets or sets the styles of Office2016 scroll bars.
Gets or sets a value indicating whether the
should be visible or not.
Gets or sets a value indicating whether the Intelisense of mouse should be spanned or not when the user presses the middle mouse button and drags the mouse,
the window will scroll.
Gets or sets a value indicating whether the control should be drawn using Windows XP Themes(if available) or not.
Gets or sets the base styles for the grid.
Maintains a collection of base styles. Users can add BaseStyles to the engine (also in design-time) and
then inherit style settings through the GridStyleInfo.BaseStyle property in
property of .
Gets or sets the table schema information of the root table from the datasource.
Gets the table value associated with the engine.
The table object manages the records from the engine's DataSource and
provides access to records and grouped elements through several
collection classes, most prominent the .
Gets the record navigation control which hosts the record navigation bar in the grid
and also the .
The control is only visible
if is set.
It is a child control of the .
Gets the hosted . The GridTableControl is a grid derived from
GridControlBase and displays and allows user interaction and modification of data.
This control is either a child control of the
or depending on whether is set.
Gets the of the .
The GridTableModel is derived from the GridModel and adds support for retrieving
data from the datasource for a .
Gets the GridGroupDropArea control to the grid. Its purpose is to allow dragging header columns
from the GridTableControl for user-interactive grouping of records.
The control is a child control of the .
Gets or sets the VisualStyles property values to the grid.
This example shows how to use the property.
// Sets the visual styles for the grid. Make sure to set the "ThemesEnabled=true;"
this.gridGroupingControl1.GridVisualStyles = GridVisualStyles.Metro;
' Sets the visual styles for the grid. Make sure to set the "ThemesEnabled=true;"
Me.gridGroupingControl1.GridVisualStyles = GridVisualStyles.Metro
[Deprecated] Gets or sets the enhanced VisualStyles (skins) like Office2010, Office2007, Office2003.
Occurs for each cell before a
starts painting and lets users customize the display of cells.
Gets the instance of the to show or hide scrollbars and also consider the control's
setting.
Gets or sets the border style of the control.
This example shows how to use the property.
// Sets the border style of the grid.
this.gridGroupingControl1.BorderStyle = BorderStyle.FixedSingle;
' Sets the border style of the grid.
Me.gridGroupingControl1.BorderStyle = BorderStyle.FixedSingle
Gets the Themed window.
Gets or sets whether ScrollTips should be displayed when
the user drags the horizontal scrollbar's thumb bar.
Gets or sets a value indicating whether the grid should scroll and update its contents or not
while the user drags the horizontal scrollbar's thumb bar.
Gets or sets a value indicating whether ScrollTips should be displayed or not when
the user drags the vertical scrollbar's thumb bar.
Gets or sets a value indicating whether the grid should scroll and update its contents
while the user drags the vertical scrollbar's thumb bar.
Gets or sets a value indicating whether the control should enable its Accessibility support.
Gets or sets a value indicating whether the ToolTips should be shown or not when the user
hovers the mouse over elements of the .
Gets or sets the split bars for the record navigation control.
Gets or sets the default with default
information for all cell elements in the control. This property lets you control almost any aspect of
the appearance of the grouping grid like cell backcolor, font, or the cell type.
Gets the default appearance settings for the grid at runtime. These settings will
not be serialized or written to good and can be used if you want to specify default
settings for a derived GridGroupingControl. Any appearance element
in the engine will inherit these settings.
Gets the collection of with default
information for RecordFieldCell elements
based on the columns System.Type. Each basic type has default style information
registered with this collection.
The collection contains pre-defined settings such as HorizontalAlignment for numbers and
cell type (e.g. check box for boolean).
GridPropertyTypeDefaultStyle settings have less precedence in styles inheritance than
styles.
Note: Changes you make to this collection do not get serialized; you will need
to reapply any changes even if you read back the schema from an XML file.
Gets or sets to control the look of inner groups like whether the Caption Row is visible, or what CaptionText is.
Gets or sets the table-wide properties like the width of the indent column, or whether header rows should be visible.
Gets or sets look of the top most group such as whether the Caption Row is visible, or what CaptionText is.
This example shows how to use the property.
// Provides the top-level (parent level) features to handle.
this.gridGroupingControl1.TopLevelGroupOptions.ShowCaption = true;
this.gridGroupingControl1.TopLevelGroupOptions.CaptionText = "Info of GGC";
' Provides the top-level (parent level) features to handle.
Me.gridGroupingControl1.TopLevelGroupOptions.ShowCaption = True
Me.gridGroupingControl1.TopLevelGroupOptions.CaptionText = "Info of GGC"
Gets or sets the look of the topmost group of nested tables such as whether the Caption Row is visible, or what CaptionText is.
This example shows how to use the property.
// Provides options to handle Nested tables in the grid.
this.gridGroupingControl1.NestedTableGroupOptions.CaptionText = "myNestedTable";
int captionLength = this.gridGroupingControl1.NestedTableGroupOptions.CaptionSummaryRow.Length;
Console.WriteLine("The length of the caption text is " + captionLength);
' Provides options to handle Nested tables in the grid.
Me.gridGroupingControl1.NestedTableGroupOptions.CaptionText = "myNestedTable"
Dim captionLength As Integer = Me.gridGroupingControl1.NestedTableGroupOptions.CaptionSummaryRow.Length
Gets or sets a value indicating whether to use optimization filter in GridGroupingControl or not.
Gets or sets the value indicating whether to force the grid to dispose or not when the data source gets reset.
Property FilterRuntimeProperties (bool)
Gets the default size of the control.
Occurs for each GridSummaryColumnDescriptor before the is determined. You must handle this event if you specified as .
Occurs when a record is checked whether it meets filter criteria and should appear visible in the table's DisplayElements.
Gets or sets the font used to display text in the grid.
Gets or sets the back color of the grid.
This example shows how to use the property.
// Sets the back-color to the grid.
this.gridGroupingControl1.BackColor = Color.SteelBlue;
' Sets the back-color to the grid.
Me.gridGroupingControl1.BackColor = Color.SteelBlue
Gets or sets the RTL mode of the grid.
Gets or sets the font color of the grid.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the user hovers the mouse over a column header or clicks on it.
In your event handler, you can determine if the selected column can be dragged.
You can disallow dragging the column when
you assign False to .
Occurs when the user drags a column header over the GroupDropArea.
In your event handler, you can determine if the grid can be grouped by the selected column.
You can disallow grouping by the column when
you assign False to .
Occurs when the user hovers the mouse over a column header or clicks on it.
In your event handler, you can determine if the selected column can be sorted.
You can disallow sorting by the column when
you assign False to .
Occurs when the user navigates though display elements with arrow keys.
In your event handler you can determine if the specified display element (e.g. a CaptionRow) can be stepped
on or if it should be skipped.
You can set AllowNavigateTo if you
want arrow keys to skip over specific display elements (e.g. skip caption rows).
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments of the event are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments of the event are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when the event of the underlying is raised.
The original event arguments are provided with the property of the
class.
Occurs when a unknown exception has been cached while modifying underlying data in the datasource.
If necessary, you can rethrow the exception in your event handler.
Occurs before a group is collapsed.
Occurs before a group is collapsed.
Occurs before a group is expanded.
Occurs after a group was expanded.
Occurs before a record with nested tables is collapsed.
Occurs after a record with nested tables is collapsed.
Occurs before a record with nested tables is expanded.
Occurs after a record with nested tables is expanded.
Occurs before a record is deleted.
This event is raised only when the or triggers the deletion. If
the underlying source list deletes the record, a event is raised instead.
Occurs after a record is deleted.
This event is raised only when the or triggers the deletion. If
the underlying source list deletes the record, a event is raised instead.
Occurs before and after the status of the current record is changed. Check the
of the to get information on which current record state was changed.
Occurs when the method of the was called.
The GridGroupingControl listens to this events and resets any "Current Cell" state when this
event is raised.
Occurs when a summary has been marked dirty.
The GridGroupingControl listens to this event and will force a repaint of the specified summary if it is visible
when this event was raised.
Occurs before the processes the event
of an attached source list. More detailed events will be
raised after this event.
The reason for firing this event is to give a programmer the chance to react to an
event before the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged
event.
Occurs after the processes the event
of an attached source list.
The reason for firing this event is to give a programmer the chance to react to an
event right after the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged
event.
Occurs when a record in the underlying data source is added, removed, or changed and after
the was updated with that change.
Occurs when a record in the underlying data source is added, removed or changed and before
the is updated with that change.
Specify this if you do not want TableControl to use built-in paint mechanism
when ListChanged events are handled. (Makes TableControl.Table_SourceListRecordChanging
and TableControl.Table_SourceListRecordChanged return immediately)
Lets you specify whether the grid should simply call Invalidate
when a ListChanged event is handled or if it should determine the area
that is affected by the change and call InvalidateRange. With version 4.4
check also the and
properties.
On first sight, you might think it better to determine the area
that is affected by a change and call InvalidateRange.
But when calling InvalidateRange, the grid needs to know the
exact position of the record in the table before it can mark that area dirty.
In order to determine the record position (and y-position of the row in the display),
counters need to be evaluated. This operation can cost more time than simply
calling Invalidate in high-frequency update scenarios.
Also, be aware that the group caption bar needs to be updated when a
record changes.
With version 4.4 check out the new InsertRemoveBehavior and SortPositionChangedBehavior
properties and the UpdateDisplayFrequency properties that will speed up things a lot
if InvalidateAllWhenListChanged = false.
Occurs when a new group is added in a table after the table was categorized and when a record is changed. The event does not
occur during categorization of the table. See the elements to when categorization
finished.
Occurs when a group is removed from a table after the table was categorized and when a record is changed. The event does not
occur during categorization of the table. See the elements to when categorization
finished.
Occurs before the records for a group are sorted.
The engine has a built-in optimization for sorting columns that allows it to perform the sorting
on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and
you change the sort order of the cities. It is not necessary to sort the whole table. Instead,
the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and
SortedItemsInGroup events are fired in such case when a specific group was sorted on demand.
If the whole table was set to dirty (see ), then the whole table
is simply recategorized. In that case, only a CategorizedElements event is raised but no
SortingItemsInGroup event.
Occurs after the records for a group are sorted.
The engine has a built-in optimization for sorting columns that allows it to perform the sorting
on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and
you change the sort order of the cities. It is not necessary to sort the whole table. Instead,
the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and
SortedItemsInGroup events are fired in such case when a specific group was sorted on demand.
If the whole table was set to dirty (see ), then the whole table
is simply recategorized. In that case, only a CategorizedElements event is raised but no
SortingItemsInGroup event.
Occurs when the of a was called
and before all counters are marked dirty.
Occurs when the of a is called
and before all summaries in that table are marked dirty.
Occurs before records are categorized after a table is marked dirty ().
When is set to True, e.g. because schema information for a table was changed
or because the grouped columns were changed, the table will categorize records on demand the first time
information about a record is accessed. At that time, the of the will start
categorization.
Occurs after records are categorized after a table is marked dirty ()
When is set to True, e.g. because schema information for a table was changed
or because the grouped columns were changed, the table will categorize records on demand the first time
information about a record is accessed. At that time, the of the
will start
categorization.
Occurs after the datasource was replaced.
Occurs when a RecordFieldCell cell's value is changed and before Record.SetValue is called.
Occurs when a RecordFieldCell cell's value is changed and after Record.SetValue returned.
When number of visible elements were changed.
When number of visible elements were changed.
Occurs before the collection is modified.
Occurs after the collection was modified.
Gets or sets an object that handles events raised by the object.
Gets or sets the navigation bar.
Occurs after the current record of the navigation bar is changed.
Occurs before the current record of the navigation bar is changed.
Occurs when a value for a field descriptor and record is returned. See the Grid\Grouping\Samples\CustomSummary
sample how to use this event with unbound field descriptors.
Occurs when a value for a field descriptor and record is saved. See the Grid\Grouping\Samples\CustomSummary
sample how to use this event with unbound field descriptors.
Specifies delayed update behavior when changes are made to the underlying engine from outside of WndProc of this
control, for example when changes made through an external PropertyGrid attached to the engine.
The grid does not to call update after each and every operation. Instead it leaves the
update to the end user or to user interaction. Normally, operations on the engine are
triggered from within a WndProc call. In the grids WndProc routine the grid will call its base
class version and then after the WndProc returns it will call synchronize any changes to the underlying
engine with the display if the message was a mouse operation.
This has the big advantage that users don't have to worry about calling BeginUpdate / EndUpdate in
mouse handling code. You can just batch operations and then manually call Update(). The programmer
does not have to worry about calling Update() since that will be done once the Mouse event returns
and the GridTableControl.WndProc is executed. The idea is to have good performance for the most typical case.
Updating the grid after every operation would be too expensive (e.g. if you loop through the records and set
IsExpanded = true for each record).
Occurs each time the is called to get the raw string that represents the underlying cell's value.
This event allows you to customize how to represent a cell's value as string at run-time on demand.
If you do want to customize the grid's default conversion, you should assign the result string
to and set
to True. The grid will check this flag to see whether it should return
or use a default conversion.
If you need identity information about the cell such as row and column index, you can get that
information by querying of the
object.
Occurs each time the is called to set the unformatted string that represents the underlying cell's value.
This event allows you to customize how to parse the unformatted text into a cell value at run-time on demand.
If you do want to customize the grid's default parsing behavior, you should assign the resulting value
to the of the object
and set
to True. The grid will check this flag to see whether it should accept your modification
or use a default parsing routine.
If you need identity information about the cell such as row and column index, query the of the
object.
See the event for further discussion since these two events
are very similar. Often you will need to handle both events in your code in the same way.
Occurs each time the is called to get the formatted string that represents the underlying cell's value
considering .
This event allows you to customize how to format a cell's value as string at run-time on demand based on .
If you do want to customize the grid's default formatting, you should assign the resulting string
to and set
to True. The grid will check this flag to see whether it should return
or use a default formatting routine.
If you need identity information about the cell such as row and column index, you can get that
information by querying the of the
object.
Occurs each time the is called to parse the formatted string that represents the underlying cell's value
considering and .
This event allows you to customize how to parse the formatted text into a cell value at run-time on demand.
If you do want to customize the grid's default parsing behavior, you should assign the resulting value
to the of the object
and set
to True. The grid will check this flag to see whether it should accept your modification
or use a default parsing routine.
If you need identity information about the cell such as row and column index, you can get that
information by querying the of the
object.
This event is normally called from within , which is called
when the user enters text into a text box or when text is assigned to .
ApplyFormattedText method checks if there are event handlers for and
if the is not set, they try to convert the input text into
the type specified with .
If this conversion fails, will check . If it
is True, an exception is thrown which itself results in a warning message displayed to the user at the
time from .
If you set to False, will not throw
an exception and simply store the text as .
If you need a more specialized customization of this behavior, you should handle the
event. This lets you parse the text input
and change the cells at run-time. See the attached example.
This example parses the text input and changes the cell's CellValueType at run-time if the input does not match the current CellValueType.
void InitializeComponent()
{
// initialize code
// ...
this.gridControl1.SaveCellText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_SaveCellText);
this.gridControl1.QueryCellFormattedText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_QueryCellFormattedText);
this.gridControl1.SaveCellFormattedText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_SaveCellFormattedText);
this.gridControl1.QueryCellText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_QueryCellText);
}
private void gridControl1_QueryCellFormattedText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{
}
private void gridControl1_QueryCellText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{
}
private void gridControl1_SaveCellText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{
ParseText(e);
}
private void gridControl1_SaveCellFormattedText(object sender, GridCellTextEventArgs e)
{
ParseText(e);
}
void ParseText(GridCellTextEventArgs e)
{
// By default, the grid will display a warning message box informing the user
// the entered value is not valid and the user will have to change the value.
//
// In this event handler, we change the grid default's behavior such that
// when the user enters a value that does not fit the cell's CellValueType,
// the input text is accepted and no warning message is shown.
if (e.Handled)
return;
System.Globalization.CultureInfo ci = e.Style.CultureInfo;
System.Globalization.NumberFormatInfo nfi = ci != null ? ci.NumberFormat : null;
try
{
e.Style.CellValue = GridCellValueConvert.Parse(e.Text, e.Style.CellValueType, nfi, e.Style.Format);
}
catch (Exception ex)
{
if (ex is FormatException || ex.InnerException is FormatException)
{
e.Style.CellValue = e.Text;
// possibly could also change CellValueType here
e.Style.CellValueType = typeof(string);
// - or -
// you could also further analyze the input text and assign a type
// that fits the input text, e.g.
// e.Style.CellValueType = typeof(datetime);
// - or -
// e.Style.CellValueType = typeof(decimal);
// etc.
}
else
throw;
}
e.Handled = true;
}
Private Sub InitializeComponent()
' Initalize code
' ...
AddHandler Me.gridControl1.SaveCellText, AddressOf Me.gridControl1_SaveCellText
AddHandler Me.gridControl1.QueryCellFormattedText, AddressOf Me.gridControl1_QueryCellFormattedText
AddHandler Me.gridControl1.SaveCellFormattedText, AddressOf Me.gridControl1_SaveCellFormattedText
AddHandler Me.gridControl1.QueryCellText, AddressOf Me.gridControl1_QueryCellText
End Sub 'InitializeComponent
Private Sub gridControl1_QueryCellFormattedText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
End Sub 'gridControl1_QueryCellFormattedText
Private Sub gridControl1_QueryCellText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
End Sub 'gridControl1_QueryCellText
Private Sub gridControl1_SaveCellText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
ParseText(e)
End Sub 'gridControl1_SaveCellText
Private Sub gridControl1_SaveCellFormattedText(sender As Object, e As GridCellTextEventArgs)
ParseText(e)
End Sub 'gridControl1_SaveCellFormattedText
Sub ParseText(e As GridCellTextEventArgs)
' By default, the grid will display a warning message box informing the user
' the entered value is not valid and the user will have to change the value.
'
' In this event handler we change the grid default's behavior such that
' when the user enters a value that does not fit the cell's CellValueType,
' the input text is accepted and no warning message is shown.
If e.Handled Then
Return
End If
Dim ci As System.Globalization.CultureInfo = e.Style.CultureInfo
Dim nfi As System.Globalization.NumberFormatInfo = Nothing
If (Not (ci Is Nothing)) Then nfi = ci.NumberFormat
Try
e.Style.CellValue = GridCellValueConvert.Parse(e.Text, e.Style.CellValueType, nfi, e.Style.Format)
Catch ex As Exception
If TypeOf ex Is FormatException OrElse TypeOf ex.InnerException Is FormatException Then
e.Style.CellValue = e.Text
' possibly could also change CellValueType here
' e.Style.CellValueType = typeof(string);
' - or -
' you could also further analyze the input text and assign a type
' that fits the input text, e.g.
' e.Style.CellValueType = typeof(datetime);
' - or -
' e.Style.CellValueType = typeof(decimal);
' etc.
Else
Throw
End If
End Try
e.Handled = True
End Sub 'ParseText
Use this event to provide support for parsing the formatted string and convert
it into the the underlying cell's value
considering and .
This event is raised from GridCellModelBase.ApplyFormattedText after
was raised. The event is raised only
if the SaveCellFormattedText did not set e.Handled.
The grid has built-in support for parsing the Percent format (Format = "P") and Hexadecimal
format (Format = "X"). You should handle this event if you want to add support
for other formats.
GridCellTextEventArgs has information about the style settings of the cell. You can
inspect that style to get information about Format and CellValueType of the cell.
Occurs to determine if the cell belongs to a covered range and returns the covered range of the cell or
the cell itself as if it is not a covered range.
Used internally.
Specifies the number of milliseconds to wait between display updates when new ListChanged event handler logic
is used. This property does have no any effect if UseOldListChangedHandler = true. Special values are
0 - only manually update display by calling grid.Update() and 1 - update display immediately after each
change.
Specifies how the grid should react if records are inserted or deleted.
Specifies how the grid should react if records are inserted or deleted through direct
user interaction with AddNew record.
Specifies how the grid should react if the sort position of a record records changes.
Specifies how the grid should react if the sort position of a record records changes when the current record
is edited interactively by user.
Gets or sets the time in milliseconds how long to highlight values in a record after a change
was detected. The engine will highlight a cell for the specified period in milliseconds if
the value was increased or decreased. If set to 0 the feature is disabled.
Gets or sets when checks for updates will happen while blinking support is enabled.
When blinking support is enabled, the default behavior is to use the Application.Idle event to test
whether pending cell refreshes are required. If the Idle event is not being reliably raised in a timely fashion in your
application, you can use this property to tell the grid to use either a System.Threading.Timer or a
System.Windows.Forms.Timer to facilitate the grid testing for pending cell updates.
Gets or sets the timer interval (in milliseconds) used with is set to use one of
its timer methods to determine when the grid is refreshed for blinking.
Initializes recommended settings to improve handling of ListChanged events
and scrolling through grid. Affected settings are: TableOptions.ColumnsMaxLengthStrategy,
TableOptions.GridLineBorder, TableOptions.DrawTextWithGdiInterop, TableOptions.VerticalPixelScroll,
Appearance.AnyRecordFieldCell.WrapText and Appearance.AnyRecordFieldCell.Trimming.
Gets or sets the value of the allowed optimizations that the engine can use when applicable.These optimizations can be used
in combination with EngineCounter setting.
This example shows how to use the property.
// Sets the engine optimizations options.
this.gridGroupingControl1.AllowedOptimizations = Syncfusion.Grouping.EngineOptimizations.VirtualMode;
' Sets the engine optimizations options.
Me.gridGroupingControl1.AllowedOptimizations = Syncfusion.Grouping.EngineOptimizations.VirtualMode
Gets or sets a value indicating whether the grid should use old list changed event handler or not.
With version 4.4 the engine changed the way how the ListChanged event is handled internally
to fix short-comings with performance of the code that was in place earlier. This property
lets you switch back
the behavior of the engine to the old mechanism if you notice compatibility issues. The default value is false.
Gets or sets a value indicating whether the AutoSize behavior should be enabled or not.
When you use the new UniformChildList behavior (i.e. when Engine.UseOldUniformChildListRelation = false)
you can specify with this UseLazyUniformChildListRelation property whether the engine should
access and enumerate the child collections only once the user expands a record.
This will speed up load time of the grid and reduce memory usage when not all records
get expanded.
Gets or sets a value indicating whether the engine handles the ListChanged event or not. This will itself raise numerous events. When set
to true this the events will only be raised on the Engine object. If set to false
then events will also be raised on inner objects (will bubble up on nested tables which
caused some performance overhead). Property will only have effect if UseOldListChangedHandler = false.
Gets or sets the counter logic to be used within the engine. If you have a large datasource
and need support for groups and filtered records you can reduce the memory footprint
by selectively disabling counters you do not need in your application.
See EngineOptimizations.DisableCounters for completely disabling counter logic for the RecordsDetails collection if you do not need
grouping and filtering.
See EngineOptimizations.VirtualMode for using the engine in a virtual mode if you do not
need support for sorting.
Triggered when grid paints pending changes from ListChanged events as
specified with .
Gets or sets a value indicating whether the engine should sort mapping names alphabetically or not
in the dropdown editors of the property grid. Default value is false.
Occurs when GridTableDescriptor is initializing columns with .AllowFilter set and gives
you the option to handle filterbarchoices through custom code. In such case the event is also raised
when the user clicks on dropdown button of a GridTableFilterBarCell.
Occurs when an item selected through the filtered dropdown is changing.
Occurs when the filterbar's selected item gets changed in the filter dropdown.
Defines the class that provides data for cancelable events.
Initializes a new instance of the class.
Initializes a new instance of the class specified to cancel the event or not.
True, cancel the event; Otherwise False.
Initializes a new instance of the class specified with the data source.
The data source associated with the grid.
Initializes a new instance of the class specified to cancel an event and the datasource of the grid.
True, cancel the event; Otherwise False.
The datasource of the grid.
Gets the DataSource
DataSourceChanging delegate
The Control.
The contains the event data.
Occurs when the event is done.
The control.
The contains the event data.
Implements the class that provides data about event of a .
Initializes a new instance of the class.
The type of OfficeScrollBar.
Gets or sets the Office scroll bars.
Defines the class that provides the support for events from the instances of the class.
Initializes a new instance of the class.
The instance of the class.
The instance of the class.
Disposes of the object.
Defines the class that denotes the GroupPanel.
It has been initiated to override the Hide() method.
Overrides and suspend the Hide() method of the Panel.
Specifies delayed update behavior when changes are made to the underlying engine from outside of WndProc of this
control, for example when changes made through an external PropertyGrid attached to the engine.
The grid does not to call update after each and every operation. Instead it leaves the
update to the end user or to user interaction. Normally, operations on the engine are
triggered from within a WndProc call. In the grids WndProc routine the grid will call its base
class version and then after the WndProc returns it will call synchronize any changes to the underlying
engine with the display if the message was a mouse operation.
This has the big advantage that users don't have to worry about calling BeginUpdate / EndUpdate in
mouse handling code. You can just batch operations and then manually call Update(). The programmer
does not have to worry about calling Update() since that will be done once the Mouse event returns
and the GridTableControl.WndProc is executed. The idea is to have good performance for the most typical case.
Updating the grid after every operation would be too expensive (e.g. if you loop through the records and set
IsExpanded = true for each record).
No special delay update behavior. Programmer has to manually call Update. Only when a mouse message is handled
WndProc will automatically synchronize display with engine.
Use a timer do delay synchronization whenever changes in engine are detected that need the screen to be updated.
PostCustomMessage and Timer can be combined.
Post a custom message to the message loop whenever changes in engine are detected that need the screen to be updated
Post a custom message to the message loop and do also trigger a timer whenever changes in engine are detected that need the screen to be updated
Specifies the blink state for a cell indicating whether the cells
value was increased or decreased or if the record has been recently added. The
BlinkState will be reset to BlinkState.None after the interval specified in
elapsed.
No change was detected recently.
Value of cell was increased.
Value of cell was reduced.
Cell belongs to a record that
has been recently added or cell was null before.
A value has been applied to a cell that was null before.
Null has been applied to a cell that was a valid value before.
Determines the blink update mode while blinking support is enabled.
The default blink mode of blinking only on grid redraws.
The enabled timer to redraw on each blink.
Update the grid if it runs on separate UI thread.
Determine the GridGroupDropAreaAlignment.
Aligns GridGroupDrop in top of Grid.
Aligns GridGroupDrop in Left of Grid.
Aligns GridGroupDrop in Right of Grid.
Aligns GridGroupDrop in Bottom of Grid.
Defines a class that provides the grid with the optimized list changed events. Used internally.
Initializes the new instance of the class.
The grouping grid control.
Performs the blink operation.
The Control.
The contains the event data.
Allows the custom formatting of a cell by changing its style object.
The Control.
The contains the event data.
Gets the current for a cell indicating whether the cells
value was increased or decreased or if the record has been recently added.
The identity for the table cell.
Blink state.
Gets the current for a cell indicating whether the cells
value was increased or decreased or if the record has been recently added.
The blink state of the specified record.
The field descriptor of the specified record.
Blink state.
Performs the insertion of elements.
The element to be inserted.
If True allows the updating of the element; Otherwise False.
If True the visibility of the element, it gets updated; Otherwise False.
The bounds of the element inserted.
Scrolls the contents of the control.
The table control.
Horizontal scroll offset.
Vertical scroll offset.
Scroll bounds.
Clipping rectangle.
If true, redraws the invalidated regions within its client area.
Resultant rectangle that was scrolled into view.
Determine the imidiate updates.
Occurs when a record in the underlying datasource is added, changed or removed and before the Table was updated with this change.
Event source.
Event data.
Occurs when a record in the underlying datasource is added, changed or removed and after the Table was updated with this change.
Event source.
Event data.
Occurs when a property gets changed.
The Control.
The contains the event data.
Occurs when the grid size gets changed.
The Control.
The contains the event data.
Occurs when a group gets expanded.
The Control.
The contains the event data.
Occurs when a group is collapsed.
The Control.
The contains the event data.
Occurs when a record is expanded.
The Control.
The contains the event data.
Occurs when a record is collapsed.
The Control.
The contains the event data.
Occurs when the event of the underlying is raised.
The Control.
The contains the event data.
Clears the visible records.
Checks the visibility of the records in the grid.
Occurs when a summary has been marked dirty.
The Control.
The contains the event data.
Updates the grouped summary.
Process the grouped summary when any of the group events had occurred.
The contains the event data.
Adds the highlighted elements.
The highlighted element.
Marks a summary field to be updated next time the grid display is updated.
The group that defines a set to record that belongs to a category.
The field the summary is dependent on.
Marks the field in the record to be repainted later when
the grid paints pending changes from ListChanged events as
specified with .
The record.
The name of the filed to be updated.
Adds the pending updates information when the field info gets changed.
The record to be updated.
The contains the event data.
Adds the pending updates information.
The record to be updated.
Adds the pending updates information with the changed fields.
The changed record.
The values of the record changed.
Gets the pending updates information for the specified record.
The specified record.
The pending updates info of the specified record.
Paints the fields in records that were changed since last call
to PaintUpdatedRecordFields.
Draws the grid.
The clip bounds of the grid.
Occurs when the event of the underlying is raised.
The Control.
The contains the event data.
Process the blink queue operations.
Clears the pending updates.
Paints the updated record fields.
Paints the highlighted elements.
Paints the summary fields in group captions and summary rows that were changed since last call
to PaintUpdatedSummaryFields.
Paints the elements of the grid.
The instance of the class associated with the grid.
The element to be painted.
The field to be painted.
Occurs when the input focus leaves the control.
The Control.
The contains the event data.
Occurs when the grid application finishes its processing and is about to enter idle state.
Event source.
The contains the event data.
Updates the grid when there are pending changes from ListChanged events
and enough time has elapsed since the last update as specified with
.
Occurs before the records are categorized after the table is marked dirty.
Occurs when grid paints pending changes from ListChanged events.
The Control.
A contains the event data.
True if painting is successfully completed; Otherwise False.
Occurs when the focus leaves the control.
The Control.
The contains the event data.
Occurs before a event and allows you to cancel the mouse event.
The Control.
The contains the event data.
Occurs when a key is pressed when the control has focus.
The Control.
The contains the event data.
Occurs when the focus or keyboard user interface causes change.
The Control.
The contains the event data.
Triggered when the optimized list gets changed.
The Control.
The contains the event data.
Gets or sets the value of updating frequency of the grid.
Gets or sets the value of the item remove behavior of the grid.
Gets or sets the value of how the grid should react if the records are inserted or deleted through
direct user interaction with AddNew record.
Gets or sets the value of sort position changed behavior of the grid.
Gets or sets the value of the sort position when the record gets changed in the grid.
Gets a value indicating whether to disable automatic updates or not.
Gets or sets the blink time.
Gets a collection of visible records.
Defines the class that provides the blink state information of the grid.
Initializes the new instance of the class.
The blink state of the grid.
The record value.
The index of the field.
The blink count value.
The changed field's values.
Gets the key value for the current record.
A 64-bit unsigned integer value.
Gets the key value for the specified record and field index.
The record for which the key to be generated.
The index of the field.
Defines the class that provides the data to delete records.
Overrides and gets the string values of the current object.
The string values of the object specified.
Defines the class that holds information about summary fields in a group that needs to be repainted.
Initializes the new instances of the class with the specified group.
The group to be updated.
Gets the group.
Gets the fields in the group.
Defines the class that provides the pending updates information.
Defines a class that provides the grid table cell type converter. Used internally.
Overrides and gets the base style map.
An instance of the that holds the identity info.
An instance of the class.
Defines a form that hosts a and lets you browse schema information
of a .
Displaying the GridGroupingControlSchemaBrowser
private void Form1_Load(object sender, System.EventArgs e)
{
GridGroupingControlSchemaBrowser schemaBrowser = new GridGroupingControlSchemaBrowser(this.gridGoupingControl1);
schemaBrowser.Show();
}
Private Sub Form1_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
Dim schemaBrowser As New GridGroupingControlSchemaBrowser(Me.gridGoupingControl1)
schemaBrowser.Show()
End Sub 'Form1_Load
Initializes a new instance of the and attaches it to a
The grid grouping control.
Overrides and triggered when the visibility of the form gets changed.
The contains the event data.
Triggered when the property value of the grid gets changed.
The Control.
The contains the event data.
Triggered when the table descriptor property gets changed.
The Control.
The contains the event data.
Triggered when the engine's source list gets changed.
The Control.
The contains the event data.
Triggered when the form is in idle state.
The Control.
The contains the event data.
Overrides and triggered when the form gets closed.
The contains the event data.
Overrides and cleans up any resources being used.
Overrides and process the system messages.
The message to be processed.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Triggered when the save button is clicked.
The Control.
The contains the event data.
Triggered when the XML load button is clicked.
The Control.
The contains the event data.
Applies the schema.
The instance of the that reads the XML file.
The information regarding the file.
The description of the file.
Gets or sets a value indicating whether to enable or disable the automatic positioning of schema browser next to the parent form
of the grouping control when the schema browser is shown the first time.
Represents a windowless grid control that displays rows with of a nested
inside a parent table control. One is created for every nested relation.
A GridNestedTableControl is shared among all tables for a relation.
Represents a grid control that displays rows with of a and
allows grouping and filtering of records and editing, deleting, and adding of records.
Initializes a new instance of the class.
Initializes a new control.
The model for this control.
Returns a string holding the current object.
String representation of the current object.
Sets up listeners for the and initializes mouse controllers and data object consumers.
Releases listeners for the .
Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
Initializes the control.
Creates a new table control.
The parent control.
Row index.
Column index.
The new table control.
Determines the displayed at the specified point if it is a header cell.
The point in device coordinates.
The displayed at the specified point if it is a header cell; NULL otherwise.
Determines the displayed at the specified point if it is a header cell.
The point in device coordinates.
The displayed at the specified point if it is a header cell; NULL otherwise.
Overridden to restrict the error icon drawing for nested table on certain condition.
A that contains the event data.
The icon painter to draw the error icon.
Should scroll the nested table.
The nestedtable.
returns true if frozen column is not equal to string.empty, else false
Should invalidate when scrolled.
The nested table.
returns true if frozen column is not equal to string.empty, else false
Determines if a specified row is hidden in the current grid view.
The row index.
True if row should be hidden; False otherwise.
Returns the number of frozen columns.
Frozen column count.
Returns the number of frozen rows.
Frozen row count.
Updates the scrollbars with current scroll position and scroll range.
Scrolls an element into view.
Scrolls an element into view.
The element to scroll into view.
Scroll reason
True if scrolled; False if element was already visible or not valid.
Scrolls an element into view.
The element to scroll into view.
True if scrolled; False if element was already visible or not valid.
Gets the row height for the given range of rows.
The first row.
The last row.
Abort calculation if height is greater than this value.
Returns the row height.
Gets the smallest value to be used as TopRowIndex.
Returns the rectangle with scroll bounds for the grid.
Maximum top row index.
Calculates the vertical scroll pixel position for the given row.
Row index.
Vertical scroll pixel position.
Gets the total height of all rows in the grid.
Total row height.
Determines the row index that is located at the specified vertical pixel scroll position.
The absolute vertical pixel scroll position.
Returns the resultant row index.
Returns the number of pixels the top row is above the view area for the scroll position.
Gets the total width of the grid for pixel scrolling.
Total grid width.
Triggers when the displayelement tends to change.
Triggers when the displayelement changes.
Triggers when the sourcelist changes.
Triggers when the currentrecordmanager resets.
Returns the GridCurrentCell object.
The .
Returns the object or if the current cell is a nested table, returns the
of the .
The most inner object.
This is called from GridControlBase.ProcessKeyEventArgs and allows your customized cell renderer
to process keyboard events before the GridControlBase gets the actual KeyDown / KeyUp event.
The with data of the keyboard event.
True if key was handled; False otherwise.
Determine the process key event.
windows message
boolean value
Processes the dialog key.
The key code.
return boolean value
User pressed key down.
A holding the event data.
Called when user press a key.
A holding the event data
Called when Delete key is pressed. Default implementation deletes selected records.
true if records were deleted; false if no action was necessary.
Called when Escape key is pressed. Default implementation discards current record changes.
true if changes were discarded; false if no action was necessary.
Called when Enter key is pressed grid is validated. Default implementation commits current record changes.
true if changes were saved; false if no action was necessary.
Returns the parent control that has a window handle.
This control or the parent control that has a window handle if this control is windowless.
Forces the grid to synchronize ittself with changes in the underlying the next time
an Idle message is received or any Window message is processed.
Forces the grid to synchronize itself with changes in the underlying the next time
an Idle message is received or any Window message is processed.
Forces the grid to synchronize itself with changes in the underlying the next time
an Idle message is received or any Window message is processed.
Specifies if the width should be reset.
Synchronize the grid display with changes in the underlying .
Determine the hscroll position changing.
Determine the hscroll pixel
Determine the vertical scroll
Called to scroll the specified cell into view.
Row index.
Column index.
Specified if top row index and left column index should be changed
without raising scroll events and without updating the screen.
The reason for scrolling the current cell into view.
True if the operation is successful.
Sets input focus to the control.
True if the control is focused.
Updates the control.
Invalidates the control.
Invalidates the specified area of the control.
Area to invalidate.
Invalidates the specified region of the control.
Area to invalidate.
Specifies if child controls should also be invalidated.
Creates and initializes a ToolTip object. InitialDelay will be 500 and
ReshowDelay will be set to 0 by default.
The initialized ToolTip object for this grid.
Occurs when mouse position leaves from the client area of the .
event data.
Raises the event.
A that contains the event data.
This virtual method is called from GetViewStyleInfo. It creates a temporary GridTableCellStyleInfo
object and raises the event to allow custom formatting of
a cell by changing its style object just before it is drawn.
The row index.
The column index.
The style object.
Queries cell information that includes custom formatting with respect to current view state.
Row index.
Column index.
For the QueryCellInfo to be called and not cache the styles.
The object that holds cell information.
Gets the background color of the grid.
Grid background color.
Marks the table dirty and forces reinitializing categories, counters, and summaries. The display is refreshed.
Invalidates the display area for the specified element.
Element to invalidate.
Returns the display area for the specified record. If it has nested tables only the bounding rectangle of the parent rows are returned and nested tables are excluded.
The grouping record
Specifies how to handle the the top-most row when
pixel scrolling is enabled and cells are only partially visible.
Rectangle.Empty if record is not visible; otherwise, the display area in client coordinates
Returns the display area for the specified element.
The element
Rectangle.Empty if element is not visible; otherwise, the display area in client coordinates
Returns the display area for the specified element.
The elements
Specifies how to handle the the top-most row when
pixel scrolling is enabled and cells are only partially visible.
Rectangle.Empty if element is not visible; otherwise, the display area in client coordinates
Determines if the specified element is visible and scrolled into view
The element.
True if it is visible.
Returns the display area for a given field and record.
The record or element
The field (FieldDescriptor.Name or ColumnDescriptor.MappingName)
Rectangle.Empty if field or record is not visible; otherwise, the display area in client coordinates
Paints the whole element or only one field of a record to a given Graphics context. If you
specify no field the whole rectangle is painted. If you specify a field name (see Fields collection
for names) then only the one column in the record is painted. Painting fields works for Records,
Summaries and GroupCaptions.
The element (or record) to be drawn.
A field name (matching FieldDescriptor.Name or GridColumnDescriptor.MappingName)
Paints the whole element or only one field of a record to a given Graphics context. If you
specify no field the whole rectangle is painted. If you specify a field name (see Fields collection
for names) then only the one column in the record is painted. Painting fields works for Records,
Summaries and GroupCaptions.
The graphics object.
The element (or record) to be drawn.
A field name (matching FieldDescriptor.Name or GridColumnDescriptor.MappingName)
Returns the cell coordinates for a given element and field in a record.
The element.
The name of the field.
Cell coordinates.
Returns the display area for a given column and record.
The record
The ColumnDescriptor
Rectangle.Empty if field or record is not visible; otherwise, the display area in client coordinates
Invalidates the display area for a given record and field.
The record
The field (FieldDescriptor.Name or ColumnDescriptor.MappingName)
Invalidates the display area for a given record and column.
The record
The ColumnDescriptor
Triggers after the record change reflected in binded source list.
Triggers when the record change reflected in binded source list.
Raises the event.
A that contains the event data.
Helper method returns relative column index for column
The GridTableDescriptor
The columnName
returns the column index
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Triggers when change occurs in sourcelist.
Triggers after the record value changed.
Used internally.
returns the table
Returns the default maximum size for the drop-down part of a StandardValuesCell.
returns the table size
Determines the nested display element that is shown at the specified point.
The point in client coordinates
The display element.
Returns the style information for the cell that is displayed under a mouse position in client coordinates. If cell belongs to a nested
table style information is returned for the cell inside the nested table. Good for hit-testing.
The mouse position in client coordinates.
The style element with identity information for the cell that is displayed at the specified coordinate.
This example dumps information about the cell below a mouse cursor while the user is hovering the mouse
over the grid.
private void TableControl_MouseMove(object sender, MouseEventArgs e)
{
Point ptClient = new Point(e.X, e.Y);
GridTableControl tableControl = this.groupingGrid1.TableControl;
GridTableCellStyleInfo style = tableControl.PointToTableCellStyle(ptClient);
Element displayElement = style.TableCellIdentity.DisplayElement;
string info = string.Empty;
if (style != null)
{
if (style.TableCellIdentity.Column != null)
info = style.TableCellIdentity.Column.Name;
else
info = style.TableCellIdentity.ToString();
}
Console.WriteLine("{0}: {1},{2},{3} ", ptClient, displayElement.ParentChildTable.CategoriesToString(), displayElement.GetType().Name, info);
}
Private Sub TableControl_MouseMove(sender As Object, e As MouseEventArgs)
Dim ptClient As New Point(e.X, e.Y)
Dim tableControl As GridTableControl = Me.groupingGrid1.TableControl
Dim style As GridTableCellStyleInfo = tableControl.PointToTableCellStyle(ptClient)
Dim displayElement As Element = style.TableCellIdentity.DisplayElement
Dim info As String = string.Empty
If Not (style Is Nothing) Then
If Not (style.TableCellIdentity.Column Is Nothing) Then
info = style.TableCellIdentity.Column.Name
Else
info = style.TableCellIdentity.ToString()
End If
End If
Console.WriteLine("{0}: {1},{2},{3} ", ptClient, displayElement.ParentChildTable.CategoriesToString(), displayElement.GetType().Name, info)
End Sub 'TableControl_MouseMove
Notifies the grid about the temporary state of the cell.
Row index.
Column index.
Cell style information.
Initialize the touch panning operation when touch on scrollable area. Otherwise do the normal mouse down operation.
The touch starting point
Return true when panning operation done
Initialize the touch move operation when touch on scrollable area. Otherwise do the normal mouse move operation.
The current touch position
True when do the swipe touch operation
Returns true when panning operation occurs
Initialize the touch panning operation when touch points is in scrollable area. Otherwise do the normal mouse up operation.
The touch end position
Return true when panning operation occurs
Raise the OnAutoScrollingChanging method.
A that contains the event data.
Draw dataBar for each valid cell.
The that contains event data.
The contains table descriptor properties.
Used to calculate the data bar length based on its cell value.
The that contains event arguments.
The used to apply rule collection and draw cells based on the expression.
The provide the properties of dataBar.
Returns the modified rectangle.
Calculates the dataBar length based on cellValue.
The rectangle which is used for drawing dataBar.
The client rectangle.
The ConditionalDatBarRule applied column
The which contains dataBar properties.
The current cellValue.
Holds the position of axis bar.
returns the calculated rectangle.
Draw the dataBar rectangle and border.
The modified dataBar rectangle
position of axisBar
The provide the properties of dataBar.
The contains event data.
The drawing cell value.
Draw the dataBar based on the calcualted dataBarRect.
Rectangle which contains the starting positiona and width.
That contains the dataBar rule properties and methods.
The BarstyleInfo object which contains the positive or negative bar properties.
Defines the brush used to draw the solid colors.
Defines the linear brush color and rectangle to fill linear style.
Returns true if fill style is gradient otherwise false.
calculates the axisBarPosition based on column min and max values.
The dataBar applying column.
The provide the properties of dataBar.
The drawing cell value.
position of axisBar
The modified dataBar rectangle
Calculates the minimum and maximum values of particular column.
The contains the dataBar properties.
The ConditionalFormatDescriptor
dataBar applying column.
Gets a value indicating whether to support YAmount or not.
Gets or sets the filtered column name.
Handles the multiple record selection behavior of the control.
Gets whether the method was called.
Used internally.
The model for this view.
The that this control is showing.
Gets whether the property has been assigned.
The that this control is showing.
Internal only.
Returns the that hosts this control.
Gets or sets the of the .
Internal only.
Returns a reference to the ToolTip object used for displaying
as ToolTips for cells.
Occurs when mouse has moved to a new cell and a ToolTip is initialized for that cell.
You have two options:
1) Set e.Style.CellTipText
- Or -
2) Initalize the ToolTip directly (see property) and then
set e.Cancel = True;
Gets or sets the multiplier for mouse wheel scrolling.
Gets or sets the multiplier for the mouse wheel scrolling.
Gets the value of the grouping grid UIA provider
Returns the pane information.
Occurs when the user hovers the mouse over a column header or clicks on it.
In your event handler, you can determine if the selected column can be dragged.
You can disallow dragging the column when
you assign False to .
Occurs when the user drags a column header over the GroupDropArea.
In your event handler, you can determine if the grid can be grouped by the selected column.
You can disallow grouping by the column when
you assign False to .
Occurs when the user hovers the mouse over a column header or clicks on it.
In your event handler you can determine if the selected column can be sorted.
You can disallow sorting by the column when
you assign False to .
Occurs when the user navigates though display elements with arrow keys.
In your event handler you can determine if the specified display element (e.g. a CaptionRow) can be stepped
on or if it should be skipped.
You can set AllowNavigateTo if you
want arrow keys to skip over specific display elements (e.g. skip caption rows).
Indicates if the grid control should handle tab keys to move between cells. Set this to False if focus
should move to the next control in the form instead.
Occurs for every DataBar cells before that grid draws the specified DataBar cell.
You can customize the databar cell minimum and maximum value using , and property.
You can avoid default drawing for the DataBar cells by using
Initializes the new instance of the class with its model and the parent control that it will be displayed in.
The table model.
The parent control.
The which hosts this control.
Overrides and manages the unwanted resources.
Overrides and triggered when the event is done.
The contains the event data.
Overrides and triggers when the current record context gets changed.
The Control.
The contains the event data.
Overrides and updates the control.
Determines a value indicating whether to process the system messages or not.
The message to be processed.
Overrides and draws the grid to the specified graphics canvas.
The instance of the class.
Specifies if the clipping region should be saved and restored after the grid is drawn.
Overrides and draws specified range of visible cells that need repainting when the grid engine wants to redraw a specific range of cells.
Top row index.
Left column index.
Bottom row index.
Right column index.
The instance of the class.
Clipping rectangle.
Gets the parent table control of the current object.
An instance of the class.
Overrides and process the scrolling of the specified cell into view.
Row index.
Column index.
Specifies if the top row index and left column index should be changed
without raising scroll events and without updating the screen (calling DoScroll).
The reason for scrolling the current cell into view (e.g. KeyPress, GridFocus etc.)
True if scrolling the grid was necessary; False if the range was already
in the visible area.
Overrides and triggered when the top row getting change.
The contains the event data.
Overrides and triggered when the left column getting change.
The contains the event data.
Triggered when the row height of the nested table gets changed.
The Control.
The contains the event data.
Gets the which is the parent cell of this nested table control.
Gets the current cell for this nested table.
Gets or sets a value indicating whether to hide the first row or not. Internal only.
Defines a class that draws with the and a .
Within the table, the will be set before the cell is drawn or accessed.
You can typically access cell models through the
property of the class. A nested table control cell model
is identified through its parent relations name with an "RT" prefix.
string cellType = "RT" + relatedTable.TableDescriptor.Name;
GridNestedTableControlCellModel cm = this.CellModels[cellType] as GridNestedTableControlCellModel;
Dim cellType As String = "RT" + relatedTable.TableDescriptor.Name
Dim cm As GridNestedTableControlCellModel = Me.CellModels(cellType)
Initializes a new instance of the class from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Initializes a new instance of the class.
Initializes a new instance of the class
and stores a reference to the and
this cell model belongs to.
The for this cell model.
The .
You can typically access cell models through the
property of the class. A nested table control cell model
is identified through its parent relations name with an "RT" prefix.
string cellType = "RT" + relatedTable.TableDescriptor.Name;
GridNestedTableControlCellModel cm = this.CellModels[cellType] as GridNestedTableControlCellModel;
Dim cellType As String = "RT" + relatedTable.TableDescriptor.Name
Dim cm As GridNestedTableControlCellModel = Me.CellModels(cellType)
Overrides and gets a string that represents the current object.
A string that represents the current object.
Overrides and creates a cell renderer for this cell model.
The grid control.
An instance of the class.
Overrides and manages the unwanted resources.
Triggered when the property values of the grid query cell model gets changed.
The Control.
The contains the event data.
Triggered when the table is being disposed.
The Control.
The contains the event data.
Gets the instance of the class.
Gets the instance of the class.
Gets or sets the filtered child table.
Gets the parent that owns this cell model.
Defines a class that creates a as a view for the
. The GridTableControl is drawn static
using the GridTableControl DrawGrid method. GridTableControl is being used in
a windowless mode. All mouse and keyboard interaction is forwarded from a
parent grid control to the nested table control. The table control has no
window handle.
You can typically access cell models through the
property of the class. A nested table control cell renderer
is identified through its parent relations name with an "RT" prefix.
string cellType = "RT" + relatedTable.TableDescriptor.Name;
GridNestedTableControlCellRenderer cm = this.CellRenderers[cellType] as GridNestedTableControlCellRenderer;
Dim cellType As String = "RT" + relatedTable.TableDescriptor.Name
Dim cm As GridNestedTableControlCellRenderer = Me.CellRenderers(cellType)
Initializes a new instance of the class for the given instance of the
and classes.
The instance of the class that displays this cell renderer.
The instance of the class that holds data for this cell renderer.
References to
and will be saved.
You can typically access cell models through the
property of the class. A nested table control cell renderer
is identified through its parent relations name with an "RT" prefix.
string cellType = "RT" + relatedTable.TableDescriptor.Name;
GridNestedTableControlCellRenderer cm = this.CellRenderers[cellType] as GridNestedTableControlCellRenderer;
Dim cellType As String = "RT" + relatedTable.TableDescriptor.Name
Dim cm As GridNestedTableControlCellRenderer = Me.CellRenderers(cellType)
Triggered hen the renderer window is scrolled.
The Control.
The contains the event data.
Returns a string holding the current object.
String representation of the current object.
Overrides and manages the unwanted resources.
Overrides and triggered to notify the changes from OnVScroll, OnHScroll before grid is scrolled.
The message to be notified.
Overrides and gets the nested current cell if this cell type hosts a GridControl by itself.
Current cell at the current instance specified.
Gets the currentcell from the child table. Internal only.
Current cell for the instance specified.
Lets you switch the context of the nested control. GridBounds, Table.FilteredChildTable etc.
will be adjusted.
The nested table that the nested control should operate on.
A GridSwitchNestedTableAndRestoreHelper. When you call Dispose on this member
the previous state will be restored.
To handle scrolling of nested table with frozen column without any painting issue.
Current Scroll Pixel Position
Determines a value indicating whether to deactivate current cell or not.
If true, deactivating is allowed; Otherwise False.
The current cell deactivate state.
Triggered when the control's end edit method is celled.
True, then the current cell should be synchronized; Otherwise False.
Overrides and initializes the grid.
The row index.
The column index.
Overrides and draws the grid.
The column index.
The row index.
The instance of the class.
The inner bounds of the cell without borders.
An instance of the that holds the values of style properties.
Overrides and determines a value indicating whether the parent grid gets deactivating or not.
True if renderer can be deactivated; False if deactivation should be aborted.
Overrides and triggered when the grid gets deactivated.
The row index.
The column index.
Overrides and determines a value indicating whether the parent grid gets activating or not.
The row index.
The column index.
True is cell can be activated; False otherwise.
Overrides and triggered when the parent grid gets activated.
Overrides and triggered when outlining the current cell.
The instance of the class.
The bounds of the cell.
Determines a value whether the grid is in scroll view or not when the current cell is navigating.
Defines the reason for scrolling current cell into view.
Returns False.
Determines a value whether the cell needs to be repainted or not when it becomes the current cell.
Returns False.
Overrides and triggered when the focus of the control gets changed.
This method is called to determine whether the cell renderer wants to receive mouse events
for the give cell at the given coordinates.
The row index.
The column index.
A with data about the mouse event.
The current controller requested to handle this mouse event.
Non-zero hit context value if you request to handle the mouse event; zero if you vote
not to handle the mouse event.
Overrides and triggered when the Mouse down event is done.
The contains the event data.
The column index.
The row index.
Triggered when the current cell is in navigation.
The Control.
The contains the event data.
Overrides and triggered when the mouse hover event is done.
The row index.
The column index.
The contains the event data.
Overrides and triggered when the mouse hover enter event is done.
The column index.
The row index.
Overrides and triggered when the mouse hover ends.
The row index.
The column index.
The contains the event data.
Overrides and triggered from the mouse down event is done.
The contains the event data.
The column index.
The row index.
Overrides and triggered when the mouse up event is done.
The row index.
The column index.
The contains the event data.
Overrides and triggered when the cancel mode method call is done.
The column index.
The row index.
Overrides and triggered to get the cursor for the current cell.
The row index.
The column index.
The to be displayed.
Overrides and determines a value indicating whether to process the key event args or not.
This is called from and allows your customized cell renderer
to process keyboard events before the gets the actual KeyDown or KeyUp event.
The with data of the keyboard event.
True if key was handled; False otherwise.
Gets the that draws the nested table.
Gets the parent that this cell renderer belongs to.
Gets the that this cell renderer belongs to.
Defines the class that provides the switching between the nested tables and disposes the un-used nested table. Internal only.
Initializes a new instance of the class. Internal only.
The nested table which is being switched.
The current instance of the class.
Disposes the unwanted resources. Internal only.
Initialize the drawing state of the nested table.
An instance of the class.
Initializes a new instance of the class.
Initializes anew instance of the class specified with the instance of the class.
An instance of the class.
Initializes a new instance of the class specified withe the
instance of class and the specific row index and column index.
An instance of the class.
The row index.
The column index.
Determines a value indicating whether to apply the state or not.
True, then the state can be applied; Otherwise False.
Determines a value indicating whether o apply the state with the specific value for restoring.
If True, then the restore; Otherwise False.
True, then the state is applied; Otherwise False.
Determines a value indicating whether to set the renderer bounds or not.
An instance of the class.
The bounds of the layout.
The row index.
True, then the renderer id =s applied; Otherwise False.
Performs the disposing of the grid table associated with the grid.
Gets or sets the instance of the class.
gets or sets the row index delta.
Gets or sets a value indicating whether the grid have bounded values or not.
Gets or sets the grid bounds of the control.
Gets or sets the instance of the class.
Gets or sets the instance of the class.
Gets or sets the instance of the class.
Gets or sets the row index.
Gets or sets the column index.
This MouseController handles mouse events for cell elements. In its HitTest method, the
cell renderer for the cell under the mouse cursor is determined and based on the cell renderer's
HitTest result, mouse events will be forwarded to that cell.
This mouse controller manages the calls to each Cell Renderer's OnHitTest, OnMouseDown, OnMouseHover,
OnMouseUp, OnMouseHoverEnter, OnMouseHoverLeave, and OnCancelMode methods. If a cell renderer's OnHitTest
method returns a non-zero value, the cell renderer will receive mouse events associated with that cell.
If a cell has cell button elements and the mouse is over a cell button element, the cell button element will
receive all mouse events associated with that cell button element.
If the user clicks on a cell button element, the cell button element will raise a Click event in its OnMouseUp
event handler.
This MouseController is not used by the GridControl by default. Instead all this functionality is provided by
. However, the grouping grid control uses this controller to forward
events to cell renderers.
This example shows some code samples from GroupDropAreaDragHeaderMouseController where the mouse events are forwarded to the GridTableClickCellsMouseController:
public class GroupDropAreaDragHeaderMouseController : GroupDragHeaderMouseControllerBase
{
public GroupDropAreaDragHeaderMouseController(GridGroupDropArea grid)
{
this.groupDropArea = grid;
isGroupAreaOrigin = true;
clickCellsController = new GridTableClickCellsMouseController(grid);
}
internal GridTableClickCellsMouseController clickCellsController;
int clickCellsControllerHitTest = 0;
public GridTableClickCellsMouseController ClickCellsController
{
get
{
return clickCellsController;
}
}
public void ResetClickCellsController()
{
if (this.entered)
clickCellsController.MouseHoverLeave(EventArgs.Empty);
else if (clickCellsControllerHitTest != 0)
clickCellsController.CancelMode();
entered = false;
clickCellsControllerHitTest = 0;
}
// unrelated code left out here ...
#region IMouseController implementation
public virtual string Name
{
get
{
return "DragGroupHeader";
}
}
public virtual Cursor Cursor
{
get
{
if (cursor != null)
return cursor;
return clickCellsController.Cursor;
}
}
bool entered = false;
public virtual void MouseHoverEnter()
{
if (clickCellsControllerHitTest != 0)
{
entered = true;
clickCellsController.MouseHoverEnter();
}
}
public virtual void MouseHover(MouseEventArgs e)
{
if (clickCellsControllerHitTest != 0)
clickCellsController.MouseHover(e);
}
public virtual void MouseHoverLeave(EventArgs e)
{
if (entered)
{
clickCellsController.MouseHoverLeave(e);
entered = false;
}
}
public virtual void MouseDown(MouseEventArgs e)
{
if (clickCellsControllerHitTest != 0)
clickCellsController.MouseDown(e);
}
public virtual void MouseMove(MouseEventArgs e)
{
if (clickCellsControllerHitTest != 0)
clickCellsController.MouseMove(e);
}
public virtual void MouseUp(MouseEventArgs e)
{
if (clickCellsControllerHitTest != 0)
clickCellsController.MouseUp(e);
}
public virtual void CancelMode()
{
if (clickCellsControllerHitTest != 0)
clickCellsController.CancelMode();
}
public virtual int HitTest(MouseEventArgs e, IMouseController controller)
{
clickCellsControllerHitTest = clickCellsController.HitTest(e, controller);
return clickCellsControllerHitTest;
}
#endregion
}
Initializes a new instance of the class.
The parent grid control.
Overrides and triggered when the mouse hover enter event is done.
Overrides and triggered when the mouse hover event is done.
A contains the event data.
Overrides and triggered when the moue hover leave event is done and when context changes (e.g. user pressed the mouse button).
An contain the event data.
Overrides and triggered when the mouse down event is done.
A contains the event data.
Overrides and triggered when the mouse move event is done.
A contains the event data.
Overrides and triggered when the mouse up event is done.
A contains the event data.
CancelMode is called for the active controller after a MouseDown message when the mouse operation is cancelled.
HitTest is called to determine whether your controller wants to handle the mouse events based current context.
A contains the event data.
A that has indicated to handle the mouse event.
A non-zero value if the button can and wants to handle the mouse event; 0 if the
mouse event is unrelated for this button.
Gets the name of the mouse controller.
Gets the cursor.
Defines a class that provides the hit test info regarding the Nested table of the grid.
Initializes a new instance of the class.
The parent grid.
The contains the event data.
An instance of the interface.
Represents a method that handles mouse events of a child of a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner contains the event data.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The contains the event data.
A that initiated the original event.
Gets the property values of class.
Represents a method that handles cancelable events of a child of a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead a programmer can subscribe to the TableControl* events raised by . Each of these
events has property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiated the original event.
The inner
that holds the event data of the underlying original event.
A that initiated the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles of a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiples child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead a programmer can subscribe to the TableControl events raised by . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles cancelable mouse events of a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the original event and the inner
that holds the event data of the underlying original event.
A can have one or multiple child table controls. Each of these controls raises various events.
The makes it easy for the programmer to subscribe to events raised by each of these child
table controls. The internally listens to these events and raises a new event
that wraps the inner arguments in an EventArgs class together with a reference to the original
that raised the event.
This removes the burden from the programmer to subscribe and unsubscribe to events of child table controls.
Instead, a programmer can subscribe to the TableControl events raised by the . Each of these
events has a property with reference to the and an
property that holds a reference to the original event arguments.
Initializes the event argument's object.
A that initiates the original event.
The inner
that holds the event data of the underlying original event.
A that initiates the original event.
The inner that holds the event data of the underlying original event.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Defines the reason why QueryAllowDragColumn event was raised (Show Red Indicator, MouseUp or HitTest).
HitTest is occurring
RedArrowIndicator is displayed
Represent the MouseUp
Remove GroupedColumn
Holds a reference to a that initiates the event and the column
that is affected.
Set to False if you do not want to allow the user
to drag the specified .
Initializes the event args.
Initializes the event args.
The table control.
Column Name.
The reason why this event is raised.
A contains the event data.
Initializes the event args.
Initializes the event args.
The table control.
Column Name.
The stackedheaderdescriptor.
The reason why this event is raised.
A contains the event data.
Initializes the event args.
The table control.
Column Name.
Name of the column to insert at. You can call TableDescriptor.Columns[InsertBeforeColumn] to get the GridColumnDescriptor.
Reason why this event was raised (Show Red Indicator, MouseUp, or HitTest).
Initializes the event args.
The table control.
Column Name.
StackedHeader Name.
Name of the column to insert at. You can call TableDescriptor.Columns[InsertBeforeColumn] to get the GridColumnDescriptor.
Reason why this event was raised (Show Red Indicator, MouseUp, or HitTest).
The table control.
The MouseEventArgs for HitTest. Will be null if is not HitTest.
Column Name. You can call TableDescriptor.Columns[Column] to get the GridColumnDescriptor.
Stacked Header Name.
Name of the column to insert at. You can call TableDescriptor.Columns[InsertBeforeColumn] to get the GridColumnDescriptor.
Reason why this event was raised (Show Red Indicator, MouseUp, or HitTest).
Set to False if you do not want to allow the user
to drag the specified .
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the event and the column
that is affected.
Set to False if you do not want to allow the user
to group by the specified .
Initializes the event args.
Initializes the event args.
The table control.
Column Name.
Initializes the event args.
The table control.
Column Name.
Name of the column to insert at. You can call TableDescriptor.Columns[InsertBeforeColumn] to get the GridColumnDescriptor.
Reason why this event was raised (Show Red Indicator, MouseUp, or HitTest).
Set to False if you do not want to allow the user
to group by the specified .
The table control.
Column Name. You can call TableDescriptor.Columns[Column] to get the GridColumnDescriptor.
Name of the column to insert at. You can call TableDescriptor.Columns[InsertBeforeColumn] to get the GridColumnDescriptor.
Reason why this event was raised (Show Red Indicator, MouseUp, or HitTest).
Set to False if you do not want to allow the user
to group by the specified .
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Holds a reference to a that initiates the event and the column
that is affected.
Set to False if you do not want to allow the user
to by clicking on the specified .
Initializes the event args.
The table control.
Column Descriptor.
A .
The table control.
Column Descriptor.
Set to False if you do not want to allow the user
to sort by clicking on the specified .
Gets the underlying that triggered the QueryAllowSortColumn event. You can
check the CellClickEventArgs to find out which mouse button was clicked or the exact position of the mouse pointer.
Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
Represents a method that handles events with that are raised by a child in a .
The source of the event.
Contains the event data.
Provides event data for the QueryAllowArrowKeyNavigateTo event. You can set AllowNavigateTo if you
want arrow keys to skip over specific display elements (e.g. skip caption rows).
Constructor for GridQueryAllowArrowKeyNavigateToEventArgs
The table control
The display element (RecordRow or CaptionRow)
Set to False if you
want arrow keys to skip over specific display elements (e.g. skip caption rows).
The table control.
The display element (RecordRow or CaptionRow)
Set to False if you
want arrow keys to skip over specific display elements (e.g. skip caption rows)..
Represents a method that handles events with that are raised by a child in a .
The source of the event
A contains the event data.
Provides data about the cancelable event.
is a custom event argument class used by the
event to allow custom drawing of
a DataBar cell. Set the Cancel property true if you have drawn the cell contents and
do not want the grid to proceed with default drawing of the cell.
Initializes a new instance of the class.
A style for the DataBar cell.
Cell bounds of the DataBar cell.
A for the DataBar cell
Gets the conditional format rule for DataBar cell.
Gets the databar cell styles.
Gets or Sets the cellbounds of the databar cell.
Gets or Sets whether determine that event has handled or not.
Gets the Graphics context.
Defines the constants that can be specified for the appearance of selected cells in the grid.
Do not change appearance of selected cells. You can manually color cells by
handling TableControlPrepareViewStyleInfo or TableControlCellDrawn events.
TableControlPrepareViewStyleInfo lets you change the backcolor of cell.
TableControlCellDrawn lets you draw over an already painted cell, e.g. invert or alpha-blend.
Set BackColor and TextColor in PrepareViewStyleInfo.
Draw alpha-blend color over selected row.
Invert cells in selected rows.
Defines the constants that can be specified for the behavior and appearance of the current cell when ListBoxSelectionMode was set.
When a current cell is in current row, draw it with same color as used for highlighting the whole record.
Don't select a current cell in current row.
When a current cell is in current row, draw it with original cell background color.
For SelectionMode.MultiExtended only: move current cell when user extends selection with mouse.
Implements the cell selection behavior of a grid control.
Initializes a new instance of the class with the specified grid table control.
The grid table control.
Determines whether the selected records are changing or not.
Returns True.
Triggered when the selected records gets changed.
Changes the selection of the record with the specified cell range to the row index.
The new range to be selected.
The row index of the range.
Changes the selection of the records in the grid.
The range which is already selected.
The range which is to be selected.
Clears the selected records. Internal only.
Determines a value that indicates whether to begin to select cells or not.
The row index.
The column index.
The key value of the specified cell.
Determines a value that indicates whether to select the cells or not.
The row index.
The column index.
If True the selection gets done; Otherwise False and selection will not occur.
Ends the selection of cells being selected.
Gets the record from the specified column in the table.
An grid engine associated with the control.
The row index.
The column index.
An instance of the that the record belongs to.
The record specified in the engine.
The column name of the specified cell.
Process the mouse down event. Internal only.
The contains the event data.
Process the mouse move event. Internal only.
The contains the event data.
Process the mouse up event. Internal only.
The contains the event data.
Process the cancel mode. Internal only.
The contains the event data.
Determines a value that indicates whether the buttons are mouse buttons or not.
The contains the event data.
If True it is mouse button; Otherwise False.
Determines a value indicating whether to allow arrow key navigate to element or not.
The element to be navigated.
If True navigation is done; Otherwise False.
Process the navigation of current cell with respect to the direction specified. Internal only.
The contains the event data.
Draws the selected record. Internal only.
The contains the event data.
The table control associated with the record.
Sets the custom formating of the selected records in the table. Internal only.
The table control associated with the record.
The contains the event data.
Processes the selected records when selection is changing. Internal only.
The contains the event data.
Initiates the selection.
Synchronizes the grid with active range of selection.
Processes the selected records when selection gets changed. Internal only.
The contains the event data.
Gets the values indicating whether the multi-extended should move to current cell or not.
Represents a grid model that displays rows with of a and
allows grouping, filtering, editing, deleting, and adding of records.
Overrides and returns the string format of the current object.
The string representation of the current object.
Creates an instance of the class.
A new instance of the class.
Initializes a new instance of the class.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and performs the cut-paste functions.
Gets the display element at the specified row index.
Use Table.DisplayElements[rowIndex]
The row index.
The element at the specified row index.
Gets the index of the display element.
Use Table.DisplayElements.IndexOf
The element to be identified.
If found, index of the given element; Otherwise -1.
Gets the display element counts.
Use Table.DisplayElements.Count
Number of display elements.
Overrides and manages the unwanted resources.
If True the object is being disposing. Otherwise False.
Gets the number of indent columns.
If records don't have nested tables, the method returns GroupedColumns.Count+1; otherwise GroupedColumns.Count+2.
Converts the given column index to a zero-based number adjusted for column headers collection.
The column index.
The field index of the specified column.
Gets the displayed at the specified row and column index if it is a header cell.
Gets the displayed at the specified row and column index if it is a header cell.
The row index.
The column index.
The displayed at the specified cell if it is a header cell; NULL otherwise.
Gets the displayed at the specified column index in the top-most row.
The column index.
The displayed at the specified column if it is a header cell; NULL otherwise.
Gets the displayed at the specified cell if it is a header cell.
The current cell identified from the row and column index.
The displayed at the specified cell if it is a header cell; NULL otherwise.
Gets the displayed at the specified row and column index if it is a header cell.
The current cell identified from the row and column index.
The displayed at the specified cell if it is a header cell; NULL otherwise.
Gets the displayed at the specified cell if it is a header or record field cell.
Gets the displayed at the specified cell if it is a header or record field cell.
The row and column index.
The displayed at the specified cell if it is a header or record field cell; NULL otherwise.
Gets the displayed at the specified cell if it is a header or record field cell.
The row index.
The column index.
The displayed at the specified cell if it is a header or record field cell; NULL otherwise.
Converts a zero-based number to a column index in a grid adjusted for column headers (adding ).
A zero-based field number.
The column index in the grid.
Converts the specified string value of the column to a zero-based index for a column. The resulting
number can be used as an index to look up a in the
collection.
The name of the column to be matched.
A zero-based field number in the collection; -1 if not found.
Overrides and gets the column index for a column that matches a given name.
The name of the field to be matched.
The column index in the grid; -1 if not found.
This function only searches the columns in the root level. If you have several relations
displayed in the grid, the nested relations will not be searched by this function.
Gets the column index where the caption bar of a group should be drawn with the specified element.
The element.
If the element is not a CaptionRow, one is returned; otherwise the column index
where the caption bar should be drawn.
Gets the row index for a row that matches a given name.
The name of the row to be matched.
The row index in the grid; -1 if not found.
Raises the event.
The that contains the event data.
Raises the event.
The that contains the event data.
Replaces the with raising or events.
A new instance of the class.
Wires the table.
Unwires the table.
Triggered when the table gets disposed.
Determines if changes were made to the collection
or other changes affecting the widths of columns and if necessary, calculates the maximum
column width for each column.
Determines if changes were made to the collection
or other changes affecting the widths of columns and if necessary, calculates the maximum
column width for each column.
True if column widths were recalculated; False if cache is still good.
Determines if changes were made to the collection
or other changes affecting the widths of columns and if necessary, calculates the maximum
column width for each column.
If true forces recalculation of column widths.
True if column widths were recalculated; False if cache is still good.
Determines a value indicating whether the current object contains the FilterCellModel or not.
True if the current object has FilterCellModel; Otherwise False.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Wires the nested table.
An instance of the class.
Invalidates the current record.
Determines a value indicating whether the top most record is AddNewRecord or not.
The element to be checked.
True if the element is an AddNewRecord; Otherwise False.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
A that contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the SaveHideRow event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Gets the instance of the that spans the cells where a row header for the specified element should be displayed. Can
span multiple rows if a table has multiple rows per record.
The display element.
The cell range.
Overrides and raises the event.
The contains the vent data.
Gets the instance of the that spans the cells where a column should be displayed for a specific record. Can
span multiple rows if a table has multiple rows per record or multiple grid columns.
The Record.
The name of the field descriptor (which is GridColumnDescriptor.MappingName).
The cell range.
Gets the instance of the that spans the cells where a column should be displayed for a specific record. Can
span multiple rows if a table has multiple rows per record or multiple grid columns.
The Record.
The field descriptor.
The cell range.
Registers the nested table cell models.
Removes the nested table cell models.
The relation of the nested table to the parent table.
Register the nested table cell model.
The instance of the that are in relation with the parent table.
The cell model of the registered nested table.
Overrides and gets the datasource of the specified style.
An instance of the class that holds the values of style properties.
The Datasource.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and raises the event.
The contains the event data.
Overrides and gets the GridBorder object based on TableOptions.GridLineBorder. If its style is set to
GridBorderStyle.Standard the default properties Options.DefaultGridBorderStyle
and Properties.GridLineColor will be used.
The Grid line border.
Overrides and gets the GridBorder object based on TableOptions.GridLineBorder. If its style is set to
GridBorderStyle.Standard the default properties Options.DefaultGridBorderStyle
and Properties.FixedLineColor will be used.
Fixed line border.
Raises the event.
An that contains the event data.
Triggered when the event is done.
The contains the event data
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the is done.
The contains the event data.
Triggered the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the is done.
The is done.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Raises the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The event is done.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Raises the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Raises the event is done.
A contains the event data.
Triggered when the event is done.
The event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Triggered when the event is done.
The contains the event data.
Gets or sets a value indicating whether to increase the size of column width for filter icon or not.
This property increases the column width by 15 when it is true.
Gets or sets the value of the current cell information.
Gets the selected ranges in the grid.
Used internally.
Gets or sets a value indicating whether to enable HierarchicalGroupDropArea or not.
Gets or sets the values of of a cell.
Gets or sets the for the filtered child table.
with this model.
Gets the value of the instance of the that holds information of the control.
Gets the value of the instance of to the control.
Gets or sets the enum value of .
Gets a value indicating whether the current object contains a or not.
Gets or sets a value indicating whether the property is set or not.
Gets a value indicating whether the event is triggered or not.
Gets or sets a value indicating whether to enable or disable the Legacy styles.
Gets or sets the value of with display elements to be displayed in the grid.
Occurs after the is replaced.
Occurs before the is being replaced.
Occurs when an unknown exception has been cached while modifying underlying data in the datasource.
If necessary, you can re-throw the exception in your event handler.
Occurs before a group is collapsed.
Occurs before a group is collapsed.
Occurs before a group is expanded.
Occurs after a group was expanded.
Occurs before a record with nested tables is collapsed.
Occurs after a record with nested tables is collapsed.
Occurs before a record with nested tables is expanded.
Occurs after a record with nested tables is expanded.
Occurs before a record is deleted.
This event is raised only when the or triggers the deletion. If
the underlying source list deletes the record, a event is raised instead.
Occurs after a record is deleted.
This event is raised only when the or triggers the deletion. If
the underlying source list deletes the record, a event is raised instead.
Occurs before and after the status of the current record is changed. Check the
of the to get information which current record state was changed.
Occurs when the method of the is called.
The GridGroupingControl listens to this events and resets any "Current Cell" state when this
event is raised.
Occurs when a summary has been marked dirty.
The GridGroupingControl listens to this event and will force a repaint of the specified summary if it is visible
when this event was raised.
Occurs before the processes the event
of an attached source list. More detailed events will be
raised after this event.
The reason for firing this event is to give a programmer the chance to react to an
event before the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged
event.
Occurs after the processes the event
of an attached source list.
The reason for firing this event is to give a programmer the chance to react to an
event right after the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged
event.
Occurs when a record in the underlying datasource is added, removed, or changed and after
the is updated with that change.
Occurs when a record in the underlying data source is added, removed, or changed and before
the is updated with that change.
Occurs when a new group is added to a categorized table after a record is changed. The event does not
occur during categorization of the table. See the elements to when categorization
finished.
Occurs when a group was removed from a categorized table after a record was changed. The event does not
occur during categorization of the table. See the elements to when categorization
finished.
Occurs before the records for a group are sorted.
The engine has built-in optimization for sorting columns that allows it to perform the sorting
on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and
you change the sort order of the cities. It is not necessary to sort the whole table. Instead,
the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and
SortedItemsInGroup events are fired in such cases when a specific group was sorted on demand.
If the whole table was set dirty (see ), then the whole table
is simply recategorized. In that case, only a CategorizedElements event is raised but no
SortingItemsInGroup event.
Occurs after the records for a group were sorted.
The engine has built-in optimization for sorting columns that allows it to perform the sorting
on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and
you change the sort order of the cities. It is not necessary to sort the whole table. Instead,
the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and
SortedItemsInGroup events are fired in such cases when a specific group was sorted on demand.
If the whole table was set dirty (see ), then the whole table
is simply recategorized. In that case, only a CategorizedElements event is raised but no
SortingItemsInGroup event.
Occurs when the of a is called
and before all counters are marked dirty.
Occurs when the of a is called
and before all summaries in that table are marked dirty.
Occurs before records are categorized after a table is marked dirty ().
When is set True, e.g. because schema information for a table is changed
or because the grouped columns are changed, the table will categorize records on demand the first time
information about a record is accessed. At that time, the of the will start
categorization.
Occurs after records were categorized after a table is marked dirty ().
When is set True, e.g. because schema information for a table was changed
or because the grouped columns were changed, the table will categorize records on demand the first time
information about a record is accessed. At that time, the of the
will start
categorization.
Occurs after the data source was replaced.
Occurs when a RecordFieldCell cell's value is changed and before Record.SetValue is called.
Occurs when a RecordFieldCell cell's value is changed and after Record.SetValue returned.
When number of visible elements were changed.
When number of visible elements were changed.
Occurs before the collection is modified.
Occurs after the collection was modified.
Gets or sets a object that handles events raised by the object.
Implements a class that provides support for VolatileData of GridTableModel.
Initializes a new instance of the class.
An instance of the class.
Not implemented.
Not implemented.
Not implemented.
Not implemented.
Gets the cell model of the specified cell.
The cell model of the specified cell.
The CellModel.
Get the BaseStyles of the current object.
An instance of the class that holds the values of style properties.
The row index.
The column index.
Gets or sets the column count of the grid.
Gets or sets the row count of the grid.
Gets a value indicating whether the table has specified row count or not.
Gets a value indicating whether the table has specified column count or not.
Gets or sets the value of the StyleInfo of the current cell.
The row index.
The column index.
The style values of the specified current cell.
Gets the value of the BaseStyleMap.
Implements the cell selection behavior of a grid control.
Initializes a new instance of the class with the specified instance of the class.
An instance of the class.
Overrides and HitTest is called to determine whether your controller wants to handle the mouse events based current context. Used internally.
The contains the event data.
An instance of the interface for mouse controllers to be used with MouseControllerDispatcher.
returns HitTest value
Overrides and determines whether the current grid cell can move externally or not.
The direction to be moved.
If True the selection is extended. Otherwise False.
The no. of cells to be moved.
Overrides and process the method.
The row index of the current cell.
The column index of the current cell.
The enum value for specifying the setting the current cell.
Implements the UI Provider for the grouping grid.
Initializes a new instance of class with the specified instance of the class.
An instance of the class.
Gets the element provider form the point specified.
The X-axis point.
The Y-axis point.
The element provider.
Gets the raw element provider focus.
Gets the embedded fragment roots.
Return Null.
Gets the current element's runtime id.
The id of the current element.
Navigates the raw element in the specified direction.
Navigating direction.
Raw element provider fragment.
Sets the focus.
Gets the pattern provider of the specified pattern id.
The id of the current pattern.
The values of the specified pattern.
Gets the UI property provider of the specified id.
The element id.
Returns Null.
Gets the values of the property specified.
The id of the property.
The property values of the specified id.
Not implemented.
Return Null.
Not implemented.
horizontal amount
vertical amount
Not implemented.
Gets the bound rectangle of the element.
Gets the raw element provider fragment root.
Gets the value of the UI host element provider.
Gets the provider options.
Gets a value indicting whether the select can multiple or not.
Gets a value indicating whether the selection is required or not.
Not implemented.
Not implemented.
Not implemented.
Not implemented.
Not implemented.
Not implemented.
Implements the methods and properties to support UI Automation for GridGroupingControl.
Initializes a new instances of the class with the specified instance of the and class.
An instance of the class.
An instance of the class.
Gets the embedded fragment
Returns Null.
Gets the current element's runtime id.
The id of the current object.
To switch the child table based on the record.
Returns switched child table control.
To add the newly created tablecontrol collections to dispose the tablecontrol after that completing the playback.
Navigates the current element with the specified direction.
The direction to be navigated.
The id of the current element.
To get the parent table control for the child table
GroupingGridCellProvider for the cell
Get the parent table control using child record.
A Record to get the parent TableControl.
Parent record row index.
Returns the parent TableControl.
Not implemented.
Gets the pattern provider of the specified pattern id.
The id of the current pattern.
The values of the specified pattern.
Gets the property value.
The id of the property.
The values of the specified property.
Sets the value to the formatted text.
The value to be set.
Not implemented
Not Implemented
Not Implemented
Gets the bounding rectangle of the element.
Gets the value of the Fragment roots.
Gets the value of the UI host element provider.
Get the value of the UI automation provider options.
Gets a value indicating whether the current object is read-only or not.
Gets the value of the formatted text.
Gets a value indicating whether the current object is selected or not.
Gets the value of the selection container.
To maintain nested table and parent record of nested table.
Initializes a new instances of the MainTable
Gets or sets the NestedTable
Get or sets the parent record of the child table
The engine lets you set the main data source for the whole engine. The TableDescriptor will
pick up the ItemProperties (schema information) from the data source and
the table will be initialized at run-time with records from the list.
TableDescriptor is browsable. You can modify its collections and properties in the
designer.
By default, TableDescriptor is auto populated. If you do not modify its settings and
later change the data source, it will be automatically reinitialized. If you have
made modifications to TableDescriptor and change the SourceList, the modifications
will be kept. To discard modifications of a TableDescriptor, you need to explicitly
call ResetTableDescriptor.
The table is dependent on information provided by the TableDescriptor and the records from
SourceList. It is created on the fly and can not be designed with the designer.
The GridEngineBase class adds design-time support for the engine class. It can be dropped as a component
into the component tray of the designer. It can be initialized with a BindingContext so that the
CurrencyManager can be kept in sync. You can specify a data source using the DataSource and DataMember
properties through the designer.
The engine base class has no dependencies on System.Design and System.Windows.Forms. Only GridEngineBase adds these
dependencies.
Initializes a new instance of the class.
Initializes this object and copies properties from another object.
An instance of the class.
Triggered when the event is done.
An contains the event data.
Triggered when the event is done.
An contains the event data.
Triggered when the event is done.
An contains the event data.
This virtual method is called when there has previously been no datasource specified and
a call occurs. Override this method to allow retrieving the
source list on demand.
The source list for this engine.
Sets the CurrencyManager.
Value of CurrencyManager.
if is set to False.
Gets the parent currency manager for the related currency manager.
Used internally.
An instance of the class.
The parent CurrencyManager of the current object.
Gets the parent currency manager for the related currency manager.
Used internally.
An instance of the class.
The parent CurrencyManager of the current object.
Wires the currency manager..
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Unwires the currency manager.
Determines if the source list should be reinitialized the next time is called.
True if the source list should be reinitialized the next time is called; False if not.
Overrides and raises the event is done.
An contains the event data.
Determines a value indicating whether the value of property was modified or not.
True if it was modified; Otherwise False.
Resets the value of property to its default value.
Determines a value indicating whether the value of property was modified or not.
True if it was modified; Otherwise False.
Overrides and reset the Engine.
Resets the value of property to its default value.
Checks Valid DataSource.
Value contains DataSource.
ifis not valid.
Gets the String.
Contains String Value.
ifnot nullReturns the String.
Sets the and properties at run-time.
The data source, typed as .
The string that specifies the table to bind to within the object returned by the property.
Returns an object that represents a service provided by the Component or by its Container.
A service provided by the Component.
An Object that represents a service provided by the Component.
This value is a NULL reference (Nothing in Visual Basic) if the Component does not provide
the specified service.
Overrides and manages the unwanted resources.
Gets or sets a value indicating whether list should be attached to
or not.
Default value is True.
Gets a value indicating whether SetCurrencyManager() method was called or returned.
Gets a value indicating whether OnBindingContextChanged() method was called or returned.
Gets a value indicating whether OnDataSourceChanged() method was called or returned.
Gets a value that True when OnDataMemberChanged() method was called and False after OnDataMemberChanged returned.
Gets a value that True when SetDataBinding() method was called and False after SetDataBinding returned.
Occurs when the property is changed.
Occurs when the property is changed.
Occurs when the property is changed.
Gets or sets the BindingContext for the grouping grid.
The BindingContext object of a Control is used to return a single BindingManagerBase object for all
data-bound controls contained by the Control. The BindingManagerBase object keeps all controls that
are bound to the same data source synchronized. For example, setting the Position property of the
BindingManagerBase specifies the item in the underlying list that all data-bound controls point to.
For more information about creating a new BindingContext and assigning it to the BindingContext property,
see the BindingContext.
Gets the CurrencyManager for the assigned DataSource and DataMember.
Gets or sets a value indicating whether the engine is allowed to resolve a BindingSource created by Whidbey design-time to the DataSet it wraps. Only when the engine is allowed to resolve the
BindingSource it will be able to properly detected nested relation and foreign-key relations that
were setup in the DataSet.
Gets or sets a value indicating whether the engine should reset the TableDescriptor and Relations when you set the Engine.DataSource = null.
Gets or sets a value indicating whether the engine should reset the TableDescriptor, Relations
and clear out the SourceListSet when you set the Engine.DataSource = null.
Gets or sets a value indicating whether the engine should immediately reset the SourceListSet and SourceList when you change the Engine.DataSource or not.
Gets or sets a value indicating whether the engine should immediately reset the SourceListSet and SourceList when you change the Engine.DataSource or not.
Gets or sets a value indicating whether the optimized grouping performance is needed for IList data source or not.
When this property is set to true, the method OptimizeIListGroupingPeformance need to be invoked explicitly
to provide support for real-time updates in grid.
Gets or sets the data source that the control is displaying data for.
Gets or sets the specific list in a for which the control displays the data.
Gets or sets the ISite of the Component.
The ISite associated with the Component, if any.
This value is a null reference (Nothing in Visual Basic) if the Component is
not encapsulated in an IContainer, the Component does not have an ISite associated with it,
or the Component is removed from its IContainer.
Gets a value indicating whether the Component is currently in design mode or not.
Gets the IContainer that contains the Component.
The IContainer that contains the Component, if any.
This value is a NULL reference (Nothing in Visual Basic) if the Component is not encapsulated in an IContainer.
Implements the class that manages all the records from the underlying source list. The source list can be any IList collection.
If it implements IBindingList the GridTable will listen to the ListChangedEvent and update its internal
data whenever changes are made to the source list.
See the class for a more detailed overview about this class.
GridTableBase add support for the Windows Forms CurrencyManager. It detects when the
CurrencyManager.Position is changed.
GridTableBase also makes the IBindingList.ListChanged event
thread-safe. When rows are added on a different thread, the event is marshaled onto the current
UI thread before it is processed.
Initializes a new instance of the class with the specified instances of the and classes that belongs to a parent table.
The table descriptor with schema information about the table.
The parent table of this table; NULL if this table is not a child table of a relation.
Overrides and manages the resources.
Triggered when the event is done.
An contains the event data.
Gets the CurrencyManager for the assigned SourceList.
Currency manager.
Resets the CurrencyManager to NULL and unwires any events.
Triggered when the event is done.
An contains the event data.
Wires the Currency manager.
Unwire the currency manager.
Determines if the current thread is the same UI thread as the parent control or if
the current method call should be marshaled.
A control that can be used to marshal the current method by calling its Invoke method.
A GridEngine overrides this method and returns a reference to the GridGroupingControl since all
events need to be marshaled to the same thread that the GridGroupingControl is running on.
Overrides and raises the event is done.
The Control.
An contains the event data.
Raises the event.
The Control.
An that contains the event data.
Overrides and raises the event.
A contains the event data.
Triggered when the event is done.
The Control.
The contains the event data
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Overrides and triggered when the event is done.
An contains the event data.
Overrides and raises when the event is done.
An contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Gets or sets the BindingContext for the grouping grid.
The BindingContext object of a Control is used to return a single BindingManagerBase object for all
data-bound controls contained by the Control. The BindingManagerBase object keeps all controls that
are bound to the same data source synchronized. For example, setting the Position property of the
BindingManagerBase specifies the item in the underlying list that all data-bound controls point to.
For more information about creating a new BindingContext and assigning it to the BindingContext property,
see the BindingContext.
Occurs when the gets changed.
Show the Custom Collection Editor dialog.
Gets the editor style used by the System.Drawing.Design.UITypeEditor.EditValue(System.IServiceProvider,System.Object) method.
The TypeDescriptor context.
Returns the UITypeEditorModel
Edits the specified object's value using the editor style indicated by the System.Drawing.Design.UITypeEditor.GetEditStyle() method.
An System.ComponentModel.ITypeDescriptorContext that can be used to gain
additional context information.
An System.IServiceProvider that this editor can use to obtain services.
The object to edit.
The new value of the object. If the value of the object has not changed,
this should return the same object it was passed.
Raised when collection changed.
Object
Changed value
Collection changed event
delegate for collection changed event
A collection which hold the conditionalDataBarRule objects.
Returns a string that represents the current object.
A string that represents the current object.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Initializes a new empty collection.
Initialize new instance for class.
The
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Copies the all value from dataBar.
The that contains property.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
checks the equal value in location.
The that contains property.
Returns true if equal else false.
Determines if the element belongs to this collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds a filter descriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Raises the event.
A that contains the event data.
Raise ItemChanging event.
The that contains property.
The that contains event data.
Raises the event.
A that contains the event data.
Raise the property item changed event.
The that contains property.
The that contains event data.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Determines if the element belongs to this collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Adds a filter descriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Occurs when a property is changed.
Occurs before a property is changed.
Gets / sets whether the collection is manipulated inside a collection editor.
The version number of this collection. The version is increased each time the
collection or an element within the collection was modified.
Gets or sets the element at the zero-based index.
Returns False.
Returns False since this collection has no fixed size.
Returns False.
Gets the number of elements contained in the collection.
Enumerator class for elements of a .
Initializes the enumerator and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Base class used to create IconSets, DataSets, color scaling.
Initialize the new instance for class.
Initialize the new instance for class .
The contains descriptor properties and methods.
Dispose the conditionalFormatRuleBase object and properties.
Provides the collection name.
Returns the string collection name.
Creates a copy of this object.
A copy of this object.
Copy the all property values from one method to another.
set the conditional format rule collection to the parent.
A collection contains objects.
Returns a string that represents the current object.
String representation of the object.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Initializes a new empty collection.
Initialize new instance class.
The array of ConditionalFormatRuleBase objects.
Initialize new instance class.
The contains the tabledescriperties.
Initialize new instance class.
The contains properties and methods.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Copies the to another same collection.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Determines if the element with the specified name belongs to this collection.
The name of the element to locate in the collection.
True if item is found in the collection; otherwise, False.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds a filter descriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the specified descriptor element with the specified name from the collection.
The name of the element to remove from the collection.If no element with that name is found
in the collection, the method will do nothing.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Raises the event.
A that contains the event data.
Raised when property item changing.
The contains rule base properties and methods.
That contains event data.
Raised when property item changed.
The contains rule base properties and methods.
That contains event data.
Raises the event.
A that contains the event data.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from ArrayList. The array must have zero-based indexing.
The zero-based index in array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Returns a collection of attributes for the specified component and a Boolean indicating that a custom type descriptor has been created.
Returns the attributeCollecion.
Returns the name of the class for the specified component using a custom type descriptor.
Returns the string .
Returns the name of the specified component using a custom type descriptor.
Returns the string componet name
Returns a type converter for the type of the specified component with a custom type descriptor.
A System.ComponentModel.TypeConverter for the specified component.
Returns the default event for a component with a custom type descriptor.
An System.ComponentModel.EventDescriptor with the default event, or null if there are no events.
Returns the default property for the specified component with a custom type descriptor.
A System.ComponentModel.PropertyDescriptor with the default property, or null if there are no properties.
Returns an editor with the specified base type and with a custom type descriptor for the specified component.
A System.Type that represents the base type of the editor you want to find.
An instance of the editor that can be cast to the specified editor type,or null if no editor of the requested type can be found.
Returns the collection of events for a specified component using a specified array of attributes as a filter and using a custom type descriptor.
An array of type System.Attribute to use as a filter.
An System.ComponentModel.EventDescriptorCollection with the events that match the specified attributes for this component.
Returns the collection of events for a specified component with a custom type descriptor.
An System.ComponentModel.EventDescriptorCollection with the events for this component.
Returns the properties for this instance of a component using the attribute array as a filter.
An array of type System.Attribute that is used as a filter.
A System.ComponentModel.PropertyDescriptorCollection that represents the filtered properties for this component instance.
Returns the properties for this instance of a component.
A System.ComponentModel.PropertyDescriptorCollection that represents the filtered properties for this component instance.
Returns an object that contains the property described by the specified property descriptor.
A System.ComponentModel.PropertyDescriptor that represents the property whose owner is to be found.
An System.Object that represents the owner of the specified property.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Gets / sets whether the collection is manipulated inside a collection editor.
The version number of this collection. The version is increased each time the
collection or an element within the collection was modified.
Gets or sets the element at the zero-based index.
Returns False.
Returns False since this collection has no fixed size.
Returns False.
Gets the number of elements contained in the collection.
Gets
Used for Rule base collection enumeration.
Initializes a new instance of the class with
the specified rule.
The rule to be specified.
Initializes a new instance of the class with
the specified rule collection.
The rule collection.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Converts the RuleBase class properties to the descriptor base converter.
Initialize the new instance for class.
Determines whether the current object can be converted to the specified type.
Format context.
The type you want to convert the object to.
True if this conversion is allowed.
Converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Type to convert to.
Converted object.
Converts the DataBarRule class properties to descriptor base converter.
Initialize the new instance for
Determines whether the current object can be converted to the specified type.
Format context.
The type you want to convert the object to.
True if this conversion is allowed.
Converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Type to convert to.
Converted object.
Implements data bar cell based the provided properties and conditions.
Initialize the new instance for class.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Initialize the negativeBar default values.
Initialize the negativeBar default values.
Creates a copy of this object.
A copy of this object.
Copies all the property values.
The dataBar rule.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Assign current ConditionalFormatDataBarRuleCollection collection as parentCollection.
Occurs when a property is changed.
Occurs before a property is changed.
Get or set the Name for rule.
Axis position inside the cell to change the bars of negative and positive values.
Get or set the axis bar color.
Gets or sets the Data bar drawing direction.
Hold negative cell values settings.
Holds positive cell values settings.
Used to determine whether need to calculate Min Max values.
Gets or sets the data bar drawing column name.
Gets or set the minimum value.
Gets or sets the maximum value.
Used to fill negative bar color as same like positive bar color.
Enumerator having axis bar position options.
displays at varies positions based on the negative values.
shows same direction as the positive direction.
provide enumeration to choose data bar rule fill style.
Fill rectangle with gradient brush.
Fill rectangle with solid brush.
Used to provide support custom color option.
Initialize the new instance for class.
Copies all the property values.
The dataBar style.
To notify the property changes of ConditionalDataBarRule.
Creates a new object that is a copy of the current instance.
Returns the new barStyleInfo object.
Gets or sets the fill style is gradient or solid.
Gets or Sets the border color for dataBar rule.
Gets or sets the CustomLinearGradiant color.
Gets or sets the CustomLinearGradiant color.
Gets or sets the name for barstyle info object.
/// Gets or sets the SolidBrushcolor.
Represents a collection of columns with mapping information to columns of the underlying datasource.
An instance of this collection is returned by the property
of a .
When called the ShouldPopulate property will be set true temporarily until
the next EnsureInitialized call and then be reset again to optimize subsequent lookups.
The Engine calls this method when schema changes occurred (PropertyChanged was raised).
A Read-only and empty collection.
Set the Table descriptor.
Contains Value of TableDescriptor.
Overrides and gets the string representation of the current object.
A string that represents the current object.
Ensure type correctness when a new element is added to the collection.
The newly added object.
ifis Null
Initializes the Form for .
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Add the sorted values to GridColumnDescriptorCollection.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class with a specified instance
of the class.
An instance of the class.
Initializes a new instance of the with a specified instances of the
and classes.
An instance of the class.
An array of instances of the classes.
Resets the collection to its default state. If the collection is bound to a ,
the collection will auto populate itself the next time an item inside the collection is accessed.
Adds multiple elements at the end of the collection.
The Array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
Contains the column values of TableDescriptor.
An instance of the contains the event data.
Triggered when the event is done.
Contains the column values of TableDescriptor.
The contains the event data.
Ensures the collection is initialized and auto-populates the collection on demand.
True if collection should auto-populate itself based on properties of
the underlying datasource.
Creates a new empty column descriptor with the specified name.
The name of the new column descriptor.
A new GridColumnDescriptor.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Creates a copy of this collection and all its inner elements. This method is called from Clone.
A copy of the collection and all its elements.
Called from InternalClone to create a new collection and attach it to the specified table descriptor
and insert the specified columns. The columns have already been cloned.
The table descriptor.
The cloned column descriptors.
A new GridColumnDescriptorCollection.
Determines a value indicating whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Marks the collection as modified and avoids auto-population.
Resets the collection to its default state, auto populates it, and marks it
as modified. Call this method if you want to load the default items for the collection and then
modify it (e.g. remove members from the auto-populated list).
gridGroupingControl1.TableDescriptor.Columns.LoadDefault();
gridGroupingControl1.TableDescriptor.Columns.Remove("MyChildTable.ForeignCategoryID");
Compares each element with the element of another collection.
The collection to compare to.
True if all elements are equal and in the same order; False otherwise.
Searches the column with a matching .
Mapping name of the column.
The column descriptor.
Searches the column with a matching instances's value of the class.
The field descriptor.
The column descriptor.
Finds the index of specified string to sort the GridColumnDescriptor collection.
The value to be found.
Index of (.),(-) in name if found; Otherwise -1.
Determines a value indicating whether the element belongs to this collection or not.
Determines a value indicating whether the element belongs to this collection or not.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls .
Determines a value indicating whether an element with the given name belongs to this collection or not.
The name of Object to locate in the collection.
True if item is found in the collection; otherwise, False.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls .
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Moves an element within the collection.
The original index of the element within the collection.
The target index of the element within the collection.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Adds an object to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Called to get a new default name when a new field descriptor is created (e.g. when pressing "Add" in a collection editor).
The field descriptor to be named.
Adds an object to the end of the collection.
The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Adds an object to the end of the collection.
The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The field name.
The zero-based collection index at which the value has been added.
Called from Add(string name) to create a new field descriptor with the given name.
The name of the new field descriptor.
A new field descriptor.
Removes the specified descriptor element with the specified name from the collection.
The name of the element to remove from the collection. If no element with that name is found
in the collection, the method will do nothing.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes the unmanaged resources.
Removes all elements from the collection.
Gets or sets a value indicating whether the collection should check for changes
in engine schema or underlying data source schema when EnsureInitialized gets called.
Gets engine of the Table descriptor.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
[Category("Columns")]
Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection is modified. When getting the version,
is called to ensure the collection is auto-populated
if needed.
Gets or sets a value indicating whether the collection is modified from its default state or not.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection is Read-only or not.
Gets a value indicating whether the collection has fixed size or not.
Gets a value indicating whether the collection can be synchronized or not.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls .
Implements the enumerator class for elements of a .
Initializes a new instances of the class that enumerates and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in collection.
Gets the current element in the collection.
Implements the type converter for objects.
is a . It overrides the default behavior of the
method and adds support for design-time code serialization.
Initializes a new instances of the class.
Overrides and determines a value indicating whether the current object can be converted to the specified type or not.
Format context.
The type you want to convert the object to.
True if this conversion is supported; Otherwise False.
Converts the given value to the specified type.
Format context.
Current culture information used for conversion.
Value to convert.
Type to convert to.
Converted object.
Gets a collection of properties for the specified object type.
Format context.
Value that specifies the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
Represents a call that implements with an IComparer implementation to compare the of
two objects.
Initializes a new instance of the class.
Compares two objects.
The first GridColumnDescriptor.
The second GridColumnDescriptor.
The result of string.Compare for the of the
two objects; 0 if both are the same.
Implements the GridColumnDescriptor which provides mapping information to a column of the underlying data source.
Constructor.
Overriding the string to restrict the text which will display in the designer.
Gets or sets a value indicating whether to display the 'Custom' text in the filter drop down.
Gets or sets a value indicating whether to display the 'Empty' text in the filter drop down.
Gets or sets a value that decides whether to filter the column based on display text or value.
It is applicable only for Dynamic Filter.
The column will be filtered based on the display text if the column format is set through the Column[index].Appearance.AnyRecordFieldCell.Format or Column[index].Appearance.AnyCell.Format property or if the column's cell type is Combobox, filtering will be based on the DisplayMember.
GridColumnDescriptor provides mapping information to a column of the underlying datasource.
Columns are managed by the that
is returned by the property
of a .
Interface for hosting a .
Returns the of this element.
Returns the
Determines whether the Appearance object has been modified
and its contents should be serialized at design-time.
returns boolean value to determines whether the Appearance object has been modified and its contents should be serialized at design-time.
Returns a of the first parent element with appearance in the hierarchy.
Returns a
Notifies the host that properties in the Appearance object were changed.
Notifies the host that properties in the Appearance object will be changed.
Returns a reference to the this object belongs to.
Interface for hosting a
Notifies the host that properties in the GroupOptions object were changed.
Notifies the host that properties in the GroupOptions object are about to be changed.
Returns a of the first parent element with group options in the hierarchy.
returns IGridGroupOptionsSource
Returns a reference to the this object belongs to.
Determines whether the GroupOptions object has been initialized.
Gets the group options.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class with a specified name.
Column name.
Initializes a new instance of the class with a specified name and mapping name.
Name of the column.
Mapping name of the column.
Initializes a new instance of the class with a specified name, mapping name and a header text.
Name of the column.
Mapping name of the column.
Column header text, which is displayed in the column header cell of the grouping grid.
Initializes a new instance of the class with the specified name, mapping name, header text
and also determines the column to be read-only column or not.
Name of the column.
Mapping name of the column.
Column header text.
Specifies the read-only state of the column. IfTrue then the column is read-only; Otherwise False.
Initializes a new instance of the class with the specified name, mapping name, header text, column width
and also determines the column to be read-only column or not.
Name of the column.
Mapping name of the column.
Column header text.
Specifies the read-only state of the column.
Column width.
Initializes a new instance of the class with the specified
instance of the information retrieved from an instance of the class.
The field descriptor provides mapping information to a column of the underlying datasource.
Initializes a new instance of the class with the specified
instance of the information retrieved from an instance of the class with a specified name.
The field descriptor provides mapping information to a column of the underlying datasource.
Column name.
Overrides and manages the unwanted resources.
Overrides and resets the descriptor settings.
Determines a value indicating whether the current object and its children should be serialized or not.
True if it should be serialized; Otherwise False.
Overrides and gets the string representation of the current object.
String representation of the current object.
Overrides and gets the name of the descriptor for the current object.
Descriptor name.
Initializes the current object and copies properties from another object
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Gets the standard values of the current column.
An instance of the class.
The property values of the current object.
Initializes the column collection.
Used internally.
An instance of the class.
Sets the table descriptor values of current object.
An instance of the class.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Overrides and determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
true if the specified is equal to the current
; otherwise, false.
Overrides and gets a hash function for a particular type.
A hash code for the current object.
Determines a value indicating whether the column's name was modified or not.
True if name is modified.
Resets the column's name.
Initialize the mapping of the column.
The instance of the class.
Determines if the column's header image was modified.
True if header text is modified.
Resets the header image.
Determines a value indicating whether the header images text was modified or not.
True.
Resets the image serialization text.
Determines if the column's header image alignment was modified.
True if header text is modified.
Gets or sets the header text to be displayed in the column header. If no header text has been specified,
the header text will be the same as the .
Resets the header image alignment.
Determines a value indicating whether the column's header text was modified or not.
True if header text is modified; Otherwise False.
Resets the header text.
Sets the width of the column. It will not raises events. The
grid uses this method internally when column widths are automatically resized based on their contents.
The new value.
Determines a value indicating whether the property was modified or not.
Trueif it was modified; Otherwise False.
Resets the property.
Gets the relative column index.
Helper method returns relative column index for column taking layout of column sets into consideration. To get the real column index
you need to add TableDescriptor.GetColumnIndentCount().
Relative column index.
Determines a value indicating whether the column's width was modified or not.
True if width is modified; OtherwiseFalse.
Resets the column width and allows the grid to auto-size the column based on its contents.
Resets EditFormColumnIndex.
Determines a value indicating whether the default value was modified or not.
True if it was modified; Otherwise False.
Determines a value indicating whether the has been modified or not.
and should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for .
Determines a value indicating whether has been modified
and its contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value indicating whether the Property_grid is modified or not.
True,if it is Property_Grid; Otherwise False.
Determines a value indicating whether the columns Read-only setting was modified or not.
True if Read-only setting is modified.
Resets column's Read-only setting.
Determines a value indicating whether the column's AllowFilter property was modified or not.
True if AllowFilter setting is modified; Otherwise False.
Resets the columns AllowFilter setting.
Determines a value indicating whether the column's AllowSort property was modified or not.
True if AllowSort setting is modified; Otherwise False.
Resets columns FilterRowOptions setting.
Determines if the column's AllowSort property was modified.
True if AllowSort setting is modified.
Resets columns AllowFilter setting.
Determines a value indicating whether the column's AllowDropDownCell property was modified or not.
True if AllowDropDownCell property was modified; Otherwise False.
Resets the columns AllowDropDownCell setting.
Determines if the column's AllowGroupByColumn property was modified.
True if AllowGroupByColumn property was modified.
Resets columns AllowGroupByColumn setting.
Determines a value indicating whether the column's AllowBlink property was modified or not.
Trueif AllowBlink property was modified; Otherwise False.
Resets columns AllowBlink setting.
Determines a value indicating whether a value has been modified
and its contents should be serialized or not at design-time.
True if contents were changed; Otherwise False.
Discards any changes for the object.
Gets the Table Appearance of the current object.
Appearance of Table.
Gets the base style of the current object.
If the object had a base style it is returned, Otherwise Null.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
The contains the event data.
Determines whether has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Occurs when a property is changed.
Occurs before a property is changed.
Gets or sets a value indicating whether to enable or disable sort by this column.
Gets the information of the current column.
Used internally.
Gets or sets the specified column index in form edit mode.
Gets or sets a value indicating whether to enable or disable the appearance deserialization.
Gets the collection values of the current column descriptor belongs.
Gets the value of TableDescriptor that this descriptor instance belongs to.
Gets or sets the name of the column.
If Name is not specified, the MappingName will be assigned to Name.
Name and MappingName should be same when you specify Name.
Gets the field descriptor this descriptor holds. If this column descriptor is
not a bound column, the method will return NULL.
A field descriptor.
Gets or sets the image to draw in header cell.
Gets or sets the string values used for serialization and deserialization of header images.
Get or set the alignment of image at header.
The header text to be displayed in the column header. If no header text has been specified,
the header text will be the same as the .
Gets or sets the value of a column's width in a parent record that the column in the child record should track. Use
this if you have frozen columns and want to make sure that columns in nested records
are properly aligned.
Gets or sets the width of the column.
Gets or sets the specifies the maximum length of the formatted text for this column.
This value will be used for calculating the optimal width of a column.
If the value is -1 the engine will determine the optimal width
of a column either by looping through the first n records or
using a SummaryDescriptor that keeps track of the entry with
most characters (see GridTableOptionsStyleInfo.ColumnsMaxLengthStrategy
and GridTableOptionsStyleInfo.ColumnsMaxLengthFirstNRecords).
Gets or sets the mapping name for this column. You should specify which column of a DataTable
you want to display in the grid at this column.
Gets or sets a value indicating whether to enable or disable sort this column by display member.
Gets or sets Read-only state of the column.
Gets or sets a value indicating whether a column supports FilterBar or not.
An object specifying a set of options for the current column that are related to Filtering.
Gets or sets the value indicating whether the grid can show a drop-down list or not for cells in this column if
column represents a foreign key field from a related table.
Gets or sets a value indicating whether the grid can be grouped by this column when the user drags the column
over the GropDropArea or not.
Gets or sets a value indicating whether the cell allows being highlighted when its value is changed or not. In such
case the cell is being highlighted with colors specified in the
collection and the time period specified in of the .
Default value is false.
Gets or sets the default with default
information for all cell elements that display data of this column. This property lets you control almost any aspect of
the appearance of the grouping grid like cell back color, font, or the cell type.
Gets the that this column descriptor belongs to.
Gets the default with default
information for all cell elements in the table that belong to groups that were grouped by this column.
This property only has an effect on the appearance of the table if this column has been added to
the collection of a .
Gets a value indicating whether GridGroupOptionSource has GroupOptions or not.
Gets or sets the group options for grid table.
The which lets you control the look and behavior of the child groups.
You can control the caption text, where and if AddNewRow will be displayed, or whether captions, footers, previews and summaries are displayed.
This property only has an effect on the appearance of the table if this column has been added to
the collection of a .
Used internally.
Represents a method that handles an event with .
The source of the event.
The contains the event data.
Provides data for the event.
The GridEngine.QueryAddColumn event affects the auto-population of the GridColumnDescriptorCollection.
It is called for each column and lets you control at run-time if the column should be added to the
GridColumnDescriptorCollection. You can set e.Cancel = True to avoid specific columns
being added.
Initializes a new instances of the class that provides the event data.
The table descriptor.
The column.
Gets the TableDescriptor instance.
Gets the Column.
Defines the constants that specify the options for filtering the column.
Filters the column based on the display text i.e. filter will be performed by applying the specified format to the cell value or DisplayMember of the column if that column cell type is ComboBox.
Filters the column based on the value.
Defines the constants that specify the strategy for resizing columns to optimal width.
See also GridColumnDescriptor.MaxLength, GridSummaryColumnDescriptor.MaxLength,
GridTableOptionsStyleInfo.ColumnsMaxLengthStrategy
and GridTableOptionsStyleInfo.ColumnsMaxLengthFirstNRecords
Initial size for columns will be GridTableOptionsStyleInfo.DefaultColumnWidth
A summary is created for each column to keep track of the maximum
length for the column. Best approach for smaller data sources. If
a GridColumnDescriptor.MaxLength was specified by the user, the
GridColumnDescriptor.MaxLength will be used instead.
The engine will loop through the first n rows at initialization time
and save the width in the table. The number of rows is defined by
GridTableOptionsStyleInfo.ColumnsMaxLengthFirstNRecords. If
a GridColumnDescriptor.MaxLength was specified by the user, the
GridColumnDescriptor.MaxLength will be used instead.
Defines the constants that specify the Header Image alignment.
Aligns the image at left of the column : before the header text
Aligns the image at right of the column : next to header text
Represents the IComparer implementation that compares the of
two objects.
Initialize new instance of class.
Compares two objects.
The first GridColumnSetDescriptor.
The second GridColumnSetDescriptor.
The result of string.Compare for the of the
two objects; 0 if both are the same.
Represents a collection of with information
about columns that can spread multiple grid rows or columns.
An instance of this collection is returned by the property
of a .
A Read-only and empty collection.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class with the specified instance of the class.
Initializes a new instance of the class with the specified instance of the and
classes.
An instance of the class.
An array of instances of class.
Clears the collection.
Overrides and gets the string representation the current object.
A string that represents the current object.
Sets the specified table descriptor values to the collection.
Initializes the form for InsideCollectionEditor.
Copies settings from another collection and raises the and
events if differences to the other collection are detected.
The source collection.
Adds multiple elements at the end of the collection.
The array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The specified instance of the class.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The changing column.
The contains the event data.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Overrides and determines a value whether the specified is equal to the
current or not.
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Gets a hash function for a particular type.
A hash code for the current object.
Performs the Equals operation.
The instance of the class.
Finds the item in the collection index of specified name.
Sorted value.
Index of the sorted name.
Finds the item from the specified item class.
An instance of the class.
Checks whether the specified column is present in GridColumnDescriptor or not.
Column name.
True if Column name exists,Otherwise False.
Determines a value indicating whether the element belongs to this collection or not.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Determines a value indicating whether an element with the specified name belongs to this collection or not.
The name of the element to locate in the collection.
True if item is found in the collection; otherwise, False.
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Gets an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
if value is read only
if is Null
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds an object to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
if value is read only
if is Null
Suggest the name of the column set.
The Source Collection.
Adds an object to the end of the collection.
The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the specified descriptor element with the specified name from the collection.
The name of the element to remove from the collection. If no element with that name is found
in the collection, the method will do nothing.
if the collection is read only
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
if is read only
Disposes of the object and collection items.
Removes all elements from the collection.
Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.
Gets the table descriptor this collection belongs to.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection is modified.
Gets or sets a value whether the collection is modified from its default state or not.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets the value either the collection is Read-only or not.
Gets the value either the collection has fixed size or not.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Enumerator class for elements of a .
Initializes the a new instance of the class with the specified
instance of the class.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Represents the type converter for objects.
is a . It overrides the default behavior of the
method and adds support for design-time code serialization.
Initializes a new instance of the class.
Overrides and determines a value whether the current object can be converted to the specified type or not.
Format context.
The type you want to convert the object to.
True if this conversion is supported; Otherwise False.
Converts the given value to the type specified.
Format context.
Current culture information used for conversion.
Value to convert.
Type to convert to.
Converted object.
Overrides and gets a collection of properties for the type specified.
Format context.
Value that specifies the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
The
class provides information
about columns that can spread multiple grid rows or columns.
ColumnSets are managed by the that
is returned by the property
of a .
Initializes a new instances of the class.
Initializes a new instances of the class.
Initializes a new instances of the class with a specified name.
Descriptor name.
Gets number of columns.
Column count.
Gets an array of columns that affect the width of this column set.
An array in the same order as the returned array with
width factors indicating the number of grid columns spanned by a column descriptor.
An array of columns that affect the width of this column set. Each column
will also have a width factor returned through the array.
Gets the descriptor name.
Descriptor name.
Overrides and manages the unwanted resources.
Initializes this object and copies properties from another object. The
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Initializes the collection.
The collection of columns.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Clones the current collection.
The cloned values.
Creates a copy of this descriptor.
A copy of this descriptor.
Determines a value whether the specified is equal to the
current or not.
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
performs the Equal operation.
The specified instance of the class.
Gets a hash function for a particular type.
A hash code for the current object.
Determines a value indicating whether the column sets name was modified (not empty) or not.
True if name is modified; Otherwise False.
Resets the column set's name to an empty string.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Occurs when a property is changed.
Occurs before a property is changed.
Gets the collection of columns spans that one or multiple column descriptors with a range of cells covered
by cells of a column.
Gets the collection this descriptor belongs to.
Gets the TableDescriptor that this descriptor belongs to.
Gets or sets the name of the column set.
Represent a class that provides information
about a column that can span multiple grid rows or columns.
The are managed by the that
is returned by the property
of a .
Initializes a new instance of the class.
Initializes a new empty column span.
Initializes a new instance of the class with a specified name.
Initializes a new instance of the class with a column span, column name and range that specifies the cells the
column covers.
Overrides and gets the name of the descriptor.
Descriptor name.
Overrides and manages the unmanaged resources.
Used internally.
Gets the collection.
The Source Collection.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Performs the Equal operation.
An instance of the class.
Serves as a hash function for a particular type.
A hash code for the current object.
Gets the standard values of the specified property descriptor.
An instance of the class.
Determines a value indicating whether the range was modified (not empty) or not.
True if name is modified; Otherwise False.
Resets the range to an empty range.
Gets the collection this descriptor belongs to.
Gets the TableDescriptor that this descriptor belongs to.
Gets the GridColumnSet that this descriptor belongs to.
Occurs when a property is changed.
Occurs before a property is changed.
Gets or sets the name of a .
Gets or sets the range of the columns that spans. Row and columns are zero based, e.g. R0C0:R0C1 indicates
the column spans two columns at the top.
Gets or sets the value of Range.
Used internally.
The type converter for objects.
is a . It overrides the default behavior of the
method and adds support for design-time code serialization.
Initializes the new instance for GridColumnSpanDescriptorTypeConverter class.
Determines whether the current object can be converted to the specified type.
Format context.
The type you want to convert the object to.
True if this conversion is allowed.
Converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Type to which the object should be converted to.
Converted object.
Gets a collection of properties for the specified type.
Format context.
Value specifying the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
A collection of with information
about columns that can spread multiple grid rows or columns.
An instance of this collection is returned by the property
of a .
A Read-only and empty collection.
Initializes a new instances of the class
Initializes a new instances of the class.
Initializes a new instances of the class with
the specified instances of the class.
An instance of the class.
Initializes a new instances of the class with the specified array of instances of
class.
An array of instances of the class.
Sets the owner instance.
An instance of the class.
Initializes the form
The object to be initialized.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Overrides and determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Gets a hash function for a particular type.
A hash code for the current object.
Performs the Equals operation.
An instance of the class.
Performs the search operation.
The value to be found.
Adds multiple elements at the end of the collection.
The array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Determines a value indicating whether the element belongs to this collection or not.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Searches for the element with the specified name.
The name of the element to locate in the collection.
True if item is found in the collection; otherwise, False.
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Gets an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds an object to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Adds an object to the end of the collection.
The column descriptor name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the specified descriptor element from the collection.
The column descriptor name of the element to remove from the collection. If the name is not found
in the collection, the method will do nothing.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The changed column.
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
The changing column values.
The contains the event data.
Overrides and gets the string representation of the current object.
A string that represents the current object.
Gets the name of value.
Gets the this collection belongs to.
Gets the this collection belongs to.
Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection is modified.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection is Read-only or not.
Gets a value indicating whether the collection has fixed size or not.
Gets a value indicating whether the collection is synchronized or not.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Represents the enumerator class for elements of a .
Initializes a new instances of the class with the
specified instances of the class.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Represents the type converter for objects.
is a . It overrides the default behavior of the
method and adds support for design-time code serialization.
Initializes the new instances of class.
Overrides and determines a value whether the current object can be converted to the specified type or not.
Format context.
The type you want to convert the object to.
True if this conversion is allowed.
Converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Type to convert to.
Converted object.
Represents a class that provides filter criteria for displaying a
subset of records from the underlying data source with conditional cell formatting.
Conditional format descriptors are managed by the that
is returned by the property
of a .
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class with a specified name.
The name of the descriptor.
Overrides and gets the string representation of the current object.
String representation of the current object.
Overrides and gets the descriptor name.
Descriptor name.
Wires the record filters.
Overrides and manages the unwanted resources.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Used internally.
Gets the collection from the instances of the class.
Gets the table descriptor.
An instance of the class.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Overrides and determines a value whether the specified is equal to the
current .
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Performs the Equals operation.
An instance of the class.
True if the specified objects are equal; Otherwise False.
Gets a hash function for a particular type.
A hash code for the current object.
Determines a value indicating whether the collection contains values or not.
True if it contains values; False otherwise.
Clears the collection.
Gets the rule applied on the specified column.
The column name.
The rule.
Gets a string that holds pre-compiled information about the expression.
A string that holds pre-compiled information about the expression.
Resets the compiled expression. It will be recompiled later on demand.
Triggered when the event is done.
The Control.
The contains the event data.
Triggers when the event is done.
The Control.
The contains the event data.
Determines a value indicating whether the has been modified
and its contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the Grid table appearance.
Appearance of the Grid table.
Gets the base appearance of the current object.
The base appearance.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
The contains the event data.
Evaluates this filter for the given record and returns True if the record
meets the filters criteria.
The record to be evaluated.
True if the record
meets the filters criteria; False otherwise.
Occurs when a property is changed.
Occurs before a property is changed.
Gets the collection this descriptor belongs to.
Gets the TableDescriptor that this descriptor belongs to.
Gets the collection of objects defining filter criteria
for records in the table. Each in the collection references
one or multiple of the collection. Multiple
criteria can be combined with logical "And" or "Or" operations.
Gets of sets the values of rules like IconSets , Color scale , DataBar.
Gets or sets the formula expression similar to expressions used in the .
Gets or sets the name of this conditional format. This name is used to look up items in the ConditionalFormats collection of the parent table descriptor.
Gets or sets the default with default
information for field cell elements in a record that matches the filter criteria specified with
or .
Gets a value indicating whether the is modified or not.
Gets the which the conditional format descriptor belongs to.
Represents a collection of which provide filter criteria for displaying a
subset of records from the underlying data source with conditional cell formatting.
An instance of this collection is returned by the property
of a .
Overrides and gets the string representation of the current object.
A string that represents the current object.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Initializes a new instances of the class.
Sets the table descriptor.
An instance of the class.
Initializes a new instances of the class with the specified instance of the class.
An instance of the class.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Gets a hash function for a particular type.
A hash code for the current object.
Performs the Equals operation.
An instance of the class.
True if the specified objects are equal; Otherwise False.
Find the index of the specified name in collection.
Specified value.
returns the index of the specified name.
Determines a value indicating whether the element belongs to this collection or not.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; Otherwise False.
Determines a value indicating whether the element with the specified name belongs to this collection or not.
The name of the element to locate in the collection.
True if item is found in the collection; Otherwise False.
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Gets an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds a filter descriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the specified descriptor element with the specified name from the collection.
The name of the element to remove from the collection. If no element with that name is found
in the collection, the method will do nothing.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Triggers when the event is done.
A contains the event data.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Occurs when a property is changed.
Occurs before a property is changed.
Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection was modified.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection is read-only or not.
Returns False.
Gets a value indicating whether this collection has fixed size or not.
Gets a value indicating whether the collection is Synchronized or not.
Returns False.
Gets the number of elements contained in the collection.
Represents an enumerator class for elements of a .
Initializes a new instance of the class and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Gets the current element in the collection.
Represents a collection of elements with constraints for a relation
between two tables and schema information of child tables. An instance of this
collection is returned by the property
of a .
Initializes the form for GridRelationDescriptorCollection.
Collection of GridRelationDescriptor.
Copies settings from another collection.
The source collection.
Copies settings from another collection.
The source collection.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
When called the ShouldPopulate property will be set true temporarily until
the next EnsureInitialized call and then be reset again to optimize subsequent lookups.
The Engine calls this method when schema changes occurred (PropertyChanged was raised).
Determines a value whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Gets a hash function for a particular type.
A hash code for the current object.
Initializes a new instances of the class.
Initializes a new instances of the class with the specified instance of the class.
RelationDescriptor Collection
Adds multiple elements at the end of the collection.
The array whose elements should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Disposes of the object and collection items.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Determines a value indicating whether the element belongs to this collection or not.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Removes all elements from the collection.
Resets the collection to its default state. If the collection is bound to a ,
the collection will auto populate itself the next time an item inside the collection is accessed.
Resets the collection to its default state, auto populates it, and marks it
as modified. Call this method if you want to load the default items for the collection and then
modify it (e.g. remove members from the auto-populated list).
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Adds an object to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Gets or sets a value indicating whether the collection is manipulated inside a collection editor.
Gets or sets whether collection should check for changes
in engine schema or underlying data source schema when EnsureInitialized gets called.
Gets the inner value of
Gets the nested count.
Used internally.
Gets the value whether the collection is Read-only or not.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection has fixed size or not.
Gets the value whether this collection has synchronized or not.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Represents a RelationDescriptor defines constraints for a relation
between two tables and schema information of child tables.
RelationDescriptors are managed by the which
is returned by the property
of a .
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class with a specified name.
The relation name.
Overrides and creates a table descriptor for the child table.
Child table descriptor.
Overrides and creates an exact copy of this object.
A duplicate of this object.
Gets the parent TableDescriptor this descriptor belongs to if this object is the child table
descriptor in a relation.
Gets or sets the TableDescriptor that describes child table.
Represents the type converter class for objects.
is a . It overrides the default behavior of the
ConvertTo method and adds support for design-time code serialization.
Determines a value indicating whether the current object can be converted to the specified type or not.
Format context.
The type you want to convert the object to.
True if this conversion is possible.
Overrides and converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Represents the type converter for objects.
is a . It overrides the default behavior of the
ConvertTo method and adds support for design-time code serialization.
Initializes the new instances of the class.
Determines a value whether this object can be converted to the specified type or not.
Format context.
The type you want to convert the object to.
True if this conversion is possible; Otherwise False.
Overrides and converts the given object to the specified type.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Overrides and gets the collection of properties for the specified type.
Format context.
Value specifying the type.
An array of objects that will be used as a filter.
A list of properties.
Represents a class that implements the GridStackedHeaderDescriptor and declares a StackedHeader column within a StackedHeader row.
GridStackedHeaderDescriptor descriptors are managed by the which
is returned by the property
of a .
Each group in the GridTable has a GridStackedHeaderSection. The StackedHeader section has as many
rows as there are GridStackedHeaderRowDescriptors. Each GridStackedHeaderRowDescriptor
has a collection of GridStackedHeaderDescriptor columns. The GridStackedHeaderDescriptor
defines the VisibleColumns or ColumnSets for which a combined header should be displayed
before the normal column headers.
If you leave the VisibleColumns collection empty than this header will be used as default
header for all columns that were not explicitly associated with another header.
So, if you want to just add an extra Caption then you could add a StackedHeaderRow
with only one StackedHeader that has an empty VisibleColumns collection.
Initializes a new empty descriptor.
Initializes a new instance of the class with a specified name.
The descriptor name which also identifies the GridColumnDescriptor.
Initializes a new instance of the class with a specified name and a parent table.
The descriptor name which also identifies the GridColumnDescriptor.
The text to be displayed in the grid cell.
Initializes a new instance of the class with a specified name, header text and an array of instances of
class.
The descriptor name which also identifies the GridColumnDescriptor.
The text to be displayed in the grid cell.
The columns that should be displayed as one combined header cell
Initializes a new instance of the class with a specified name, header text, filter column name
and array of instances of class.
The descriptor name which also identifies the GridColumnDescriptor.
The text to be displayed in the grid cell.
The column based on which this stacked column should be filtered.
The columns that should be displayed as one combined header cell
Initializes a new instance of the class with a specified name and
an array of instances of the class.
The descriptor name which also identifies the GridColumnDescriptor.
The columns that should be displayed as one combined header cell
Overrides and manages the unwanted resources.
Overrides and gets the descriptor name.
Descriptor name.
Determines a value indicting whether the property has been modified or not.
and its value should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the headerText text.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Sets the collection.
Used internally.
An instance of the class.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Gets a hash function for a particular type.
A hash code for the current object.
Determines a value whether has been modified or not
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Occurs when a property is changed.
Occurs before a property is changed.
Gets the TableDescriptor that this descriptor belongs to.
Gets or sets the name of this descriptor. This name is used to look up the StackedHeader in the
.
Gets or sets the headerText text to be displayed in the grid.
Gets the collection of columns that should be displayed as one combined header cell.
Gets the collection this descriptor belongs to.
Gets the GridStackedHeaderRowDescriptor this StackedHeader belongs to.
Gets or sets the default with default
information for all cell elements that display data of this stackedHeader column.
Gets the that this StackedHeader descriptor belongs to.
Represents a collection class of that declares StackedHeader columns within a StackedHeader row.
An instance of this collection is returned by the property
of a .
Each group in the GridTable has a GridStackedHeaderSection. The StackedHeader section has as many
rows as there are GridStackedHeaderRowDescriptors. Each GridStackedHeaderRowDescriptor
has a collection of GridStackedHeaderDescriptor columns. The GridStackedHeaderDescriptor
defines the VisibleColumns or ColumnSets for which a combined header should be displayed
before the normal column headers.
Initializes a new instance of the class.
Initializes a new instances of the class with the specified instances of the class.
An instance of the class.
Overrides and gets the string representation of the current object.
A string that represents the current object.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Adds multiple elements at the end of the collection.
The array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Gets a hash function for a particular type.
A hash code for the current object.
Performs the Equals operation.
The class.
True if the specified objects are equal; Otherwise False.
Determines a value indicating whether the element belongs to this collection or not.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Determines a value indicating whether the element with the specified name belongs to this collection or not.
The name of the element to locate in the collection.
True if item is found in the collection; otherwise, False.
Finds the index of the specified name in collection.
Specified value.
returns the index of the specified name.
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Gets the zero-based index of the occurrence of the element that matches the name in the collection.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Gets an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection the method will do nothing.
Adds a StackedHeaderDescriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Adds an item to the collection.
Used internally.
The value.
The index at which the value of has been added.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Occurs after a property in a nested element or the collection was changed.
Occurs before a property in a nested element or the collection is changed.
Gets or sets a value indicating whether the collection was manipulated inside the collection editor or not.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection is modified.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection is read-only or not.
Returns False.
Gets a value indicating whether this collection has fixed size or not.
Gets a value indicating whether the collection can be synchronized or not.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Represents an enumerator class for elements of a .
Initializes a new instance of the class which attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
The type converter for objects.
is a . It overrides the default behavior of the
ConvertTo method and adds support for design-time code serialization.
Determines whether this object can be converted to the specified type.
Format context.
The type you want to convert to.
True if this conversion is possible.
Converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Gets a collection of properties for the specified type.
Format context.
Value specifying the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
Represents a class of which declares a stackedHeader row with one or multiple GridStackedHeaderDescriptor elements.
GridStackedHeaderRowDescriptor descriptors are managed by the which
is returned by the property
of a .
Each group in the GridTable has a GridStackedHeaderSection. The StackedHeader section has as many
rows as there are GridStackedHeaderRowDescriptors. Each GridStackedHeaderRowDescriptor
has a collection of GridStackedHeaderDescriptor columns. The GridStackedHeaderDescriptor
defines the VisibleColumns or ColumnSets for which a combined header should be displayed
before the normal column headers.
If you leave the VisibleColumns collection empty than this header will be used as default
header for all columns that were not explicitly associated with another header.
So, if you want to just add an extra Caption then you could add a StackedHeaderRow
with only one StackedHeader that has an empty VisibleColumns collection.
Initializes a new instance of the class.
Initializes a new instance of the class.
Overrides and gets the string representation the current object.
String representation of the current object.
Wires the stacked headers.
Initializes a new instance of the with a specified row name.
The row name.
Initializes a new instance of the class with
a row name and a collection of class.
The row name.
A collection of GridStackedHeaderDescriptor
Overrides and manages the unwanted resources.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Sets the collection.
An instance of the class.
Initializes and sets the table descriptor.
An instance of the class.
Creates a copy of this descriptor.
A copy of this descriptor.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Performs the Equals operation.
An instance of the class.
True if the specified object is equal; Otherwise False.
Gets a hash function for a particular type.
A hash code for the current object.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event event is done. ///
The Control
The contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Overrides and gets the name of the descriptor.
Descriptor name.
Determines a value indicating whether has been modified
and contents should be serialized at design-time or not.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the appearance of the current object.
Gets the base appearance of the current object.
Gets the stacked header for a given column.
Name of the visible column.
Stacked header.
Ensures the layout.
Performs layout calculation.
Gets the stacked header span at a given column index.
Internal only.
Index of the column.
The GridStackedHeaderSpan at the specified column index.
Occurs when a property is changed.
Occurs before a property is changed.
Gets the collection this descriptor belongs to.
Gets the TableDescriptor that this descriptor belongs to.
Gets the collection of elements.
Gets or sets the name of this descriptor. This name is used to look up the stackedHeader in the
.
Gets or sets the default with default
information for all cell elements that display data of this stackedHeader row.
Gets a value indicating whether the appearance of the current object have to have serialized or not.
Gets the that this stackedHeader column descriptor belongs to.
Represents a collection of objects that declares
StackedHeader rows each with one or multiple GridStackedHeaderDescriptor elements.
An instance of this collection is returned by the property
of a .
Each group in the GridTable has a GridStackedHeaderSection. The StackedHeader section has as many
rows as there are GridStackedHeaderRowDescriptors. Each GridStackedHeaderRowDescriptor
has a collection of GridStackedHeaderDescriptor columns. The GridStackedHeaderDescriptor
defines the VisibleColumns or ColumnSets for which a combined header should be displayed
before the normal column headers.
If you leave the VisibleColumns collection empty than this header will be used as default
header for all columns that were not explicitly associated with another header.
So, if you want to just add an extra Caption then you could add a StackedHeaderRow
with only one StackedHeader that has an empty VisibleColumns collection.
Overrides and gets the string representation of the current object.
A string that represents the current object.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Initializes a new instance of the class.
Sets the table descriptor for the collection.
An instance of the class.
Initializes a new instance of the class with
the specified instance of the class.
An instance of the class.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Gets a hash function for a particular type.
A hash code for the current object.
Performs the Equals operation.
An instance of the class.
True if the specified object is equal; Otherwise False.
Finds the index of the specified name in collection.
Specified value.
returns the index of the specified name.
Determines a value indicating whether the element belongs to this collection or not.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; Otherwise False.
Determines a value indicating whether the element with the specified name belongs to this collection or not.
The name of the element to locate in the collection.
True if item is found in the collection; Otherwise False.
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Gets the zero-based index of the occurrence of the element that matches the name in the collection.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Gets an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Update selection ranges based on the addition and deletion of stacked headers.
True if stacked headers are removed;False if stacked headers are added
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds a StackedHeaderDescriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the a descriptor element that matches the specified name from the collection.
The name of the element to locate in the collection.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Occurs when a property is changed.
Occurs before a property is changed.
Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection was modified.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection is read only or not. Returns False.
Gets a value indicating whether the collection is a fixed size or not. Returns False.
Gets a value indicating whether the collection can be synchronized or not. Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Gets the number of rows that have the property set to True. This
is also the number of stackedHeader rows that are displayed in the grid for each group.
Represents an enumerator class for elements of a .
Initializes a new instance of the attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Implements a helper class that is created when layout of stacked header columns is calculated.
It associates the header, the columns in the grid and the visible columns and
can be used for quick lookups for QueryCoveredRange operations in the grid.
Gets the value of FirstCol.
Gets the value of LastCol.
Gets the value of Header.
Gets the value of ParentRow.
Gets the value of index.
Gets the value VisibleColumns.
Represents a which binds a Column or ColumnSet to a StackedHeader cell.
The descriptors are managed by the which
is returned by the property
of a .
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class with a specified name.
Name of the descriptor.
Overrides and get the name of the descriptor.
Descriptor name.
Overrides and disposes the unmanaged resources.
Sets the collection with the values specified in the grouping grid.
The instance of the class.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Overrides and determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Overrides and gets a hash function for a particular type.
A hash code for the current object.
Gets the standard values of the current object.
An instance of the class.
Gets the collection this descriptor belongs to.
Gets the that this descriptor belongs to.
Gets the that this descriptor belongs to.
Occurs when a property is changed.
Occurs before a property is changed.
Gets a value indicating whether the specified item is set name or not.
Gets the name of a or
Represents the type converter for objects.
is a . It overrides the default behavior of the
method and adds support for design-time code serialization.
Overrides and determines a value indicating whether this object can be converted to the specified type or not.
Format context.
The type you want to convert to.
True if this conversion is possible; Otherwise False.
Overrides and converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Overrides and gets the properties for the specified type of the current object.
Format context.
Value specifying the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
Represents the collection of with information
about headers that can spread columns.
An instance of this collection is returned by the property
of a .
A Read-only and empty collection.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a instance of the class with a
specified instance of the class.
An instance of the class.
Initializes a new instance of the class with a specified instance of the
class.
An array of instances of the class.
Sets the instance of the class.
An instance of the class.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Overrides and gets a hash function for a particular type.
A hash code for the current object.
Performs the Equals operation.
The specified object to be compared.
True if the specified object is equal; Otherwise False.
Finds the index of the specified name in collection.
Specified value.
Returns the index of the specified name.
Adds multiple elements at the end of the collection.
The array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Determines a value indicating whether the element belongs to this collection.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; Otherwise False.
Determines a value indicating whether the specified element is in the collection or not.
The name of the element to locate in the collection.
True if item is found in the collection; Otherwise False.
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Gets the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Gets an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds an object to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
If Duplicate column are exists.
Adds an object to the end of the collection.
The column descriptor name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the specified descriptor element from the collection.
The column descriptor name of the element to remove from the collection. If the name is not found
in the collection, the method will do nothing.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes the object and collection items.
Removes all elements from the collection.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Overrides and gets the string representation of the current object.
A string that represents the current object.
Gets the name of the specified stacked header's visible column item.
An instance of the class.
Gets the this collection belongs to.
Gets the this collection belongs to.
Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection is modified.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection is Read-only or not.
Gets a value indicating whether the collection is fixed size or not.
Returns normally False since this collection has no fixed size. Only when it is Read-only
IsFixedSize returns True.
Gets a value indicating whether the collection is synchronized or not.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Represents an enumerator class for elements of a .
Initializes a new instance of the class with a
specified instance of the class.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Defines the constants whether a summary should fill the entire row, only a column or if it should be hidden.
Do not show this summary in grid. (E.g. if only used as referenced another summaries Format.)
Display as a total for the column (typically Count, Min, Max are shown at the column).
Display one line for the whole row.
Represents the type converter for objects.
is a . It overrides the default behavior of the
ConvertTo method and adds support for design-time code serialization.
Initializes a new instance of the class.
Determines a value indicating whether this object can be converted to the specified type or not.
Format context.
The type you want to convert the object to.
True if this conversion is possible; Otherwise False.
Overrides and converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Overrides and gets a collection of properties for the specified type.
Format context.
Value specifying the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
Represents the type converter for the string of a
.
overrides the GetStandardValues method and returns possible properties for the chosen
.
Initializes a new instance of the class.
Overrides and gets a collection of standard values for the data type this type converter is
designed for when provided with a format context.
A format
context that can be used to extract additional information about the environment
from which this converter is invoked. This parameter or properties of this
parameter can be null.
A
that holds a standard set of valid values, or null if the data type does not
support a standard set of values.
Overrides and gets a value indicating whether the collection of standard values returned from is an
exclusive list of possible values or not, using the specified context.
The Format context.
Returns False.
Overrides and gets a value indicating whether this object supports a standard set of values that can be picked
from a list or not, using the specified context.
The Format context.
Returns true.
Overrides and gets a value indicating whether this converter can convert an object of the given type to the
type of this converter or not, using the specified context.
Format context.
The type you want to convert from.
True if this converter can perform the conversion; Otherwise False.
Overrides and converts the given object to the type of this converter, using the specified
context and culture information.
Format context.
Current culture.
The to convert.
An that represents the converted value.
Represents the type converter for the string of a
.
overrides the GetStandardValues method and returns a list of names for the
.
Overrides and gets a collection of standard values for the data type this type converter is
designed for when provided with a format context.
A format
context that can be used to extract additional information about the environment
from which this converter is invoked. This parameter or properties of this
parameter can be null.
A
that holds a standard set of valid values, or null if the data type does not
support a standard set of values.
Overrides and gets a value indicating whether the collection of standard values returned from is an
exclusive list of possible values or not, using the specified context.
The Format context.
Returns False.
Overrides and gets a value indicating whether this object supports a standard set of values that can be picked
from a list, using the specified context.
The Format context.
Returns True.
Overrides and gets a value indicating whether this converter can convert an object of the given type to the
type of this converter or not , using the specified context.
Format
context.
The type
you want to convert from.
True if this converter can perform the conversion; Otherwise False.
Overrides and converts the given object to the type of this converter, using the specified
context and culture information.
Format
context.
Current culture.
The to convert.
An that represents the converted value.
A GridSummaryColumnDescriptor declares a summary column within a summary row.
GridSummaryColumnDescriptor descriptors are managed by the which
is returned by the property
of a .
Each group in the GridTable has a summary section. The summary section has as many
rows as there are GridSummaryRowDescriptors that are visible. Each GridSummaryRowDescriptor
has a collection of GridSummaryColumnDescriptor columns. The GridSummaryColumnDescriptor
defines the GridColumnDescriptor to calculate summary information for
the SummaryType and the target column where the summary should be displayed in the grid.
The following example shows how to set up a summary. See also the grid\grouping\CustomSummary example for setting up custom summaries:
' Setup an integrated summary
Dim sd0 As New GridSummaryColumnDescriptor()
sd0.DataMember = "Quantity"
sd0.DisplayColumn = "Quantity"
sd0.Format = "{Average:#.00}"
sd0.SummaryType = SummaryType.DoubleAggregate
Me.gridGroupingControl1.TableDescriptor.SummaryRows.Add(New GridSummaryRowDescriptor("Row 0", "Average", sd0))
// Setup an integrated summary
GridSummaryColumnDescriptor sd0 = new GridSummaryColumnDescriptor();
sd0.DataMember = "Quantity";
sd0.DisplayColumn = "Quantity";
sd0.Format = "{Average:#.00}";
sd0.SummaryType = SummaryType.DoubleAggregate;
this.gridGroupingControl1.TableDescriptor.SummaryRows.Add(new GridSummaryRowDescriptor("Row 0", "Average", sd0));
Gets the name of the descriptor.
Descriptor name.
Initializes a new empty descriptor.
Initializes a new descriptor for the specified column (name) in the parent table.
The descriptor name which also identifies the GridColumnDescriptor.
Initializes a new descriptor for the specified column (name) in the parent table,
the summary type and the target column where the summary should be displayed.
The descriptor name.
The summary type.
The target column at which to display the summary.
The format string used to format the text to display in the summary column.
A format string consists of the PropertyName of the summaryType and a format specifier known
from String.Format, e.g. {Average:###.00}.
Disposes the objects and collection items.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Used internally.
Initializes the GridSummaryColumnDescriptorCollection.
GridSummaryColumnDescriptor Collection
if is Null
Initializes the of the grid.
if is Null
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Determines whether has been modified
and should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for .
Returns the name to be used for the in the
collection. The name is either the
SummaryRowDescriptorName.SummaryColumnDescriporName or DataMember.SummaryType depending on whether a
was specified for this SummaryColumnDescriptor or not.
Summary descriptor name.
Gets the index that can be used to look up summary values from the array
returned by of the .
Table.GetSummaries returns summaries in the same order as the SummaryDescriptors
were added to the TableDescriptor.
An integer index to look up summary values from a summary array.
Returns the calculated summary value for a specific run-time row element in the table.
The parent table.
The row in the table.
The ISummary object with summary values.
Returns the display text to be displayed in the summary grid cell.
Returns the display text to be displayed in the summary grid cell using the calculated
summary value for that specific run-time row element in the table.
The parent table.
The row in the table.
The text to display in the grid cell.
These code snippets demonstrates different alternatives to get to the summary text (strong typed vs GridSummaryColumnDescriptor.Format)
// Calling this method to demonstrate different alternatives to get to the summary text
string summaryText = GetSummaryText(el.ParentGroup, "SummaryRow 1", "FreightAverage");
// Easier is to simple call built-in routine:
string summaryText = GridEngine.GetSummaryText(el.ParentGroup, "SummaryRow 1", "FreightAverage");
///
/// Demonstrates different alternatives to get to the summary text (strong typed vs GridSummaryColumnDescriptor.Format)
///
public string GetSummaryText(Group group, string summaryRowName, string summaryColumnName)
{
GridTable table = (GridTable) group.ParentTable;
GridTableDescriptor td = table.TableDescriptor;
GridSummaryRowDescriptor srd = td.SummaryRows[summaryRowName];
GridSummaryColumnDescriptor scd = srd.SummaryColumns[summaryColumnName];
return GetSummaryText(group, scd);
}
///
/// Demonstrates different alternatives to get to the summary text (strong typed vs GridSummaryColumnDescriptor.Format)
///
string GetSummaryText(Group group, GridSummaryColumnDescriptor scd)
{
GridTable table = (GridTable) group.ParentTable;
GridTableDescriptor td = table.TableDescriptor;
string summaryText = string.Empty;
bool use31Code = true;
if (use31Code)
{
if (scd != null)
{
// Option 1: GetDisplayText - this is actually the code used when you simply would call
// e.Style.Text = ((GridTable) table).GetSummaryText(group, "SummaryRow 1", "FreightAverage");
//
// Text is formatted as defined in GridSummaryColumnDescriptor.Format
summaryText = scd.GetDisplayText(group);
// or Option 2: Strong typed access to DoubleAggregateSummary.
DoubleAggregateSummary summary1 = (DoubleAggregateSummary) group.GetSummary(scd.SummaryDescriptor);
summaryText = string.Format("{0:c}", summary1.Average);
// or Option 3: Use reflection to get "Average" property of summary
summaryText = string.Format("{0:c}", group.GetSummaryProperty(scd.SummaryDescriptor, "Average"));
}
}
else
{
// This is the code you had to use in version 3.0 and earlier (still working but bit more complicate)
if (scd != null)
{
SummaryDescriptor sd1 = scd.SummaryDescriptor;
if (sd1 != null)
{
int indexOfSd1 = table.TableDescriptor.Summaries.IndexOf(sd1);
ISummary sum1 = group.GetSummaries(table)[indexOfSd1];
string text1 = scd.GetDisplayText(sum1);
summaryText = text1;
// - or - (access value directly)
// strong typed - you have to cast to Int32AggregateSummary.
DoubleAggregateSummary summary1 = (DoubleAggregateSummary) group.GetSummaries(table)[indexOfSd1];
summaryText = string.Format("{0:c}", summary1.Average);
}
}
}
return summaryText;
}
' Calling this method to demonstrate different alternatives to get to the summary text
summaryText = GetSummaryText(el.ParentGroup, "SummaryRow 1", "FreightAverage")
' Easier is to simple call built-in routine:
summaryText = GridEngine.GetSummaryText(el.ParentGroup, "SummaryRow 1", "FreightAverage")
'/
'/ Demonstrates different alternatives to get to the summary text (strong typed vs GridSummaryColumnDescriptor.Format)
'/
Public Function GetSummaryText(ByVal group As Group, ByVal summaryRowName As String, ByVal summaryColumnName As String) As String
Dim table As GridTable = CType(group.ParentTable, GridTable)
Dim td As GridTableDescriptor = table.TableDescriptor
Dim srd As GridSummaryRowDescriptor = td.SummaryRows(summaryRowName)
Dim scd As GridSummaryColumnDescriptor = srd.SummaryColumns(summaryColumnName)
Return GetSummaryText(group, scd)
End Function 'GetSummaryText
'/
'/ Demonstrates different alternatives to get to the summary text (strong typed vs GridSummaryColumnDescriptor.Format)
'/
Function GetSummaryText(ByVal group As Group, ByVal scd As GridSummaryColumnDescriptor) As String
Dim table As GridTable = CType(group.ParentTable, GridTable)
Dim td As GridTableDescriptor = table.TableDescriptor
Dim summaryText As String = string.Empty
Dim use31Code As Boolean = True
If use31Code Then
If Not (scd Is Nothing) Then
' Option 1: GetDisplayText - this is actually the code used when you simply would call
' e.Style.Text = ((GridTable) table).GetSummaryText(group, "SummaryRow 1", "FreightAverage");
'
' Text is formatted as defined in GridSummaryColumnDescriptor.Format
summaryText = scd.GetDisplayText(group)
' or Option 2: Strong typed access to DoubleAggregateSummary.
Dim summary1 As DoubleAggregateSummary = CType(group.GetSummary(scd.SummaryDescriptor), DoubleAggregateSummary)
summaryText = String.Format("{0:c}", summary1.Average)
' or Option 3: Use reflection to get "Average" property of summary
summaryText = String.Format("{0:c}", group.GetSummaryProperty(scd.SummaryDescriptor, "Average"))
End If
Else
' This is the code you had to use in version 3.0 and earlier (still working but bit more complicate)
If Not (scd Is Nothing) Then
Dim sd1 As SummaryDescriptor = scd.SummaryDescriptor
If Not (sd1 Is Nothing) Then
Dim indexOfSd1 As Integer = table.TableDescriptor.Summaries.IndexOf(sd1)
Dim sum1 As Syncfusion.Collections.BinaryTree.ITreeTableSummary = group.GetSummaries(table)(indexOfSd1)
Dim text1 As String = scd.GetDisplayText(sum1)
summaryText = text1
' - or - (access value directly)
' strong typed - you have to cast to Int32AggregateSummary.
Dim summary1 As DoubleAggregateSummary = CType(group.GetSummaries(table)(indexOfSd1), DoubleAggregateSummary)
summaryText = String.Format("{0:c}", summary1.Average)
End If
End If
End If
Return summaryText
End Function 'GetSummaryText
Returns the display text to be displayed in the summary grid cell given
an ISummary.
The ISummary object with summary values.
The group Pass Through Item.
The text to display in the grid cell.
Returns the display text to be displayed in the summary grid cell given
an ISummary.
The ISummary object with summary values.
The text to display in the grid cell.
Returns the display text to be displayed in the summary grid cell given
an ISummary.
The Group with summary values.
The text to display in the grid cell.
Determines whether has been modified
and its value should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines whether has been modified
and its value should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines whether has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the TableDescriptor that this descriptor belongs to.
Occurs when a property is changed.
Occurs before a property is changed.
Gets or sets the name of this descriptor. This name is used to look up the summary in the
.
Gets the collection this descriptor belongs to.
Gets the GridSummaryRowDescriptor this summary column belongs to.
Gets or sets a value indicates whether RecordFilter criteria should be ignored and
the summary should be calculated for all records.
Gets or sets a value that specifies the maximum length of the formatted text for this summary column.
This value will be used for calculating the optimal width of a column.
The default is the length of the Format text plus 5.
Gets the that is used for calculating the summaries. The
GridEngine internally creates SummaryDescriptors for each GridColumnDescriptor based
on the SummaryType and DataMember defined in the GridColumnDescriptor. If SummaryType.Custom
was specified, the TableDescriptor.QueryCustomSummary event needs to instantiate
the SummaryDescriptor.
Gets or set the type of summary.
Gets or sets the format string used to format the text to display in the summary column.
A format string consists of the PropertyName of the summaryType and a format specifier known
from String.Format, e.g. {Average:###.00}.
The mapping for this column. You should specify here a field name of a FieldDescriptor ( or GridColumnDescriptor.MappingName)
Gets or sets whether a summary should fill the entire row, only a column, or if it should be hidden.
Gets or sets the target column at which to display the summary.
Gets or sets the row index relative to the first row in the summary section of a group.
Gets or sets the grid column index of the target cell where the summary is displayed.
Gets or sets the default with default
information for all cell elements that display data of this summary column.
Gets the that this summary column descriptor belongs to.
Represents a collection of which declares the summary columns within a summary row.
GridSummaryColumnDescriptor descriptors.
An instance of this collection is returned by the property
of a .
Each group in the GridTable has a summary section. The summary section has as many
rows as there are GridSummaryRowDescriptors that are visible. Each GridSummaryRowDescriptor
has a collection of GridSummaryColumnDescriptor columns. The GridSummaryColumnDescriptor
defines the GridColumnDescriptor to calculate summary information for,
the SummaryType, and the target column where the summary should be displayed in the grid.
The following example shows how to set up a summary:
' Setup a integrated summary
Dim sd0 As New GridSummaryColumnDescriptor()
sd0.DataMember = "Quantity"
sd0.DisplayColumn = "Quantity"
sd0.Format = "{Average:#.00}"
sd0.SummaryType = SummaryType.DoubleAggregate
Me.gridGroupingControl1.TableDescriptor.SummaryRows.Add(New GridSummaryRowDescriptor("Row 0", "Average", sd0))
// Setup a integrated summary
GridSummaryColumnDescriptor sd0 = new GridSummaryColumnDescriptor();
sd0.DataMember = "Quantity";
sd0.DisplayColumn = "Quantity";
sd0.Format = "{Average:#.00}";
sd0.SummaryType = SummaryType.DoubleAggregate;
this.gridGroupingControl1.TableDescriptor.SummaryRows.Add(new GridSummaryRowDescriptor("Row 0", "Average", sd0));
Overrides and gets the string representation of the current object.
A string that represents the current object.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Initializes a new instance of the class.
Initializes a new instance of the class
with the specified instance of the class.
An instance of the class.
Adds multiple elements at the end of the collection.
The array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Determines a value indicating whether the specified is equal to the
current or not.
The to compare with the current
.
True if the specified is equal to the current
; Otherwise False.
Overrides and gets a hash function for a particular type.
A hash code for the current object.
Performs the Equals operation.
An instance of the class.
True if the specified object is equal; Otherwise False.
Determines a value indicating whether the element belongs to this collection or not.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; Otherwise False.
Determines a value indicating whether the element with the specified name belongs to this collection or not.
The name of the element to locate in the collection.
True if item is found in the collection; otherwise False.
Searches the specified item in the collection.
The item to be found.
The index of the item, if found; Otherwise Null.
Gets the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Gets the zero-based index of the occurrence of the element that matches the name in the collection.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Gets an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection the method will do nothing.
Adds a SummaryDescriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Adds an item to the collection.
Used internally.
The GridSummaryColumnDescriptor value.
Returns the index at which the GridSummaryColumnDescriptor has been added.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Triggered when the event is done.
A contains the event data.
Triggered when the event is done.
A contains the event data.
Occurs after a property in a nested element or the collection was changed.
Occurs before a property in a nested element or the collection is changed.
Gets or sets a value indicating whether the collection was manipulated inside the collection editor or not.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection is modified.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Gets a value indicating whether the collection is read-only or not.
Returns False.
Gets a value indicating whether the collection is fixed size or not.
Returns False since this collection has no fixed size.
Gets a value indicating whether the collection can be synchronized or not.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Implements the enumerator class for elements of a .
Initializes a new instance of the class with a specified
instance of the class.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Represents a method that handles events with the event that is
raised by , , or objects.
The Control.
The contains the event data.
Holds a reference to a and
and lets you fill in the or
with a that can instantiate custom objects.
See the Grid\Grouping\CustomSummaries example how to implement custom summaries:
public Form1()
{
//
// Required for Windows Form Designer support
//
InitializeComponent();
// Setup custom summaries
this.gridGroupingControl1.QueryCustomSummary += new GridQueryCustomSummaryEventHandler(gridGroupingControl1_QueryCustomSummary);
GridSummaryColumnDescriptor sd1 = new GridSummaryColumnDescriptor();
sd1.Name = "QuantityTotal";
sd1.DataMember = "Quantity";
sd1.DisplayColumn = "Quantity";
sd1.Format = "{Total}";
sd1.SummaryType = SummaryType.Custom;
this.gridGroupingControl1.TableDescriptor.SummaryRows.Add(new GridSummaryRowDescriptor("Row 1", "Total", sd1));
}
private void gridGroupingControl1_QueryCustomSummary(object sender, GridQueryCustomSummaryEventArgs e)
{
switch (e.SummaryColumn.Name)
{
case "QuantityTotal":
{
e.SummaryDescriptor.CreateSummaryMethod = new CreateSummaryDelegate(TotalSummary.CreateSummaryMethod);
break;
}
}
}
public sealed class TotalSummary : SummaryBase
{
double _total;
public static readonly TotalSummary Empty = new TotalSummary(0);
public static ISummary CreateSummaryMethod(SummaryDescriptor sd, Record record)
{
object obj = sd.GetValue(record);
bool isNull = (obj == null || obj is DBNull);
if (isNull)
return Empty;
else
{
double val = Convert.ToDouble(obj);
return new TotalSummary(val);
}
}
public TotalSummary(double total)
{
_total = total;
}
public double Total
{
get
{
return _total;
}
}
public override SummaryBase Combine(SummaryBase other)
{
return Combine((TotalSummary) other);
}
/// a new summary object instead of modifying an existing summary object.
public TotalSummary Combine(TotalSummary other)
{
// Summary objects are immutable. That means properties cannot be modified for an
// existing object. Instead every time a change is made a new object must be created (just like
// System.String).
//
// This allows following optimization: return existing summary object if either one of the values is 0. --
if (other.Total == 0)
return this;
else if (Total == 0)
return other;
// -- end of optimization
else
return new TotalSummary(this.Total + other.Total);
}
public override string ToString()
{
return String.Format("Total = {0:0.00}", Total);
}
}
Public Class Form1
Inherits System.Windows.Forms.Form
Public Sub New()
'
' Required for Windows Form Designer support
'
InitializeComponent()
' Setup custom summaries
AddHandler Me.gridGroupingControl1.QueryCustomSummary, AddressOf gridGroupingControl1_QueryCustomSummary
Dim sd1 As New GridSummaryColumnDescriptor()
sd1.Name = "QuantityTotal"
sd1.DataMember = "Quantity"
sd1.DisplayColumn = "Quantity"
sd1.Format = "{Total}"
sd1.SummaryType = SummaryType.Custom
Me.gridGroupingControl1.TableDescriptor.SummaryRows.Add(New GridSummaryRowDescriptor("Row 1", "Total", sd1))
End Sub 'New
Private Sub gridGroupingControl1_QueryCustomSummary(ByVal sender As Object, ByVal e As GridQueryCustomSummaryEventArgs)
Select Case e.SummaryColumn.Name
Case "QuantityTotal"
e.SummaryDescriptor.CreateSummaryMethod = New CreateSummaryDelegate(AddressOf TotalSummary.CreateSummaryMethod)
Exit Select
Case "QuantityDistinctCount"
e.SummaryDescriptor.CreateSummaryMethod = New CreateSummaryDelegate(AddressOf DistinctInt32CountSummary.CreateSummaryMethod)
Exit Select
Case "QuantityMedian"
e.SummaryDescriptor.CreateSummaryMethod = New CreateSummaryDelegate(AddressOf StatisticsSummary.CreateSummaryMethod)
Exit Select
End Select
End Sub 'gridGroupingControl1_QueryCustomSummary
NotInheritable Public Class TotalSummary
Inherits SummaryBase
Private _total As Double
Public Shared Empty As New TotalSummary(0)
Public Shared Function CreateSummaryMethod(ByVal sd As SummaryDescriptor, ByVal record As Record) As ITreeTableSummary
Dim obj As Object = sd.GetValue(record)
Dim isNull As Boolean = obj Is Nothing OrElse TypeOf obj Is DBNull
If isNull Then
Return Empty
Else
Dim val As Double = Convert.ToDouble(obj)
Return New TotalSummary(val)
End If
End Function 'CreateSummaryMethod
Public Sub New(ByVal total As Double)
_total = total
End Sub 'New
Public ReadOnly Property Total() As Double
Get
Return _total
End Get
End Property
Public Overloads Overrides Function Combine(ByVal other As SummaryBase) As SummaryBase
Return Combine(CType(other, TotalSummary))
End Function 'Combine
Public Overloads Function Combine(ByVal other As TotalSummary) As TotalSummary
' Summary objects are immutable. That means properties cannot be modified for an
' existing object. Instead every time a change is made a new object must be created (just like
' System.String).
'
' This allows following optimization: return existing summary object if either one of the values is 0. --
If other.Total = 0 Then
Return Me
ElseIf Total = 0 Then
Return other
' -- end of optimization
Else
Return New TotalSummary(Me.Total + other.Total)
End If
End Function 'Combine
Public Overrides Function ToString() As String
Return String.Format("Total = {0:0.00}", Total)
End Function 'ToString
End Class 'TotalSummary
Initializes a new instance of the class with the specified
instance of the and classes.
The summary column descriptor.
The summary descriptor.
Gets the summary column descriptor of the current object.
Gets the summary descriptor of the current object.
The type converter for objects.
is a . It overrides the default behavior of the
ConvertTo method and adds support for design-time code serialization.
Initializes the new instances for GridSummaryRowDescriptorTypeConverter class.
Determines whether this object can be converted to the type specified.
Format context.
The type you want to convert the object to.
True if this conversion is possible.
Converts the given value to the type specified.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Gets a collection of properties for the specified type.
Format context.
Value specifying type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
A GridSummaryRowDescriptor declares a summary row with one or multiple GridSummaryColumnDescriptor elements.
GridSummaryRowDescriptor descriptors are managed by the which
is returned by the property
of a .
Each group in the GridTable has a summary section. The summary section has as many
rows as there are GridSummaryRowDescriptors that are visible. Each GridSummaryRowDescriptor
has a collection of GridSummaryColumnDescriptor columns. The GridSummaryColumnDescriptor
defines the GridColumnDescriptor to calculate summary information for
the SummaryType and the target column where the summary should be displayed in the grid.
See also the Grid\Grouping\CustomSummary example for setting up custom summaries.
The following example shows how to set up a summary:
' Setup a integrated summary
Dim sd0 As New GridSummaryColumnDescriptor()
sd0.DataMember = "Quantity"
sd0.DisplayColumn = "Quantity"
sd0.Format = "{Average:#.00}"
sd0.SummaryType = SummaryType.DoubleAggregate
Me.gridGroupingControl1.TableDescriptor.SummaryRows.Add(New GridSummaryRowDescriptor("Row 0", "Average", sd0))
// Setup a integrated summary
GridSummaryColumnDescriptor sd0 = new GridSummaryColumnDescriptor();
sd0.DataMember = "Quantity";
sd0.DisplayColumn = "Quantity";
sd0.Format = "{Average:#.00}";
sd0.SummaryType = SummaryType.DoubleAggregate;
this.gridGroupingControl1.TableDescriptor.SummaryRows.Add(new GridSummaryRowDescriptor("Row 0", "Average", sd0));
Initializes a new empty descriptor.
Initializes a new empty descriptor.
Gets the name of the descriptor.
Descriptor name.
Returns a string holding the current object.
String representation of the current object.
Wires the events.
Initializes a new descriptor with a row name.
The row name.
Initializes a new descriptor with a row name, title, and collection of GridSummaryColumnDescriptors.
The row name.
A summary row title. A title is displayed at the left-most cell of that row.
A collection of GridSummaryColumnDescriptors.
Initializes a new descriptor with a row name, title, titleColumnCount and collection of GridSummaryColumnDescriptors.
The row name.
A summary row title. A title is displayed at the left-most cell of that row.
TitleColumnCount of the title to be shown in Summary row.
A GridSummaryColumnDescriptor.
Initializes a new descriptor with a row name, title, and collection of GridSummaryColumnDescriptors.
The row name.
A summary row title. A title is displayed at the left-most cell of that row.
A GridSummaryColumnDescriptor.
Initializes a new descriptor with a row name and a collection of GridSummaryColumnDescriptors.
The row name.
A GridSummaryColumnDescriptor
Initializes a new descriptor with a row name and a collection of GridSummaryColumnDescriptors.
The row name.
A collection of GridSummaryColumnDescriptor
Disposes the unmanaged resources.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Initializes the GridSummaryRowDescriptorCollection.
GridSummaryRowDescriptor Collection
Used internally.
Initializes the Table descriptor.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Internal only.
Returns the GridSummaryColumnDescriptor that is displayed at the zero-based grid column position.
The column index.
The GridSummaryColumnDescriptor.
The GridTableControl calls this method to determine which summary column to display
at a specific grid column index. Given a grid cell rowIndex and colIndex, the grid
calls
fieldNum = TableDescriptor.ColIndexToField(colIndex);
GridSummaryColumnDescriptor sc = sr.SummaryRowDescriptor.GetSummaryColumnAtCol(fieldNum);
Determines whether has been modified
and its value should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the title text.
Determines whether has been modified
and its value should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the titleColumnCount text.
Determines whether has been set to False
and its value should be serialized at design-time.
True if contents were changed; False otherwise.
Resets property to be True.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Occurs when a property is changed.
Occurs before a property is changed.
Gets the collection this descriptor belongs to.
Gets the TableDescriptor that this descriptor belongs to.
Gets whether this row displays summary columns in grid cells below a certain header column
or if the summary row is one large covered cell that spans the whole row.
Gets the collection of elements.
Gets or sets the title text to be displayed in the column title.
Gets or sets the number of columns that the Title should span. Specify 0 if no title should be displayed.
Gets or sets whether the row should be visible in the grid. If you set
this property to False, the row will not show up but you can still reference
the summary columns from a caption bar in the
of a as a custom summary token.
Gets or sets the name of this descriptor. This name is used to look up the summary in the
.
Gets or sets the default with default
information for all cell elements that display data of this summary row.
Gets the that this summary column descriptor belongs to.
A collection from that declares
summary rows each with one or multiple GridSummaryColumnDescriptor elements.
An instance of this collection is returned by the property
of a .
The SummaryRows collection contains GridSummaryRowDescriptors. GridSummaryRowDescriptors have a name,
title, and collection of summary columns. A GridSummaryRowDescriptor also has a Read-only
IsFillRow property. If this property is True, the summary should fill the
whole row and not be displayed below individual columns. IsFillRow will return True if
any of the GridSummaryColummDescriptors in the SummaryColumns collection is set to
GridSummaryStyle.FillRow.
The GridSummaryColummDescriptor defines where to display the column in the row.
Essential properties are the name, format, DisplayColum, DataMember, and
SummaryType. The multiple GridSummaryColumnDescriptor objects
have a name and mapping name that identify the column for which a summary should be
calculated for and a SummaryType property that defines the type of calculations to be performed.
Possible SummaryTypes are: Count, BooleanAggregate, ByteAggregate, CharAggregate, DistinctCount,
DoubleAggregate, Int32Aggregate, MaxLength, StringAggregate, Vector, DoubleVector, and Custom.
When you specify the SummaryType.Custom type, you need to set the custom method through the
CreateSummaryMethod property of the SummaryDescriptor. It is of type CreateSummaryDelegate and
is called to create an instance of a summary object. You also need to handle the
GridGroupingControl.QueryCustomSummary as demonstrated in the Grid/Grouping/CustomSummaries example.
Each group in the GridTable has a summary section. The summary section has as many
rows as there are GridSummaryRowDescriptors that are visible. Each GridSummaryRowDescriptor
has a collection of GridSummaryColumnDescriptor columns. The GridSummaryColumnDescriptor
defines the GridColumnDescriptor to calculate summary information for
the SummaryType and the target column where the summary should be displayed in the grid.
The following example shows how to set up a summary:
' Setup a integrated summary
Dim sd0 As New GridSummaryColumnDescriptor()
sd0.DataMember = "Quantity"
sd0.DisplayColumn = "Quantity"
sd0.Format = "{Average:#.00}"
sd0.SummaryType = SummaryType.DoubleAggregate
Me.gridGroupingControl1.TableDescriptor.SummaryRows.Add(New GridSummaryRowDescriptor("Row 0", "Average", sd0))
// Setup a integrated summary
GridSummaryColumnDescriptor sd0 = new GridSummaryColumnDescriptor();
sd0.DataMember = "Quantity";
sd0.DisplayColumn = "Quantity";
sd0.Format = "{Average:#.00}";
sd0.SummaryType = SummaryType.DoubleAggregate;
this.gridGroupingControl1.TableDescriptor.SummaryRows.Add(new GridSummaryRowDescriptor("Row 0", "Average", sd0));
Returns a string that represents the current object.
A string that represents the current object.
initializes the InsideCollectionEditor form.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Initializes a new empty collection.
Gets the table descriptor.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Find the index of the specified name in collection.
Specified value.
returns the index of the specified name.
Determines if the element belongs to this collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Determines if the element with the specified name belongs to this collection.
The name of the element to locate in the collection.
True if item is found in the collection; otherwise, False.
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Returns the zero-based index of the occurrence of the element that matches the name in the collection.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
Adds a SummaryDescriptor to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the a descriptor element that matches the specified name from the collection.
The name of the element to locate in the collection.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes of the object and collection items.
Removes all elements from the collection.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Inserts an item to the System.Collections.IList at the specified index.
The zero-based index at which value should be inserted.
The object to insert into the System.Collections.IList.
Removes the first occurrence of a specific object from the System.Collections.IList.
The object to remove from the System.Collections.IList.
Determines whether the System.Collections.IList contains a specific value.
The object to locate in the System.Collections.IList.
true if the System.Object is found in the System.Collections.IList; otherwise,false.
Determines the index of a specific item in the System.Collections.IList.
The object to locate in the System.Collections.IList.
The index of value if found in the list; otherwise, -1.
Adds an item to the System.Collections.IList.
The object to add to the System.Collections.IList.
The position into which the new element was inserted, or -1 to indicate that
the item was not inserted into the collection.
Copies the elements of the System.Collections.ICollection to an System.Array,
starting at a particular System.Array index.
The one-dimensional System.Array that is the destination of the elements
copied from System.Collections.ICollection. The System.Array must have zero-based
indexing.
The zero-based index in array at which copying begins.
Returns an enumerator that iterates through a collection.
An System.Collections.IEnumerator object that can be used to iterate through the collection.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Provides an interface that supplies dynamic custom type information for an object.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Occurs when a property is changed.
Occurs before a property is changed.
Gets or sets whether the collection is manipulated inside a collection editor.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection was modified.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Returns False.
Returns False since this collection has no fixed size.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Gets the number of rows that have the property set to True. This
is also the number of summary rows that are displayed in the grid for each group.
Gets or sets the element at the specified index.
The zero-based index of the element to get or set.
The element at the specified index.
Gets an object that can be used to synchronize access to the System.Collections.ICollection.
Enumerator class for elements of a .
Initializes the enumerator and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Gets the current element in the collection.
- SummaryRows
The SummaryRows collection contains GridSummaryRowDescriptors. GridSummaryRowDescriptors have a name,
title, and collection of summary columns. A GridSummaryRowDescriptor also has a Read-only
IsFillRow property. If this property is True, the summary should fill the
whole row and not be displayed below individual columns. IsFillRow will return True if
any of the GridSummaryColummDescriptors in the SummaryColumns collection are set to
GridSummaryStyle.FillRow.
The GridSummaryColummDescriptor defines where to display the column in the row.
Essential properties are the name, format, DisplayColumn, DataMember, and
SummaryType. The multiple GridSummaryColumnDescriptor objects
have a name and mapping name that identify the column for which a summary should be
calculated for and a SummaryType property that defines the type of calculations to be performed.
Possible SummaryTypes are: Count, BooleanAggregate, ByteAggregate, CharAggregate, DistinctCount,
DoubleAggregate, Int32Aggregate, MaxLength, StringAggregate, Vector, DoubleVector, and Custom.
When you specify the SummaryType.Custom type, you need to set the custom method through the
CreateSummaryMethod property of the SummaryDescriptor. It is CreateSummaryDelegate and
is called to create an instance of a summary object. You also need to handle the
GridGroupingControl.QueryCustomSummary as demonstrated in the Grid/Grouping/CustomSummaries example.
The Field, Relations, and Columns collections feature auto-populating on demand
and reflect changes from the collection they depend on. The auto-population will happen when
you access the contents of the collection, e.g. if you query its Count.
GroupedColumns, SortedColumns, and RecordFilters need to be manually initialized. They are not auto-populated.
SortedColumnDescriptor also lets you specify a custom comparer that implements the IComparer
interface.
The AllowNew, AllowEdit, and AllowRemove properties let you specify whether the user should be allowed to modify the underlying table.
The columns collections feature auto-populating on demand and reflect changes from the collection they depend on. The auto-population will happen when you access the contents of the collection, e.g. if you query its Count.
GridTableDescriptor orderDetailsTableDescriptor;
// Lets check the count of each collection:
Trace.WriteLine(orderDetailsTableDescriptor.Fields.Count); // returns 4
Trace.WriteLine(orderDetailsTableDescriptor.ExpressionFields.Count); // returns 0
Trace.WriteLine(orderDetailsTableDescriptor.Columns.Count); // returns 4 - will hold a column descriptor for each field in the fields collection
// Now, add a Expression Field.
ExpressionFieldDescriptor ed = new ExpressionFieldDescriptor("Total", "Total", typeof(double), "[UnitPrice]*[Quantity]");
ed.DefaultValue = string.Empty;
orderDetailsTableDescriptor.ExpressionFields.Add(ed);
// Lets check again the count of each collection:
Trace.WriteLine(orderDetailsTableDescriptor.Fields.Count); // returns 4
Trace.WriteLine(orderDetailsTableDescriptor.ExpressionFields.Count); // returns 1
Trace.WriteLine(orderDetailsTableDescriptor.Columns.Count); // returns 5 - will hold a column descriptor for each field in the fields collection and also a columndescriptor that references the expression field we just added.
Of course, you can also manually initialize the Columns collection. Once you modify a collection, it will not be auto re-initialized anymore.
The following example shows how to add columns that should be displayed in the grid and initializes the width of one column:
GridTableDescriptor categoriesTableDescriptor = (GridTableDescriptor) engine.TableDescriptor;
categoriesTableDescriptor.Columns.Add("CategoryID");
categoriesTableDescriptor.Columns.Add("CategoryName");
categoriesTableDescriptor.Columns.Add("Description");
categoriesTableDescriptor.Columns["CategoryName"].Width = 200;
Now that the Columns collection has been initialized manually, changes in the underlying Fields or ExpressionFields collection will not be reflected. If you now add an ExpressionField to the ExpressionFields collection, you will also need to manually add it to the Columns collection in order to display it in the grid. Suppose you added a "Total" expression to the ExpressionFields collection. You can now add this expression field to the columns collection with:
categoriesTableDescriptor.Columns.Add("Total");
Only then new expression fields will be displayed.
If you want to force re-initialization of a modified collection, you can call the ColumnDescriptorCollection.Reset() method. Once you call Columns.Reset, the columns collection will again auto-populate all fields from the Fields and ExpressionFields collections.
The grid also supports displaying multiple rows per record.
The ColumnSet collection lets you specify a multi-row per record layout in a table. A ColumnSetDescriptor holds one or multiple ColumnSpans. In a GridColumnSpan, you can specify layout information of a column. You ca,n for example, specify that the Address column should be displayed in the grid above City and Region and span these two columns:
GridColumnSpanDescriptor csd1 = new GridColumnSpanDescriptor("Address");
csd1.Range = GridRangeInfo.Cells(0,0,0,1);
GridColumnSpanDescriptor csd2 = new GridColumnSpanDescriptor("City");
csd2.Range = GridRangeInfo.Cells(1,0,1,0);
GridColumnSpanDescriptor csd3 = new GridColumnSpanDescriptor("Region");
csd3.Range = GridRangeInfo.Cells(1,1,1,1);
GridColumnSetDescriptor csd = new GridColumnSetDescriptor("Address_Set");
csd.ColumnSpans.Add(csd1);
csd.ColumnSpans.Add(csd2);
csd.ColumnSpans.Add(csd3);
this.groupingGrid1.TableDescriptor.ColumnSets.Add(csd);
You can also manually initialize the VisibleColumns collection. The name of the GridColumnSetDescriptor identifies the column set descriptor or column in the VisibleColumns collection:
this.groupingGrid1.TableDescriptor.VisibleColumns.Add("Address_Set");
this.groupingGrid1.TableDescriptor.VisibleColumns.Add("Phone");
this.groupingGrid1.TableDescriptor.VisibleColumns.Add("Fax");
A GridVisibleColumnDescriptor only has a Name property. The Name property identifies a ColumnSet or Column with the same name.
Maintains schema information for a table. Collections define columns, column sets, fields, expressions,
sorted, grouped columns, and related tables.
Interface for hosting a .
Notifies the host that properties in the TableOptions object were changed.
Notifies the host that properties in the TableOptions object are about to be changed.
Returns a of the first parent element with table options in the hierarchy.
Returns a
Returns a reference to the this object belongs to.
Determines whether the TableOptions object have been initialized.
Gets the TableOptions.
Initializes a new instance of the class.
Initializes a new class with the specified
instance of the class.
Parent relation.
Initializes a new class with the specified
instance of the and classes.
The grouping engine.
The related child tables of the grouping grid.
Wires the events.
Overrides and dispose the unmanaged resources.
Performs searching in all the columns.
Text to be searched.
Performs searching in User-Specified columns.
Columns where the text has to be searched
Text to be searched
Initializes this object and copies properties from another object.
The source object.
Determines if the summaries were modified.
returns False.
Discards any changes for the object.
Determines if any property has been modified.
True if modified.
Determines if the collection or child objects have been modified from its
default state.
True if the collection was modified.
Resets the collection back to its
default state.
Determines if the collection contains values.
True if not empty; False otherwise.
Clears the collection.
Determines if the collection contains values.
True if not empty; False otherwise.
Clears the collection.
Determines if the collection has been modified from its
default state.
True if it is modified; False otherwise.
Resets the collection back to its
default state.
Determines if the collection has been modified from its
default state.
true if it is modified; false otherwise.
Resets the collection back to its
default state.
Determines if this object is used by the parent control in design-time.
True if it is being used in design-time.
Override this factory method if custom properties should be added to the column descriptor.
You also have to derive GridTableDescriptor and provide a strong typed collection
property.
returns GridColumnDescriptorCollection
Determines if the collection contains values.
True if not empty; False otherwise.
Clears the collection.
Determines if the collection contains values.
True if not empty; False otherwise.
Clears the collection.
Returns the value of if valid. An empty string
if the parent table has no frozen column specified.
The value of .
Returns width specified in TableOptions.RowHeaderWidth if TableOptions.ShowRowHeader is true; 0 otherwise.
Row header width.
Returns width specified in TableOptions.IndentWidth if TableOptions.ShowTableIndent is true; 0 otherwise.
Width of indentation of each group.
Calculates the width of row headers and all indent columns before
the first record column.
Width of row headers and all indent columns
Calculates the width of row headers and all indent columns before
the first record column.
Specifies if width of nested table indents and parent table row headers should be added.
Width of row headers and all indent columns
Returns the number of frozen columns based on the
property.
Number of frozen columns.
Recreates the Summaries collection if fields, columns, or SummaryRows
have changed. Add summaries for calculating the maximum length
of columns in the table.
This method is called to add summaries for those columns where GridColumnDescriptor.AllowFilter
is true. The base class implementation adds a FilterBarChoicesSummary for each column with .AllowFilter set to true.
The collection where new summaries should be added.
Returns the number of indent columns.
If records don't have nested tables, the method returns GroupedColumns.Count+1; otherwise GroupedColumns.Count+2.
Returns the number of grid columns to display in grid.
Number of columns.
Returns the last column index where a record field is displayed.
Last column index.
Converts a column index in a grid to a zero-based number adjusted for column headers (subtracting )
collection.
The column index in the grid.
A zero-based number.
Converts a zero-based number to a column index in a grid adjusted for column headers (adding ).
A zero-based number.
The column index in the grid.
Returns the zero-based index for a column. The resulting
number can be used as an index to look up a in the
collection.
The name of the column to be matched.
A zero-based field number in the collection; -1 if not found.
Searches for the column descriptor with the specified name.
The name of the element to locate in the collection.
The GridColumnDescriptor that matches the name, if found; otherwise, NULL.
The Engine calls this method when schema changes occurred.
Recreates the internal and
if changes were detected in the , ,
or collections.
Returns the relative row and column index in the grid of a column descriptor.
The name of the field descriptor (which is GridColumnDescriptor.MappingName).
Returns the relative zero-based row index; -1 if column was not found.
Returns the relative zero-based column index; -1 if column was not found.
True if column was found; False otherwise.
Used internally.
returns the count of column set
Raises the event.
A that contains the event data.
Determines whether has been modified
and contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Returns the of this element.
Returns the
Returns a of the first parent element with appearance in the hierarchy.
Returns a
Notifies the host that properties in the Appearance object were changed.
Notifies the host that properties in the Appearance object will be changed.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Determines whether were modified
and contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Raises the event.
TableEventArgs that contains the event data
Raises the event.
Event data.
Clears the sortByDisplayMemberCols collection.
Determines if the specified column should be sorted by the DisplayMember.
Default behavior of the method is to return false.
GridGroupingControl overrides this method and checks whether the GridColumnDescriptor
associated with column has its GridColumnDescriptor.SortByDisplayMember
property set to true.
The SortColumnDescriptor.
True if the column should be sorted by the DisplayMember.
Adds the columns which are having display members to the collection.
Initiate sort display member columns.
Gets the that this table descriptor belongs to.
Gets the that this table descriptor belongs to
if it is a child table of a relation; returns NULL if it is the main
table descriptor.
Gets the that the belongs to
if this table descriptor is a child table of a relation; returns NULL if it is the main
table descriptor.
Gets the collection of objects defining relations
to other tables.
The default state of this collection and child objects is auto-populated from relation descriptors
found in the underlying source list for this table.
If you assign a or to ,
the collection is auto-populated from objects
found in the .
Gets or sets a collection from that declares
summary rows each with one or multiple GridSummaryColumnDescriptor elements.
When you assign a GridSummaryRowDescriptorCollection object using this property, the existing collection
object is not replaced. Instead, all properties and elements are copied
from the assigned GridSummaryRowDescriptorCollection object using the method.
The SummaryRows collection contains GridSummaryRowDescriptors. GridSummaryRowDescriptors have a name,
title, and collection of summary columns. A GridSummaryRowDescriptor also has a Read-only
IsFillRow property. If this property is True, the summary should fill the
whole row and not be displayed below individual columns. IsFillRow will return True if
any of the GridSummaryColummDescriptors in the SummaryColumns collection is set to
GridSummaryStyle.FillRow.
The GridSummaryColummDescriptor defines where to display the column in the row.
Essential properties are the name, format, DisplayColumn, DataMember, and
SummaryType. The multiple GridSummaryColumnDescriptor objects
have a name and mapping name that identify the column for which a summary should be
calculated for and a SummaryType property that defines the type of calculations to be performed.
Possible SummaryTypes are: Count, BooleanAggregate, ByteAggregate, CharAggregate, DistinctCount,
DoubleAggregate, Int32Aggregate, MaxLength, StringAggregate, Vector, DoubleVector, and Custom.
When you specify the SummaryType.Custom type, you need to set the custom method through the
CreateSummaryMethod property of the SummaryDescriptor. It is CreateSummaryDelegate and
is called to create an instance of a summary object. You also need to handle the
GridGroupingControl.QueryCustomSummary as demonstrated in the Grid/Grouping/CustomSummaries example.
Gets or sets a collection of objects that declares
StackedHeader rows each with one or multiple GridStackedHeaderDescriptor elements.
An instance of this collection is returned by the property
of a . StackedHeaders allow you to display headers that spread multiple columns
before the regular column headers.
Each group in the GridTable has a GridStackedHeaderSection. The StackedHeader section has as many
rows as there are GridStackedHeaderRowDescriptors. Each GridStackedHeaderRowDescriptor
has a collection of GridStackedHeaderDescriptor columns. The GridStackedHeaderDescriptor
defines the VisibleColumns or ColumnSets for which a combined header should be displayed
before the normal column headers.
If you leave the VisibleColumns collection empty than this header will be used as default
header for all columns that were not explicitly associated with another header.
So, if you want to just add an extra Caption then you could add a StackedHeaderRow
with only one StackedHeader that has an empty VisibleColumns collection.
Gets or sets a collection of columns each referencing
a or .
The order of GridVisibleColumnDescriptors in the collection defines
the left to right order of columns shown in the grid.
When you assign a GridVisibleColumnDescriptorCollection object using this property, the existing collection
object is not replaced. Instead, all properties and elements are copied
from the assigned GridVisibleColumnDescriptorCollection object using the method.
The VisibleColumns collection is auto-populated from the Columns collection and the ColumnSets collection.
When auto-initialized, the VisibleColumns collection adds all GridColumnSetDescriptors from the ColumnSets
collection and also all ColumnDescriptors from the Columns collection that have not been referenced by a
ColumnSpan. So, if you do not specify any column sets, the VisibleColumns collection will have a
GridVisibleColumnDescriptor for each Column with the column's name.
You can also manually initialize the VisibleColumns collection. The name of the GridColumnSetDescriptor
identifies the column set descriptor or column in the VisibleColumns collection.
Gets or sets whether the collection should not be autopopulated. When you set this property true
. will be called. When you set this property false,
will be called.
Gets a collection of columns with mapping information to columns of the underlying datasource.
When you assign a GridColumnDescriptorCollection object using this property, the existing collection
object is not replaced. Instead, all properties and elements are copied
from the assigned GridColumnDescriptorCollection object using the method.
The Columns collection lets you specify the fields that should be displayed in the GridTableControl.
By default, the Columns collection is auto-populated from the underlying Fields, ExpressionFields and UnboundFields
collections and will be a combination of these three collections. When the Columns collection is
auto-populated and you make changes to the above collections, the changes will
automatically be reflected in this collection.
GridColumnDescriptors in the Columns collection have a reference to a FieldDescriptor
(or ExpressionFieldDescriptor).
Additionally, GridColumnDescriptors contain grid-specific information about a column such as the column width.
You can manually set the column width or have it be automatically initialized by the grid to fit the string
with the maximum length in the column's data. GridColumnDescriptor also has an Appearance property. This is
where cell type and formatting of the column can be specified.
Gets or sets a value to enable/disable column appearance deserialization.
Gets or sets whether the collection should not be autopopulated. When you set this property true
. will be called. When you set this property false,
will be called.
Gets or sets a collection from with information
about columns that can spread multiple grid rows or columns.
When you assign a GridColumnSetDescriptorCollection object using this property, the existing collection
object is not replaced. Instead, all properties and elements are copied
from the assigned GridColumnSetDescriptorCollection object using the method.
The ColumnSet collection lets you specify a multi-row per record layout in a table. A ColumnSetDescriptor
holds one or multiple ColumnSpans. In a GridColumnSpan, you can specify layout information of a column.
You can, for example, specify that the Address column should be displayed in the grid above City and Region
and span these two columns.
Gets or sets a collection from which provides filter criteria for displaying a
subset of records from the underlying data source with conditional cell formatting.
When you assign a GridConditionalFormatDescriptorCollection object using this property, the existing collection
object is not replaced. Instead, all properties and elements are copied
from the assigned GridConditionalFormatDescriptorCollection object using the method.
The ConditionalFormats collection has GridConditionalFormatDescriptor objects. The GridConditionalFormatDescriptor
defines filter criteria for displaying a
subset of records from the underlying datasource with conditional cell formatting.
Gets the collection of objects defining summaries
of the table. This collection is maintained automatically by the
and is filled with summaries from the collection. You should not
directly modify this collection. Instead, you should modify .
Each in the collection references
a of the collection. Based
on the summaries defined in this collection, each group in the table will have
summaries calculated.
Freeze columns. Gets or sets the name of a which defines the columns to prevent scrolling.
All columns left of the specified including the column will not be scrollable.
Note: If you set this property for a child table you have to make sure that the column is properly
aligned with the frozen column of the parent table. It is not supported to have a different scroll position
for a nested table. If it is not possible to correctly align the right border of the column in the child
table with the right border of the frozen column of the parent table then you should leave this field blank.
Gets or sets whether the maximum number of characters found in record field cells
should be calculated for columns. See also TableOptions.ColumnsMaxLengthStrategy.
Returns true if any summaries were implicitly created for FilterBar
Returns true if there are columns with .AllowFilter = true and GridFilterBarChoicesEventArgs.ShouldCreateSummaryDescriptor
set to false.
Gets an internal array used for multiple rows per Record and Column to Field Mapping.
Gets an internal array used for multiple rows per Record and Column to Field Mapping.
Occurs for each GridSummaryColumnDescriptor before the is determined. You must handle this event if you specified as .
Gets or sets the default with default
information for all cell elements in the table. This property lets you control almost every aspect of
the appearance of the grouping grid like cell back color, font, or the cell type.
Indicates the grouping grid is wired with excel style filter.
This is specifically used to apply the filter in excel sheet while exporting.
Gets or sets whether the of the table descriptor should
inherit properties of a if this object is the child table
descriptor in a relation.
Occurs for each cell before a
starts painting and lets users customize the display of cells.
Gets the value whether the GroupOptions object has been initialized.
Gets the group options.
Gets or sets the look of inner groups like whether the Caption Row is visible or what CaptionText is.
Gets or sets the look of the top most group like whether the Caption Row is visible or what CaptionText is.
Gets the value indicates whether the TableOptions object have been initialized.
Gets or sets the table-wide properties like the width of the indent column or whether header rows should be visible.
Gets the number of rows that should be added to each record.
Gets the number of preview rows that should be added to each record.
GridVisibleColumnDescriptor references a or .
The order of GridVisibleColumnDescriptors in the collection defines
the left to right order of columns shown in the grid.
Columns are managed by the that
is returned by the property
of a .
Disposes the unmanaged resources.
Determines if this object was modified.
returns the boolean value false.
Gets the descriptor name.
Descriptor name.
Initializes a new column.
Initializes a new empty column.
Initializes a new column with a name.
Descriptor name.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Creates a new object that is a copy of the current instance.
A new object that is a copy of this instance.
Creates a copy of this descriptor.
A copy of this descriptor.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Returns a string holding the current object.
String representation of the current object.
The collection this descriptor belongs to.
The TableDescriptor that this descriptor belongs to.
Occurs when a property is changed.
Occurs before a property is changed.
Used internally.
Gets or sets the mapping for this column. You should specify which (by it's Name property)
or you want to display in the grid at this column.
The type converter for objects.
is a . It overrides the default behavior of the
method and adds support for design-time code serialization.
Initializes the new instances for GridVisibleColumnDescriptorTypeConverter.
Determines if the current object can be converted to the specified type.
Format context.
The type you want the object to convert to.
True if this conversion is possible.
Converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Gets a collection of properties for the specified type.
Format context.
Value specifying the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
A collection of columns each referencing
a or .
The order of GridVisibleColumnDescriptors in the collection defines
the left to right order of columns shown in the grid.
An instance of this collection
is returned by the property
of a .
A Read-only and empty collection.
When called the ShouldPopulate property will be set true temporarily until
the next EnsureInitialized call and then be reset again to optimize subsequent lookups.
The Engine calls this method when schema changes occured (PropertyChanged was raised).
Initializes a new empty collection.
Initializes a new empty collection.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Resets the collection to its default state. If the collection is bound to a ,
the collection will auto-populate itself the next time an item inside the collection is accessed.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Marks the collection as modified and avoids auto-population.
Resets the collection to its default state, auto populates it, and marks it
as modified. Call this method if you want to load the default items for the collection and then
modify them (e.g. remove members from the auto-populated list).
gridGroupingControl1.TableDescriptor.VisibleColumns.LoadDefault();
gridGroupingControl1.TableDescriptor.VisibleColumns.Remove("MyChildTable.ForeignCategoryID");
Adds multiple elements at the end of the collection.
The array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Determines if the element belongs to this collection.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls .
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The name of the element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Moves an element within the collection.
The original index of the element within the collection.
The target index of the element within the collection
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Adds an object to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Adds an object to the end of the collection.
The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the specified descriptor element with the specified name from the collection.
The name of the element to remove from the collection. If no element with that name is found
in the collection, the method will do nothing.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes the unmanaged resources.
Removes all elements from the collection.
Returns an array of columns that affect the width of the table in the grid.
An array in the same order as the returned array with
width factors indicating the number of grid columns spanned by a column descriptor.
An array of columns that affect the width of this column set. Each column
will also have a width factor returned through the array.
Returns an array of columns that affect the width of this table in the grid
for a specific column set only.
The column name.
The int array factor.
returns array of GridColumnDescriptor
Raises the event.
An that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Inserts an item to the System.Collections.IList at the specified index.
The zero-based index at which value should be inserted.
The object to insert into the System.Collections.IList.
Removes the first occurrence of a specific object from the .
The object to remove from the System.Collections.IList.
Determines whether the System.Collections.IList contains a specific value.
The object to locate in the System.Collections.IList.
true if the System.Object is found in the System.Collections.IList; otherwise,false.
Determines the index of a specific item in the System.Collections.IList.
The object to locate in the System.Collections.IList.
The index of value if found in the list; otherwise, -1.
Adds an item to the System.Collections.IList.
The object to add to the System.Collections.IList.
The position into which the new element was inserted, or -1 to indicate that
the item was not inserted into the collection.
Copies the elements of the System.Collections.ICollection to an System.Array,
starting at a particular System.Array index.
The one-dimensional System.Array that is the destination of the elements
copied from System.Collections.ICollection. The System.Array must have zero-based
indexing.
The zero-based index in array at which copying begins.
Returns a string that represents the current object.
A string that represents the current object.
Suggest the mapping name for column.
Gets or sets whether collection should check for changes
in engine schema or underlying data source schema when EnsureInitialized gets called.
Gets the Grid Engine of table descriptor.
Gets the table descriptor this collection belongs to.
Gets or sets whether the collection is manipulated inside a collection editor.
Gets the version number of this collection. The version is increased each time the
collection or an element within the collection was modified. When getting the version,
is called to ensure the collection is auto-populated
if needed.
Gets or sets whether the collection is modified from its default state.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Returns False if the collection is Read-only.
Returns normally False since this collection has no fixed size. Only when it is Read-only
IsFixedSize returns True.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls .
Occurs when the grid is recalculating the total horizontal width of the table inside the grid.
Gets the total horizontal width of the table inside the grid.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Gets or sets the element at the specified index.
The zero-based index of the element to get or set.
The element at the specified index.
Gets an object that can be used to synchronize access to the System.Collections.ICollection.
Enumerator class for elements of a .
Initializes the enumerator and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Represents a method that handles an event with .
The source of the event.
The event data.
Provides data for event.
The GridEngine.QueryAddVisibleColumn event affects the auto-population of the GridVisibleColumnDescriptorCollection.
It is called for each column and lets you control at run-time if the column should be added to the
GridVisibleColumnDescriptorCollection. You can set e.Cancel = True to avoid specific columns
being added.
Initializes the event args
The table descriptor.
The column.
Gets the TableDescriptor
Get the Visible column of Grid table descriptor.
Customized collection editor form.
Initialize a new instance of the class.
To load the rule collection editor form
The source control.
The contains event data.
Raised when listBox selected Index was changed.
The source control.
The contains event data.
Initialize new instance for class.
The contains descriptor properties.
Apply the NeagativeBar FillStyle based on comboBox selected items.
The source control.
The contains event data.
Apply the PositiveBar FillStyle based on comboBox selected items.
The source control.
The contains event data.
Determine whether fill negative bar as same like positive.
The source control.
The contains event data.
Overridden to change the ToString method.
Determine the calculation of Minimum and maximum values.
The source control
The contains data.
Determine the dataBar drawing direction.
The source control
The contains data.
Add the conditionalFormatCollection to the conditionalFormatDescriptor.
The source control
The contains data.
Get the name of collection.
New collection object
Returns the collection name.
Applies the rule to ConditionalCormatDescriptorCollection.
The source control.
The contains event data.
Set the dataBar values to the form controls.
The contains the data bar properties.
Saves the currently edited values to the
The that contains property.
Moves the currently selected item upwards when button clicked.
The source control
The contains data.
Moves the currently selected item downwards when button clicked.
The source control
The contains data.
Move the listBox item based on direction passed.
The direction determines listBox move.
Removes the item from listBox.
The source control
The contains data.
Save the column name when testBox text changed.
The source control
The contains data.
Close the dialog.
The source control
The contains data.
Determines the axisBar position.
The source control
The contains data.
Set the negative bar border color.
The source control
The contains data.
Set the negative bar solidFill color.
The source control
The contains data.
Set the negative bar GradientFillcolor1 color.
The source control
The contains data.
Set the negative bar GradientFillcolor2 color.
The source control
The contains data.
Set the positive bar border color.
The source control
The contains data.
Set the positive bar solidFill color.
The source control
The contains data.
Set the positive bar GradientFillcolor2 color.
The source control
The contains data.
Set the positive bar GradientFillcolor2 color.
The source control
The contains data.
Set the minimum valu of DataBar
The source control
The contains data.
Set the maximum valu of DataBar
The source control
The contains data.
Convert the maximum and minimum value for databar
text value of Maximum or Minimum
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Get the collection count.
Occurs when the current instance gets modified.
The Control.
The modified instance.
Builds the action lists in the grid.
Trigged when the designer window gets focus.
The Control.
The contains the event data.
Overrides and initializes the components.
Triggered when the selection gets changed.
The Control.
The contains the event data.
Triggered when the selection is changing.
The Control.
The contains the event data.
Overrides and manages the unwanted resources.
If True then the object is being disposing; Otherwise False.
Overrides and filters the properties.
The properties of the class of the component.
Overrides and initializes the new component.
A name/value dictionary of default values to apply to properties. Null value id specified if the values are not applied.
Overrides and create the handle.
Triggered when the handle gets destroyed.
The Control.
The contains the event data.
Overrides and process the system messages.
The message to be processed.
Refreshes the property browser.
Triggered when the property values are changing.
The Control.
The contains the event data.
Triggered when the property value gets changed.
The Control.
The contains the event data.
Triggered when the components gets changed.
The Control.
The contains the event data.
Gets the data set.
The list values.
The data source to be associated.
Forces the updates to be done immediately whenever there is a change in property values or any events had triggered.
Gets the data associated with the specified component.
The component with which the data is associated.
The instance of the contains the instance data.
Gets the adapter from the data table.
The instance associated with the data adapter.
The instance of the class.
Forces the updates whenever there is a change in the data adapter associated with the grid.
Triggered when the component had added.
The Control.
The contains the event data.
Triggered when the component gets removing.
The Control.
The contains the event data.
Triggered when the component is getting change.
The Control.
The contains the event data.
Triggered when the component is getting add.
The Control.
The contains the event data.
Triggered when component is removed.
The Control.
The contains the event data.
Triggered when the component is renamed.
The Control.
The contains the event data.
Triggered when the data source associated with the grid gets changed.
The Control.
The contains the event data.
Displays the preview dialog.
Display the exception dialog.
The data adapter associated with the grid.
The datasource to be assigned to the grid.
The instance of the that provides the UserInterface.
The dialog input from the user.
The instance of the that contains the exception information.
Triggered when the property value gets changed.
The Control.
The contains the event data.
Triggered when the preview dialog is being displayed.
The Control.
The contains the event data.
Triggered when the preview dialog is shown.
The Control.
The contains the event data.
Applies the look and feel.
The instance class to read the XML file.
The info regarding the XML file.
The description associated with the file to undo the changes.
Applies the schema.
The instance class to read the XML file.
The info regarding the XML file.
The description associated with the file to undo the changes.
Triggered when the preview is to be shown.
Triggered when the copy schema is selected.
Triggered when the save schema is selected.
Triggered when the schema is chosen.
The Control.
The contains the event data.
Triggered when the schema is pasted.
The Control.
The contains the event data.
Triggered when the copy look and feel is selected.
The Control.
The contains the event data.
Triggered when the save look and feel is selected.
The Control.
The contains the event data.
Triggered when the choose look and feel is selected.
The Control.
The contains the event data.
Triggered when the paste look and feel is selected.
The Control.
The contains the event data.
Broadcasts the changed components.
Gets the list of actions performed in the grid's designer window.
Gets or sets the data source value.
Gets or sets the data member value.
Gets the designer host.
Gets a value indicating whether the container have the data adapter or not.
Gets the value of the data adapters.
Gets a value indicating whether the container has a data set or not.
Gets the values of the designer verbs.
Defines the class that implements the action list in the designer window of the grid.
Initializes the new instance of the class with the specified instance of the class.
An instance of the that gets associated with the action lists.
Overrides and triggered to get the sorted action list items.
Gets or sets the data source associated with the grid.
Gets or sets the data member associated with the grid.
Defines a class that implements the action verb list in the designer window of the grid.
Initializes a new instance of the class with the specified instance of the class.
The instance of the class associated with the grid designer window.
Overrides and triggered to get the sorted action list items.
The sorted items from the collection.
Gets a value indicating whether to automatically show or not.
Defines a class that implements the action verb items in the designer window of the grid.
Initializes a new instance of the class with the specified verb of the designer window.
The verb item of the designer window.
Overrides and invokes the target verb.
Gets the category values of the verbs.
Gets the description of the verb.
Gets the display name of the verb.
Gets a value indicating whether to include as a designer verb or not.
Gets the member name.
Defines a class that supports the actions performed in the designer window of the grid.
Returns the collection of objects contained in the list.
A array that contains the items in this list.
Override
Gets or sets the GridVisualStyles themes to the grid.
Gets or sets the key word value to be searched.
Gets or sets the search options.
Gets the grouping grid control.
Defines the constants that specify the available search options.
Represents Syncfusion.
Represents Forums.
Represents KnowledgeBase.
Represents a class that provides support for GridGroupingControlPreviewForm.
Required designer variable.
Delays the refresh time-taken of the property grid.
Time interval in ms.
Delays the refresh time-taken of the property grid.
The Control.
The contains the event data.
Refreshes the property grid.
Refreshes the grid with a time interval of 50 ms.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Overrides and manages the unwanted resources.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Triggered when the event is done.
The Control.
The contains the event data.
Sets the property info.
The newly selected item.
Overrides and triggers the event is done.
The contains the event data.
Overrides and triggered when the event is done.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Gets the Property GridGroupingControl1 (GridGroupingControl)
Defines a class that implements the grid table properties in the designer window.
Initializes a new instance of the class.
The display name.
The table descriptor property values.
The array of attribute values.
Determines whether the component will allow its value to be reset or not.
The component to reset.
true if the component supports resetting its value.
Retrieves the value of the property for the given component. This will
throw an exception if the component does not have this property.
The component.
the value of the property on comp. This can be casted
to the property type.
Resets the value of this property on comp to the default value.
The component whose property is to be reset.
Sets the value of this property on the given component.
The component whose property is to be set.
The new value of the property.
Determines if this property should be persisted. A property is
to be persisted if it is marked as persistable through a
PersistableAttribute, and if the property contains something other
than the default value. Note, however, that this method will
return true for design time properties as well, so callers
should also check to see if a property is design time only before
persisting to runtime storage.
The component on which the property resides.
true if the property should be persisted to either
design time or run time storage.
Retrieves the type of the component this PropertyDescriptor is bound to.
the type of component.
Retrieves the display name of the property. This is the name that will
be displayed in a property browser. This will be the same as the property
name for most properties.
a string containing the name to display in the property browser.
Determines if the property can be written to.
true if the property can be written to.
Retrieves the data type of the property.
a class representing the data type of the property.
Defines a class that provides the predefined switches for enabling or disabling trace
output or code instrumentation in the Syncfusion shared library.
Initializes a new instance of the class.
Defines an abstract base class used by and .
It implements the interface
to be used with and provides common functions for hit-testing and drag and drop
functionality used by both derived classes.
Clears out pending state of ClickCellsController, possibly sending MouseHoverLeave or CancelMode
notification to cell renderer.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class with the specified instance of the class.
The instance of the class.
Gets the grid table control which is bound to the group drop area.
The instance of the class.
Determines a value indicating whether the mouse position of removing cursor should be shown or not.
True if remove cursor should be shown; Otherwise False.
Determines a value indicating whether the mouse over event is performed on the group drop area or not.
True if mouse is over GroupDropArea; Otherwise False.
Determines a value indicating whether the mouse button had clicked or not.
A contains the event data.
True if the mouse button is clicked; Otherwise False.
Gets the range value of column header section. Gets null if there is no column headers.
The range value of column header section.
Gets column descriptor under the mouse position. Gets null if there is no header drawn below mouse.
The column descriptor.
Determines a value indicating whether the transparent form is supported or not.
True if transparent form is supported; Otherwise False.
Displays the red arrow indicator.
True if the group drop area is visible; Otherwise False.
Clears the red arrow indicator.
Clears the red arrow.
An instance of the instance that draws the red arrow.
Creates a red arrow bitmap.
The size of the bitmap to be drawn.
The bitmap image of the red arrow.
Determines a value indicating whether on mouse position the red arrow indicator should be shown or not.
True if it should be shown; Otherwise False.
Gets the red arrow indicator location. Used internally.
True if the position is in group drop area.
The instance of the class that gets associated with the grid.
The point value.
Creates the red arrow indicator and update the location of red arrow indicator to show while dragging. Internal only.
Gets the mouse position.
The point values.
Determines a value indicating whether the bitmap for dragging should be shown or not. Used internally.
If True then the bitmap is displayed; Otherwise False.
Gets the drag window location.
The point values of the screen location.
The location point of the drag window.
Opens the drag header.
True if the column header is an indent column; Otherwise False.
Closes the drag header.
Updates the drag header.
Creates the bitmap for the drag header.
The instance of the class that is associated with the drag header.
The row index.
The column index.
If True then the row height is re-calculated to adjust the blur image; Otherwise False.
The bitmap image.
Used Internally to process BorderColor of bitmap.
Gets the bitmap to be processed
bitmap
Gets the current touch or mouse position
Returns the LastMousePosition when the SkipPanning for the control or GroupDropArea is true, otherwise returns the mouse position
Determines a value indicating whether the allow fixfocus is enabled or not.
Returns False.
Triggered before the first time MouseHover is called.
Triggered after the event is done.
A contains the event data.
Triggered when the mouse hover ends either the user dragged mouse out of the hit-test area or
when context changes (e.g. user pressed the mouse button).
An contains the event data.
Triggered when the event is done and the controller signaled in HitTest that it wants to handle mouse events pressed by the user..
A contains the event data.
Triggered when the event is done for the active controller after a MouseDown message when the user moves the mouse pointer.
A contains the event data.
Triggered when the event is done for the active controller after a MouseDown message when the user releases the mouse button.
A contains the event data.
Triggered when the current mouse operation is canceled.
HitTest is called to determine whether your controller wants to handle the mouse events based current context.
A contains the event data.
A that has indicated to handle the mouse event.
A non-zero value if the button can and wants to handle the mouse event; 0 if the
mouse event is unrelated for this button.
Gets the which is used to forward mouse events
to cell renderers.
Gets the instance of the for the current object.
Gets the instance of the associated with the grid.
Gets the instance of the associated with the grid.
Gets the instance of the associated with the grid.
Gets or sets a value indicating whether the drag header should be visible or not. Used internally.
Returns boolean value to indicate drag header visible.
Creates the DragWindow while dragging and closes the DragWindow while dropping.
Gets the name of the mouse controller.
Gets the cursor to be displayed.
Defines a class that provides the mouse controller support for dragging column headers within the
or dragging them to the .
Initializes a new instance of the class specified with the grid it operates on
The instance of the class associated with the mouse controller.
Overrides and triggered when the is done and this controller signaled in HitTest that it wants to handle mouse events pressed by the user.
A contains the event data.
Overrides and triggered when the event is done for the active controller after a MouseDown message when the user moves the mouse pointer.
A contains the event data.
Determines a value that indicates whether to allow group by column or not.
The field index of the red arrow.
This method is to check whether the RedArrow is necessary to display.
If last column is been added in GroupDropArea which is already present, then there is no need to update the Red Arrow.
The condition in this method will check whether the last column is been repeated.
Overrides and triggered when the event is called for the active controller after a MouseDown message when the user releases the mouse button.
A contains the event data.
Overrides and performs the CancelMode operation when the current mouse operation is canceled.
Overrides and HitTest is called to determine whether your controller wants to handle the mouse events based current context.
A contains the event data.
A that has indicated to handle the mouse event.
A non-zero value if the button can and wants to handle the mouse event; 0 if the
mouse event is unrelated for this button.
Triggered to apply the custom formatting options.
The Control.
The class.
Defines a class that implements the group drag header's hit test.
Initializes a new instance of the class with the specified grid and the drag header's position value.
The instance of the class that is associated with the drag header.
The location of the drag header.
Defines a class that provides support for dragging headers from the GroupDropArea.
Initializes a new instance of the class specified with the instance of the class.
The group drop area.
Overrides and gets the grid associated with the grid.
An instance of the class.
Creates the header bitmap image.
The row index.
The column index.
The bitmap image.
MouseDown is called when this controller signaled in HitTest that it wants to handle mouse events and the
user pressed the mouse button.
A contains the event data.
MouseMove is called for the active controller after a MouseDown message when the user moves the mouse pointer.
A contains the event data.
MouseUp is called for the active controller after a MouseDown message when the user releases the mouse button.
A contains the event data.
CancelMode is called for the active controller after a MouseDown message when the mouse operation is canceled.
HitTest is called to determine whether your controller wants to handle the mouse events based current context.
A contains the event data.
A that has indicated to handle the mouse event.
A non-zero value if the button can and wants to handle the mouse event; 0 if the
mouse event is unrelated for this button.
Will return the value true if the colIndex sent is of Header type. Otherwise false.
This method is used to check whether the clicked column is header or not for Left or Right Alignment.
Will return true if the row index is an header and the not equals than 2. Otherwise false.
Defines a class that implements the helper methods of the drag window. Used internally.
Initializes a new instance of the class. Used internally.
Starts the dragging process. Used internally.
Starts to drag the drag window and displays it in the destination location..
Ensures the drag cursor. Used internally.
The enumerator hold the dropping effect.
Stops the drag operation. Used internally.
Drags the group to the specified point.
The specified point.
Specifies the effects of a Drag-Drop operation.
Cancels the dragging process.
Stops the dragging process.
Disposes the current object.
Gets the drag window. Used internally.
Gets the last drop effect of the drag window. Used internally.
Specifies the possible effects of drag-drop operation.
Gets a value indicating whether dragging is still in completion or not. Used internally.
Returns boolean value to indicate the header is in dragging or not.
Defines a class that implements the drag window. Used internally.
Initializes a new instance of the class. Used internally.
Moves the dragging to the specified point location.
The destination point.
Determines a value that indicates whether to start the dragging or not. Used internally.
The specified starting point value.
If True dragging takes place; Otherwise False.
Determines a value that indicates whether to move to the specified point location or not. Used internally.
The specified destination location point value.
If True the location gets changed; Otherwise False.
Determines a value that indicates whether to stop dragging or not. Used internally.
If True stops dragging; Otherwise False.
Overrides and manages the unwanted the resources.
If True then the Dispose() method is called for the clean-up; Otherwise False then the finalizer is called for clean-up.
Gets or sets the bitmap image for the dragging header. Used internally.
Defines an abstract base class used by and .
It implements the interface
to be used with MouseControllerDispatcher and provides common functions for hit-testing and drag and drop
functionality used by both derived classes.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class specified with the instance of the class.
The table control associated with dragging stacked headers.
Returns the grid it is bound to.
The GridTableControl
Clears out pending state of ClickCellsController, possibly sending MouseHoverLeave or CancelMode
notification to cell renderer.
Determines a value that indicates whether the mouse buttons are clicked or not.
A contains the event data.
If True the mouse buttons are clicked; Otherwise False.
Gets the range of stacked headers.
The range value of the stacked header cell.
The stackedHeaderSpan descriptor under the mouse position. Will be null if there is no header drawn below mouse.
The instance of the at the specified point.
Determines a value indicating whether the drag window should be transparent or not.
True if the drag window is transparent; Otherwise False.
Opens the red arrow indicator for the drag window.
Closes the red arrow red arrow indicator.
Creates the red arrow indicator.
The bitmap image.
Draws the red arrow indicator.
The instance of the class.
Triggered to paint the drag window.
The Control.
The contains the event data.
Determines a value whether to show red arrow indicator or not.
True if the indicator should be shown; Otherwise False.
Gets the red arrow indicator location. Used internally.
The instance of the class that is associated with the drag window.
The point values of the red arrow indicator.
Updates the red arrow indicator. Used internally.
Gets the movement delta.
returns the point
Determines a value indicating whether to show the dragger bitmap or not. Used internally.
True then the bitmap is displayed; Otherwise False.
Gets the drag window location.
The drag window location in the screen.
The point values of the location.
Opens the drag header.
Closes the drag header.
Updates the dragged header.
Creates the bitmap image for the stacked header cell.
The instance of the class associated with the stacked header.
The row index.
The column index.
Gets a value indicating whether to allow fix focus or not.
Returns False.
Triggered before the first time MouseHover is called.
Triggered after MouseHoverEnter is called.
A contains the event data.
Triggered when hovering ends either because user dragged mouse out of the hit-test area or
when context changes (e.g. user pressed the mouse button).
An contains the event data.
Triggered when the event is done and the controller signaled in HitTest that it wants to handle mouse events and the
user pressed the mouse button.
A contains the event data.
Triggered when the event is done for the active controller after a MouseDown message when the user moves the mouse pointer.
A contains the event data.
Determines a value that indicates whether to show the remove cursor or not.
Triggered when the event is done for the active controller after a MouseDown message when the user releases the mouse button.
A contains the event data.
CancelMode is called for the active controller after a MouseDown message when the mouse operation is cancelled.
HitTest is called to determine whether your controller wants to handle the mouse events based current context.
A contains the event data.
A that has indicated to handle the mouse event.
A non-zero value if the button can and wants to handle the mouse event; 0 if the
mouse event is unrelated for this button.
Triggered to set custom style formatting.
The Control.
The contains the event data.
Gets the grid table control.
Gets the which is used to forward mouse events
to cell renderers.
Gets the table property values associated with the grid.
Gets table associated with the grid.
Gets or sets a value indicating whether the drag header should be visible or not. Used internally.
Returns boolean value to indicate drag header visible.
creates the DragWindow while dragging and close the DragWindow while dropping.
Gets the name of the mouse controller.
Gets the cursor value to be displayed.
Defines a class that provides the support to Hit-test for dragging stacked headers.
Initializes a new instance of the class with the specified instance of the at the specified point.
The instance of the class.
The specified point value.
Represents a control class that implements a drop area for groups control which is bound to a .
It lets the user to drag and drop column headers into its bounds and change the
at runtime.
To identify whether Back color is set for GridGroupDropArea
To identify whether Text color is set for GridGroupDropArea
To identfy whether touch panning is disabled or not
Disposes of the resources.
Processes Windows messages and optionally routes them to the control.
The contains the event data.
Overrides and triggered before painting is done.
The contains the event data.
Overrides an refreshes the model. Used internally.
Initializes a new instance of the class withe the specified instances of the and classes.
The instances of the class.
The instances of the class.
Overrides and triggered when the back color of the group drop area had changed.
The contains the event data.
Overrides and triggered when the fore color of the group drop area had changed.
The contains the event data.
Overrides and triggered when the parent control's fore color is changed.
The contains the event data.
Gets the column header description at the specified point. Used internally.
The point value specified at the column header.
The instance of the column header descriptor.
Used to decide to do the selection or dragging or resizing operations based on touchController.
touch position when panning operation start
return false when do other operations like selection, dragging and resizing
Handles the Resize,Selection,Dragging or the panning operations based on the touch controller.
Current touch position
used to decide the swipe scrolling operation occurs
Returns false if do the resize, dragging and selection process otherwise return true
Initialize the mouse up method when resize or dragging or selection process done, otherwise call the base method
touch control end point
Return false when resizing or selection or dragging process done
Overrides and triggered when the mouse down event is done.
The contains the event data.
Overrides and triggered when the mouse move event is done.
The contains the event data.
Overrides and triggered when the mouse enter event is done.
The contains the event data.
Wires the model to the parent.
Unwires the model from the parent.
Initialize the layout.
Overrides and triggered when the paint event is done.
The contains the event data.
Overrides and draws the TreeLines.
To apply color to paint the Treelines
Handler to draw the TreeLines
The contains the event data.
Overrides and triggered when the grid cell is clicked.
The contains the event data.
Overrides and refreshes the grid.
If True, then refresh is done from the parent; Otherwise False.
Determines a value indicating whether to serialize the font in the grid or not.
True, if the grid has a font value and serialization takes place; Otherwise False.
Gets or sets the color of the TreeLines.
Gets or sets the TreeLinePlacement in the GroupDropArea.
Gets or sets a value indicating whether the should support removal of Groups dynamically.
Gets or sets a value indicating whether to resize the dynamically or not.
Not applicable if has multiple .
Gets the instance of the that hosts this control.
Gets a value indicating whether the parent control is in designer mode or not.
Gets or sets the Vertical scrollbar behavior. Used internally.
Gets or sets the Horizontal scrollbar behavior. Used internally.
Gets or sets the model part of the Group drop area. Used internally.
Gets or sets the Font in the grid.
Gets or sets the "Drag a column header here to group by that column." text that
is displayed when no columns were added to GroupDropArea.
Implements the model or data part of the group drop area. Used internally.
Overrides and returns the string value of the current instance. Used internally.
A containing the name of the , if any, or null if the is unnamed.
Overrides and manages the unwanted resources.
True, if the method call is from the parent; Otherwise False then, the call is from the Finalizer.
Initializes a new instances the class with the specified instance of the class. Used internally.
Triggered to set the custom model properties in the grid.
The Control.
The contains the event data
Wires the table with the grid.
Unwires the table from the grid.
Applies themes to Office scrollbars to GridGroupDropArea.
Theme to be applied.
Determines a value indicating whether the specified column index is a header or not.
The column index.
True, if the specified column index is a header; Otherwise False.
Sets the text color to the group drop area based on the theme applied.
Used Internally.
Style of the GridGroupDropArea Cells.
Sets the backcolor for GroupDropArea based on themes applied. Used Internally.
Style of the GridGroupDropArea Cells
Gets the field index from the specified column index. Used internally.
The column index.
The field index.
Gets the Highest grouped column.
An instance of the contains the event data.
Index of Highest Group drop area.
Gets the column index from the field index. Used internally.
The field index.
The column index.
Gets the column header descriptor at the specified row and column index. Used internally.
The row index.
The column index.
An instance of the contains the event data.
Gets the header column descriptor at.
The GridRangeInfo cell.
Returns the GridColumnDescriptor.
Gets the column index of the specified column descriptor item.
Used internally.
The GridColumnDescriptor.
Returns the column index.
Gets the range span of the specified column descriptor item.
Used internally.
The GridColumnDescriptor.
Returns the GridRangeInfo of the specified column descriptor item.
Checks the header type and border of the GroupDropArea
Gets the style for the header in GroupDropArea to the current object.
Provides the style values.
The applied style.
Triggered when the event is done.
The contains the event data.
Checks whether the touch mode is true and Image in Header is applied and will return the
column width of the GroupDropArea.
Column index.
True is touch mode is enabled.
The contains the event data.
The specified column width.
Gets the total Text Width of given string.
String to find width.
Text font.
Width of text.
Performs the column resizing operation.
Used internally.
Triggered when the event is done.
The contains the event data.
Checks whether TouchMode is true and will return the height of the row.
True if TouchMode is enabled; Otherwise False.
The row height.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Triggered when the event is done.
The Control.
The contains the event data.
Gets the grid table's model. Used internally.
Gets or sets the instance of the class. Used internally.
Gets or sets the Grid table.
Gets a value indicating whether the grid model have a table or not. Used internally.
Gets the scale factor based on current DPI.
Implements the data or model part of a grouped column header with sort indicator.
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instance of the class with the specified grid.
Initializes a new instance of the class with the specified grid.
The for this cell model.
You can typically access cell models through the
property of the class.
Initializes a new instance of the class from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Overrides and gets the formated string for the specified object.
An instance of the that holds the values of style properties.
The value to be formatted.
The textInfo is a hint who is calling, default is GridCellBaseTextInfo.DisplayText.
The formatted text for the gives value.
Creates a renderer for this cell model.
The grid control.
An instance of the class.
Calculates the preferred size of the cell based on its contents without margins and any buttons.
The context of the canvas.
The row index.
The column index.
An instance of the that holds the values of style properties.
Graphical bounds of the cell.
The optimal size of the cell.
Implements the Data or model part for grouped header cell renderer.
Initializes a new instance of the class wit the specified instance of the and classes.
An instance of the class.
An instance of the class.
Overrides and triggered the event is done.
Row index.
Column index.
The contains the event data.
Overrides and triggered when the MouseHover leave event ends.
Row index.
Column index.
The contains the event data.
Overrides and gets the cursors.
Row index.
Column index.
Cursor indication.
Overrides and draws the display text.
The instance of the class.
The inner bounds of the cell.
Row index.
Column index.
An instance of the that holds the values of style properties.
Determine the mouse down events.
Row index
Col index
Event args
Determine the draw cell button.
Draw cell button
Graphics
Row index
Col index
Active
Style
Overrides and raises the rectangle layout.
Row index.
Column index.
An instance of the that holds the values of style properties.
Inner cell bounds.
Buttons bounds.
The layout cell bounds.
Overrides and triggered on button click.
The clicked button.
The column index.
The row index.
Triggered when the event is done if the user presses the PushButton.
The row index.
The column index.
Defines the model or data part of a drop-down ListControl-like grid.
You can typically access cell models through the
property of the class.
A can serve as model for several
instances if there are several views for a .
See for more detailed information about this cell type.
Initializes a new instance of the class.
Initializes a new instance of the class.
and stores a reference to the this cell belongs to.
The for this cell model.
You can typically access cell models through the
property of the class.
Initializes a new instance of the class from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Creates a cell renderer for this cell model.
The grid control base.
An instance of the class.
Overrides and gets the formatted text for the value of the current instance with the specified style format.
An instance of the that holds the values of style properties.
Cell value to be formated.
TextInfo is a hint of who is calling, default is GridCellBaseTextInfo.DisplayText.
The formatted text.
Defines the renderer part of a drop-down ListControl-like grid that lets users drop-down a grid
with information about a related foreign key table that was set up using a RelationKind.ForeignKeyReference,
RelationKind.ListItemReference or RelationKind.ForeignKeyKeyWords relation.
Initializes a new instance of the class for the given
and .
The that displays this cell renderer.
The that holds data for this cell renderer that should
be shared among views.
References to ,
and will be saved.
Overrides and manages the unwanted resources.
Resets the dropdown table control.
Triggered when the relation property value gets changed.
The Control.
The class instance that holds the list changed property values.
Overrides and ensures the list control in the drop down list.
Overrides and creates the grid that should to be displayed in the drop-down window.
A to be placed in the drop-down container.
Overrides and triggered to initialize the drop down list.
The column index.
The row index.
Initializes the instance of the class.
Overrides and draws the drop down list.
The instance of the class.
The rectangle bounds of the drop down list.
The row index.
The column index.
An instance of the that holds the values of style properties.
Overrides and synchronizes the display text.
The index value of the display text.
Overrides and determines whether the event is processed by the cell renderer or not for scrolling the drop down list.
A contains the event data.
True if the parent grid should not be scrolled; False otherwise.
Overrides and triggered when the popup child is dropped down and made visible.
The Control.
The contains the event data.
Overrides and triggered when event is done in the list box and closes the drop-down.
The Control
The contains the event data.
Overrides and processed when the DropDown container closes the drop down list.
The Control.
The contains the event data.
Triggered when the drop down is getting display.
Overrides and triggered when the drop down container gets changed.
The Control.
The contains the event data.
Allows custom formatting of a cell by changing its style object.
The contains the event data.
Gets the primary key value.
The primary key value for the specified record.
The primary key value.
Overrides and sets the control text.
The text to be specified.
Applies the primary key value.
The value to be applied.
Overrides and triggered from after event has been
fired. The default version checks if the active text fits any criteria as specified
in the style object: It can be parsed into a cell value and meets criteria.
True if the modified text is valid; False otherwise.
Displays the table control.
If True, the dropdown is displayed; Otherwise False.
Sets the modify button's style depending upon the theme applied.
The button control.
The applied theme.
Sets the dropdown style depending upon the theme applied.
The close button control.
The select button.
The dropdown panel.
The applied style.
Ensures the dropdown for the table.
The dropdown for the specified table.
Overrides and initializes the drop down container.
Triggered when the modify button is clicked.
The Control.
The contains the event data.
Triggered when the table group gets collapsed.
The Control.
The contains the event data.
Triggered when the group gets expanded.
The Control.
The contains the event data.
Sets the auto-height for the drop down grid table.
Triggered when the current record getting modified.
The Control.
The contains the event data.
Applies custom style formats to the drop down table.
The Control.
The contains the event data.
Applies the custom style formats to the dropdown list.
The Control.
The contains the event data.
Triggered when the close button is clicked in the dropdown container.
The Control.
The contains the event data.
Triggered when the select button is clicked in the dropdown container.
The Control.
The contains the event data.
Gets the that this cell renderer belongs to.
Gets the that this cell renderer belongs to.
Gets the reference to the modify button displayed in the top right corner of the dropdown grid
when the underlying table is editable.
Represents class that implements the dropdown list control. Used internally.
Overrides and creates an instance of the class.
An instance of the class.
Implements the Data or model part of the list control used in dropdown container. Used internally.
Initializes a new instance of the class.
Gets the table associated with the class. Used internally.
The table values in grouped type records collection.
Defines a class that provides a with the specified list-control model. Used internally.
Initializes a new instance of the class. Used internally.
Gets the table values associated with the class. Used internally.
The Grouping table.
Defines a helper class for drawing and caching bitmaps from the DataBound.Resources folder of the Grid assembly
The bitmaps are loaded from the manifest and cached. The PaintIcon routine
will substitute black pixels of the original bitmap and draw them with a
specified forecolor.
Example:
GridGroupingBitmaps.IconPainter.PaintIcon(g, rect, Point.Empty, bitmapName, Color.Black);
Initializes a new instance of the class.
Gets the value of the icon painter.
Gets the bitmap of red colored down arrow while moving columns.
Gets the bitmap of red colored up arrow while moving columns.
Defines a class with default cursors for the grid.
Initializes a new instance of the class.
Gets the cursor
The name of the cursor.
The instance of the class.
Gets or sets the cursor while removing the columns.
Instance of
Defines a class that provides localized access to string resources specific
from the assembly manifest field.
The Syncfusion.Windows.Forms.Grid.Grouping.Localization namespace contains classes that provides the localized string values from the resource manager.
SR provides localized access to string resources specific
from the assembly manifest GridGroupingLocalizationResourceAccessor.Instance.Resources
Gets the string from the satellite assemblies and used it in the program. If the satellite Assemblies are not present, then the resources are read from SR.resources.
Specifies the culture of the Application.
Specifies the string for which localization has to be applied.
Arguments in the type of object.
The string values of the specified instance.
Gets the localized string for the given string.
The string that has to be localized.
Returns the localized string in the type string.
Gets the localized string.
The string that has to be localized.
Arguments in the type of object.
The localized string in the type of string.
Gets the localized string for the given string.
Specified the culture into which the string has to be localized.
Arguments in the type of object.
The localized string in the type of string.
Gets the localized string for the given string.
Specifies the culture into which the string has to be localized.
Arguments in the type of object.
The localized string in the type of string.
Gets the localized string for the given string.
string that has to be localized.
Returns the boolean value for the string.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The boolean value for the string.
Gets the boolean value for the current object.
The string that has to be localized.
The boolean value for the string.
Gets the Byte value for the current object.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The Byte value for the string.
Gets the localized string for the given string.
string that has to be localized.
The Byte value for the string.
Gets the character value for the string.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The Char value for the string.
Gets the localized string for the given string.
string that has to be localized.
The Char value for the string.
Gets the Double value for the string.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The Double value for the string.
Gets the localized string for the given string.
string that has to be localized.
The double value for the string.
Gets the Float value for the string.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The float value for the string.
Gets the localized string for the given string.
string that has to be localized.
The float value for the string.
Returns the integer value for the string.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The integer value for the string.
Gets the localized string for the given string.
string that has to be localized.
The long value for the string.
Gets the Long value for the string.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The long value for the string.
Gets the short value for the string.
Specifies the culture into which the string has to be localized.
The string that has to be localized.
The short value for the string.
Gets the localized string for the given string.
string that has to be localized.
The short value for the string.
Defines a class that specifies the category in which the property or event will be displayed in a visual designer.
This is a localized version of CategoryAttribute. The localized string will be loaded from the
assembly manifest field.
Initializes a new instance of the class with the specified category.
The category.
Overrides and gets the localized string.
The current instance that needs the localized string.
The localized string value.
Defines a class that specifies the description for a property or event.
This is a localized version of DescriptionAttribute. The localized string will be loaded from the
assembly manifest field.
Initializes a new instance of the class with the specific description.
The description of the specified object.
Gets the description values for the attributes specified.
Defines a class that specifies the constant resource identifier string values.
Defines the constant string value for the filterbar cell's "(All)"
Defines the constant string value for the filterbar cell's "(Custom...)"
Defines the constant string value for the filterbar cell's "(Empty)"
Defines the constant string value for the record navigation bar.
Defines the constant string value for the dragging column header tip text.
Defines the constant string value to denote the interruption in assigning the data source.
Defines the constant string value for pasting the schema in designer window of the grid.
Defines constant string value of Paging
Defines constant string value of Paging
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to Drag a column header here to group by that column..
Looks up a localized string similar to Failed to fill dataset.
Looks up a localized string similar to (All).
Looks up a localized string similar to (Custom...).
Looks up a localized string similar to (Empty).
Looks up a localized string similar to Items.
Looks up a localized string similar to Paste Engine Schema.
Looks up a localized string similar to of.
This interface provides routines for getting and setting row heights for elements.
Implement it in derived elements when custom row heights are needed.
Determines if elements support storing row heights.
returns boolean value to indicate support row height
The row height.
Checks if row height was modified.
The section with the CaptionRow.
This is the first section within a group which provides the caption bar above the
column headers. CaptionSection is a display element and will be an item returned by
the Table.DisplayElements and Table.GroupedElements collection.
CaptionSection is also a Section that can be accessed through the Group.Sections
collection of its parent group.
If a caption should be displayed at the beginning of each group, then CaptionSections
are created when the grouping for a table is initialized. The grouping engine
loops through all sorted records and categorizes them. For each new group, the virtual
TableDescriptor.CreateGroup factory method is called. The TableDescriptor.CreateGroup method instantiates a CaptionSection by calling the
virtual TableDescriptor.CreateCaptionSection factory method.
The following example creates a string based on the CaptionSection's parent
group number of direct child elements (as usually shown in the caption element for a
group in GroupingGrid). Use the ParentGroup property to get access to the parent
Group of this CaptionSection:
CaptionSection cs;
object cat = cs.ParentGroup.Category;
if (cat == null)
cat = "(null)";
string caption = "{2} Item(s)";
string groupName = cs.ParentGroup.Name;
if (groupName != "")
caption = "{0}: {1} - " + caption;
return string.Format(caption, groupName, cat, cs.ParentGroup.GetChildCount());
See also:
TableDescriptor.CreateGroup, TableDescriptor.CreateCaptionSection, Group.Caption,
Group.Sections, IDisplayElement
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets The default with
information for cells of this element.
Represents the row for the column header row in a group.
A ColumnHeaderRow is displayed at the top of a table or group. ColumnHeaderRow is a place holder
item where the grouping grid should display column headers.
ColumnHeaderRow is a RowElement and an element of the ColumnHeaderSection.ColumnHeaderRows
collection of a parent ColumnHeaderSection.
ColumnHeaderRows are created and removed internally within a ColumnHeaderSection when the
section is created and when the TableDescriptor.RowsPerRecord property of a TableDescriptor
is changed.
See also:
TableDescriptor.RowsPerRecord, IDisplayElement, ColumnHeaderSection, ColumnHeaderSection.ColumnHeaderRows,
ColumnHeaderRowCollection
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A of this element.
Determines whether has been modified
and contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Get the appearance of the first parent element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets The default with
information for cells of this element.
Used internally.
Initializes a new instance of the class.Used internally.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
Represents the row for the caption bar of a group.
Initializes the new instance of the class.
The parent that this element belongs to.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
The section with the AddNewRecord:
This is the section within a group which provides the AddNewRecord that is shown above the
table records and / or below the records for each group and implements logic to add new records.
See the AddNewRecord class for more information.
The AddNewRecordSection is a RecordsDetails section and thus also a container element. Normally,
a RecordsDetails section has a collection of one or multiple records but with a
AddNewRecordSection you have exactly one child record, the AddNewRecord.
If AddNewRecord(s) should be displayed at end of each group, then AddNewRecordSection(s) are
created when the grouping for a table is initialized. The grouping engine loops through all
sorted records and categorizes them. For each new group, the virtual TableDescriptor.CreateGroup
factory method is called. The TableDescriptor.CreateGroup method instantiates an AddNewRecordSection
by calling the virtual TableDescriptor.CreateAddNewRecordSection factory method.
One AddNewRecord is displayed at the top of the table below the column headers. It belongs
to the AddNewRecordSection of the TopLevelGroup of a table. The TopLevelGroup is created
with the virtual TableDescriptor.CreateGroup factory method. The TableDescriptor.CreateGroup
method instantiates an AddNewRecordSection by calling the virtual
TableDescriptor.CreateAddNewRecordSection factory method.
Because AddNewRecordSection is a container element and not a display element, it will not
be an item returned by the Table.DisplayElements and Table.GroupedElements collection. Instead,
AddNewRecordSection can be accessed only through the Group.Sections collection of its parent
group.
See also:
TableDescriptor.CreateGroup, , ,
AddNewRecord, IContainerElement, Group.Sections
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
The section with the ColumnHeaderRow(s):
A ColumnHeaderSection holds ColumnHeaderRow(s) that are displayed at the top of a
table or group. The ColumnHeaderRow is a place holder item where the grouping grid
should display column headers.
The ColumnHeaderSection is a container element and has a collection of one or
multiple ColumnHeaderRow elements.
If ColumnHeaderSections should be displayed at the top of each group, then
ColumnHeaderSections are created when the grouping for a table is initialized.
The grouping engine loops through all sorted records and categorizes them. For
each new group, the virtual TableDescriptor.CreateGroup factory method is called.
The TableDescriptor.CreateGroup method instantiates a ColumnHeaderSection by
calling the virtual TableDescriptor.CreateColumnHeaderSection factory method.
One set of ColumnHeaderRows are displayed at the top of the table below the CaptionSection.
The rows belong to the ColumnHeaderSection of the TopLevelGroup
of a table. The TopLevelGroup is created with the virtual
TableDescriptor.CreateGroup factory method. The TableDescriptor.CreateGroup
method instantiates a ColumnHeaderSection by calling the virtual
TableDescriptor.CreateColumnHeaderSection factory method.
Because the ColumnHeaderSection is a container element and not a display element,
it will not be an item returned by the Table.DisplayElements and
Table.GroupedElements collection. Instead, the ColumnHeaderSection can be
accessed only through the Group.Sections collection of its parent group
or TopLevelGroup.
See also:
TableDescriptor.CreateGroup, TableDescriptor.CreateColumnHeaderSection,
Table.TopLevelGroup, IContainerElement, Group.Sections
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A of this element.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element,If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
An empty section with 1 visible element. Can be used as a place holder to appear in . GetYAmountCount will
return of the ParentTable.
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A hidden section with 1 visible element. Used as a place holder at the very first
row in the GridNestedTableControl needed for scrolling logic.
Initializes a new instance of the class.
The group this section is created in.
Gets the number of visible elements.
returns value 1.
Gets the element height.
returns value 0.
A place holder section with 1 visible element for showing a header above a group in .
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets the reference to the parent table this section belongs to.
Get the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A preview section with one visible element for showing a preview below a group in
when a group is collapsed.
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A place holder section with 1 visible element for showing a footer below a group in .
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A place holder section with 1 visible element for showing a filter bar.
Initializes a new section in the specified group.
The parent group.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
The details section of a group with nested child groups.
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A nested table inside a record. You can access nested tables in a record with the
property of a . Each nested table has a that provides the link to the
to the child records in a related table.
Initializes a new instance of the class.
The parent element this object is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
The provides the link to the
to the child records in a related table.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
The part of a record with nested tables. You can access nested tables in a record with the
property of a .
Initializes a new instance of the class.
The parent record this object is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A Record row is a place-holder element shown in the
for each row in a record. Each record can have multiple record rows. You get access to this element through the
property of a .
Initializes a new instance of the class.
The parent element.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A RecordPreview row is an optional element shown only in the
when a record is collapsed. You get access to this element through the
property of a .
Initializes a new instance of the class.
The parent element.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A part in a record that serves as container for
elements in a record.
Initializes a new instance of the class.
The parent record this object is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
The details section of a group with records.
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A base class for sections that can contain one or multiple row elements.
Initializes a new instance of the class.
The group this section is created in.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the appearance of the element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
Implement this interface for elements and keep
a cache with style information for individual cells
if you want reduce the number of
QueryCellStyleInfo calls being raised for cells of this element.
Here is example code to implement this interface. It is important to keep a version value and compare the version with GridEngine.Version. This ensures that when changes are made to the engine or table that the cache is reset:
public class GridRecordRowWithCache : GridRecordRow, IGridTableCellAppearanceSource, IGridTableCellStyleCache
{
public GridRecordRowWithCache(RecordRowsPart parent)
: base(parent)
{
}
protected override void Dispose(bool disposing)
{
styles = null;
base.Dispose (disposing);
}
#region IGridTableCellStyleCache Members
ArrayList styles;
int version;
public ArrayList Styles
{
get
{
if (styles == null || this.version != Engine.Version)
{
this.version = Engine.Version;
styles = new ArrayList();
}
return styles;
}
}
public GridTableCellStyleInfo GetStyleAtColumn(int colIndex)
{
if (Styles != null && styles.Count > colIndex)
{
return styles[colIndex] as GridTableCellStyleInfo;
}
return null;
}
public void SetStyleAtColumn(int colIndex, GridTableCellStyleInfo style)
{
if (version != Engine.Version)
ResetStyles();
if (Styles.Count <= colIndex)
Styles.AddRange(new object[colIndex-Styles.Count+1]);
styles[colIndex] = style;
}
public void ResetStyles()
{
styles = null;
}
#endregion
}
Returns the style for the specified column index.
The column index.
The style object.
Saves the style at the specified column index.
The column index.
The style object.
Empties the cache.
This is a specialized version of the class. It implements the
and keeps
a cache with style information for individual cells.
Initializes a new instance of the class.
The parent element.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
This is a specialized version of the class. It implements the
and keeps
a cache with style information for individual cells.
Initializes a new instance of the class.
The parent element.
Release the unmanaged resource.
True to release both managed and unmanaged resources; false to release only unmanaged resources.
The engine lets you set the main datasource for the whole engine. The TableDescriptor will
pick up the ItemProperties (schema information) from the datasource and
the table will be initialized at run-time with records from the list.
The TableDescriptor is browsable. You can modify its collections and properties in the
designer.
By default, TableDescriptor is auto-populated. If you do not modify its settings and
later change the datasource, it will be automatically reinitialized. If you have
made modifications to the TableDescriptor and changed the SourceList, the modifications
will be kept. To discard modifications of a TableDescriptor, you need to explicitly
call ResetTableDescriptor.
The Table is dependent on information provided by the TableDescriptor and the records from
SourceList. It is created on the fly and can not be designed with designer.
The GridEngine class adds the plumbing for displaying the data in a .
You can specify the datasource using the DataSource and DataMember
properties through the designer.
Use the following code instead:
bool displayCheckBoxForBooleanFields = false;
if (displayCheckBoxForBooleanFields)
{
GridPropertyTypeDefaultStyle booleanDefault = this.gridGroupingControl1.Engine.PropertyTypeDefaultStyles["System.Boolean"];
booleanDefault.Style.CellType = "CheckBox";
booleanDefault.Style.HorizontalAlignment = GridHorizontalAlignment.Center;
booleanDefault.AllowDropDown = false;
}
Determines whether the value of the property was modified.
True if it is modified.
Discards any changes for the property.
Used internally.
Initializes a new instance of the .
Adds base styles that to the collection that allow customization
of appearance of blinking cells.
Default value for BlinkIncreased state.
Default value for BlinkReduced state.
Default value for BlinkNewValue state.
Default value for BlinkNullValue state.
Default value for BlinkNewRecord state.
Initializes this object and copies properties from another object.
The source object.
Determines whether the engine is attached to the control that is currently being designed in VisualStudio designer.
True if it is in design mode.
Gets the service object of the specified type.
The type of service object to get.
Service object.
Internal helper routine that helps attaching the engine to a parent GridGroupingControl
when multiple GridGroupingControls share the same engine object. This event lets you
choose the one GridGroupingControl that should be treated as the main control for this engine.
The parent control.
Creates a .
The table descriptor.
Related parent table.
The new table.
Creates a .
Parent relation descriptor.
The new table descriptor.
Returns the main table descriptor or a table descriptor that matches with the given name.
Descriptor name.
Table descriptor.
Determines whether the collection was modified.
True if the collection was modified.
Resets the property.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Discards any changes for the object.
Virtual method to create a .
The .
The new table control.
Virtual method to create a .
Provides the display element of the table.
The parent control.
The which hosts this control.
The table control.
Virtual method to create the .
The RecordNavigationControl.
Virtual method to create the .
The table control.
The GroupDropArea model.
The new group drop area.
Virtual method to create a .
The table model.
The related table.
The GridNestedTableControlCellModel.
Virtual method to create the .
The table model used by the .
Creates a .
The new relation descriptor.
Creates an AddNewRecord for the given parent.
Parent section.
The new add new record.
Creates a CaptionSection for the given element.
Parent group.
The new caption section.
Creates a .
The parent element.
The new child table.
Creates a .
The parent section.
The new column header row.
Creates a CaptionRow for the given element.
Parent caption section.
The new caption row.
Creates a .
The parent section.
The new filter bar row.
Creates an AddNewRecordSection for the given parent.
Parent group.
The new add new record section.
Creates a element.
The parent group.
The new element.
Creates a .
The parent group.
The new column header section.
Creates an .
The parent group.
The new empty section.
Creates a .
The parent group.
The new filter bar section.
Creates a .
The parent section.
The new group.
Creates a .
The parent group.
The new details section.
Creates a .
The parent element.
the new nested table.
Creates a .
The parent table.
The new record.
Creates a .
The parent record.
The new RecordNestedTablesPart.
Creates a .
The parent element.
The new record row.
Creates a .
The parent record.
The new RecordRowsPart.
Creates a .
The parent group.
The new details section.
Creates a .
The parent group.
The new row elements section.
Creates a .
The parent group.
The new summary section.
Creates a .
The parent group.
The new group footer section.
Creates a .
The parent group.
The new group header section.
Creates a .
The parent element.
The new record preview row.
Creates a .
Parent group.
The new group preview section.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Implements of the interface.
Implements of the interface.
Returns the that can be used to
serialize and deserialize this object to XML.
The xml serializer.
Creates a object from a valid XML stream.
Creates a object from a valid XML stream.
The XML stream.
A object.
Creates a object from a valid XML stream.
The TextReader with XML stream.
A object.
Saves the engine changes to an XML stream.
Saves the engine changes to an XML stream.
The XMLWriter.
Saves the engine changes to an XML stream.
The .
Raises the event.
A that contains the event data.
Checks if the DescriptorPropertyChangedEventArgs has nested event data and if the innermost event is the
result of a change to an Appearance object. If so, the method will return the GridTableCellStyleInfoChangedEventArgs
and the object whose appearance was modified.
object app = tableDescriptor;
GridTableCellStyleInfoChangedEventArgs tableCellStyleInfoChangedEventArgs = GetNestedAppearanceEvent(e, ref app);
IGridTableCellAppearanceSource appearanceHolder = app as IGridTableCellAppearanceSource;
Event data.
The object holding the appearance settings.
The inner event args that holds more information about the nested event.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Occurs the event.
A that contains the event data.
Used internally.
Occurs the event.
A that contains the event data.
Used internally.
Occurs the event.
A that contains the event data.
Used internally.
Occurs the event.
A that contains the event data.
Used internally.
Raises the event.
A that contains the event data.
Used internally.
Occurs the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Returns the formatted summary text for the given group, summary row and column.
Returns the formatted summary text for the given group, summary row and column.
The group that defines a set of records that belong to a category.
The name of the GridSummaryRowDescriptor in the GridTableDescriptor.SummaryRows collection.
The name of the GridSummaryColumnDescriptor in the GridSummaryRowDescriptor.Summaries collection.
The summary formatted text as specified with GridSummaryColumnDescriptor.Format
See for an example.
Returns the formatted summary text for the given group, and summary column.
The group that defines a set to records that belongs to a category.
The GridSummaryColumnDescriptor.
The summary formatted text as specified with GridSummaryColumnDescriptor.Format
Returns the caption text for a group.
The group that defines a set to records that belongs to a category.
Caption text for the group.
Returns the caption text for a group using a specified format.
The group that defines a set to records that belongs to a category.
See GroupOptions.CaptionText, e.g. "{CategoryCaption}: {Category} - {RecordCount} Items";
Caption text for the group.
Determines if GroupOptions were specified for a group.
The or
True if GroupOptions were specified.
Gets the GroupOptions of a GridGroup or GridChildTable
The or
GroupOptions of the group.
If the groups GroupOptions were modified, the GroupOptions returns group object's GroupOptions; otherwise it
returns a of the first parent element with GroupOptions
in the hierarchy.
The or
GroupOptions of the group.
Returns a of the first parent element with appearance in the hierarchy.
The element to be queried.
A .
If this element is modified, the Appearance returns this object's Appearance; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
The element.
Appearance of this element.
The default with
information for cells of this element.
The element.
A .
Determines whether has been modified
and contents should be serialized at design-time.
The element.
True if contents were changed; False otherwise.
Discards any changes for the object.
An element that implements the interface.
Gets or sets the value that indicating whether the grid should simply call Invalidate
when a ListChanged event is handled or if it should determine the area
that is affected by the change and call InvalidateRange. With version 4.4
check also the and
properties.
On first sight, you might think it better to determine the area
that is affected by a change and call InvalidateRange.
But when calling InvalidateRange, the grid needs to know the
exact position of the record in the table before it can mark that area dirty.
In order to determine the record position (and y-position of the row in the display),
counters need to be evaluated. This operation can cost more time than simply
calling Invalidate in high-frequency update scenarios.
Also, be aware that the group caption bar needs to be updated when a
record changes.
With version 4.4 check out the new InsertRemoveBehavior and SortPositionChangedBehavior
properties and the UpdateDisplayFrequency properties that will speed up things a lot
if InvalidateAllWhenListChanged = false.
Gets the of the .
The is derived from the GridModel and adds support for retrieving
data from the data source for a .
Used internally. Gets or sets the value that indicating whether the visibility of GroupDropArea from ParentControl.
Gets the that hosts this engine.
Gets or sets the table schema information of the root table in the data source.
Gets the table object manages the records from the engine's DataSource and
provides access to records and grouped elements through several
collection classes, most prominent the .
Gets the main . The GridTableControl is a grid derived from
GridControlBase and displays and allows user interaction and modification of data.
This control is either a child control of the
or depending on whether the is set.
Gets the that hosts this engine.
Maintains a collection of base styles. Users can add BaseStyles to the engine (also in design-time) and
then inherit style settings through the GridStyleInfo.BaseStyle property in
property of .
Maintains a collection of default base styles which are not serialized to xml or code. End users
can override the base styles by manually adding a base style with the same name to the BaseStyles
collection.
Gets or sets the default with default
information for all cell elements in the control. This property lets you control almost any aspect of
the appearance of the grouping grid like cell background color, font, or the cell type.
Gets default appearance settings for the grid at runtime. These settings will
not be serialized or written to good and can be used if you want to specify default
settings for a derived GridGroupingControl. Any appearance element
in the engine will inherit these settings.
Gets the deefault appearance dource value. Used internally.
Occurs for each cell before a
starts painting and lets users customize the display of cells.
A collection of with default
information for RecordFieldCell elements
based on the columns System.Type. Each basic type has default style information
registered with this collection.
The collection contains pre-defined settings such as HorizontalAlignment for numbers and
cell type (e.g. check box for boolean).
GridPropertyTypeDefaultStyle settings have less precedence in styles inheritance than
styles.
Note: Changes you make to this collection do not get serialized; you will need
to reapply any changes even if you read back the schema from an XML file.
Lets you control the look of inner groups like whether the Caption Row is visible, or what CaptionText is.
Gets or sets the style info of the Group option. Lets you control the look of the top most group such as whether the Caption Row is visible, or what CaptionText is.
Gets or sets the style info for the child group option. Lets you control the look of the topmost group of nested tables such as whether the Caption Row is visible or what CaptionText is.
Gets or sets the style info for the table options. Lets you set table-wide properties like the width of the indent column, or whether header rows should be visible.
Gets the value that Determines if was called.
Occurs for each GridSummaryColumnDescriptor before the is determined. You must handle this event if you specified as .
Gets or sets the version of the object. This number is increased
each time a property in the object is changed.
Gets or sets the value that whether indicating the flag is enable if you want GridRecordRow and GridCaptionRow elements to keep
a cache with style information for individual cells and reduce the number of
QueryCellStyleInfo calls being raised for this cell.
When you enable this property, the and
methods will instantiate derived and
elements that implement the IGridTableCellStyleCache interface.
If other elements should support caching, you can add support for caching by deriving a class
from the elements base class and implement the IGridTableCellStyleCache interface. See the
GridRecordRowWithCache implementation how to do this.
Gets or sets the value that indicating whether initializing is recommended settings to improve handling of ListChanged events
and scrolling through grid. Affected settings are: ,
, , ,
and .
Gets or sets it's specifies how the grid should react if the sort position of a record records changes.
Gets or sets specifies how the grid should react if the sort position of a record records changes when the current record
is edited interactively by user.
Gets or sets specifies the number of milliseconds to wait between display updates when new ListChanged event handler logic
is used. This property does have no any effect if UseOldListChangedHandler = true. Special values are
0 - only manually update display by calling grid.Update() and 1 - update display immediately after each
change.
Gets or sets it's specifies how the grid should react if records are inserted or deleted.
Gets or sets specifies how the grid should react if records are inserted or deleted through direct
user interaction with AddNew record.
Gets or sets the time in milliseconds how long to highlight values in a record after a change
was detected. The engine will highlight a cell for the specified period in milliseconds if
the value was increased or decreased. If set to 0 the feature is disabled.
The GridEngine.QueryAddColumn event affects the auto-population of the GridColumnDescriptorCollection.
It is called for each column and lets you control at run-time if the column should be added to the
GridColumnDescriptorCollection. You can set e.Cancel = True to avoid specific columns
being added.
Handling through a
The event affects the auto-population of the .
It is called for each column and lets you control at run-time if the column should be added to the
. You can set e.Cancel = True to avoid specific columns
being added.
Handling through a
Gets the assembly version of the GridGroupingControl at the time
it was dropped onto a form with designer.
Occurs each time the is called to get the raw string that represents the underlying cell's value.
This event allows you to customize how to represent a cell's value as string at run-time on demand.
If you do want to customize the grid's default conversion, you should assign the result string
to and set
to True. The grid will check this flag to see whether it should return
or use a default conversion.
If you need identity information about the cell such as row and column index, you can get that
information by querying of the
object.
Occurs each time the is called to set the unformatted string that represents the underlying cell's value.
This event allows you to customize how to parse the unformatted text into a cell value at run-time on demand.
If you do want to customize the grid's default parsing behavior, you should assign the resulting value
to the of the object
and set
to True. The grid will check this flag to see whether it should accept your modification
or use a default parsing routine.
If you need identity information about the cell such as row and column index, query the of the
object.
See the event for further discussion since these two events
are very similar. Often you will need to handle both events in your code in the same way.
Occurs each time the is called to get the formatted string that represents the underlying cell's value
considering .
This event allows you to customize how to format a cell's value as string at run-time on demand based on .
If you do want to customize the grid's default formatting, you should assign the resulting string
to and set
to True. The grid will check this flag to see whether it should return
or use a default formatting routine.
If you need identity information about the cell such as row and column index, you can get that
information by querying the of the
object.
Occurs each time the is called to parse the formatted string that represents the underlying cell's value
considering and .
This event allows you to customize how to parse the formatted text into a cell value at run-time on demand.
If you do want to customize the grid's default parsing behavior, you should assign the resulting value
to the of the object
and set
to True. The grid will check this flag to see whether it should accept your modification
or use a default parsing routine.
If you need identity information about the cell such as row and column index, you can get that
information by querying the of the
object.
This event is normally called from within , which is called
when the user enters text into a text box or when text is assigned to .
ApplyFormattedText method checks if there are event handlers for and
if the is not set, they try to convert the input text into
the type specified with .
If this conversion fails, will check . If it
is True, an exception is thrown which itself results in a warning message displayed to the user at the
time from .
If you set to False, will not throw
an exception and simply store the text as .
If you need a more specialized customization of this behavior, you should handle the
event. This lets you parse the text input
and change the cells at run-time. See the attached example.
This example parses the text input and changes the cell's CellValueType at run-time if the input does not match the current CellValueType.
void InitializeComponent()
{
// initialize code
// ...
this.gridControl1.SaveCellText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_SaveCellText);
this.gridControl1.QueryCellFormattedText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_QueryCellFormattedText);
this.gridControl1.SaveCellFormattedText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_SaveCellFormattedText);
this.gridControl1.QueryCellText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_QueryCellText);
}
private void gridControl1_QueryCellFormattedText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{
}
private void gridControl1_QueryCellText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{
}
private void gridControl1_SaveCellText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{
ParseText(e);
}
private void gridControl1_SaveCellFormattedText(object sender, GridCellTextEventArgs e)
{
ParseText(e);
}
void ParseText(GridCellTextEventArgs e)
{
// By default, the grid will display a warning message box informing the user
// the entered value is not valid and the user will have to change the value.
//
// In this event handler, we change the grid default's behavior such that
// when the user enters a value that does not fit the cell's CellValueType,
// the input text is accepted and no warning message is shown.
if (e.Handled)
return;
System.Globalization.CultureInfo ci = e.Style.CultureInfo;
System.Globalization.NumberFormatInfo nfi = ci != null ? ci.NumberFormat : null;
try
{
e.Style.CellValue = GridCellValueConvert.Parse(e.Text, e.Style.CellValueType, nfi, e.Style.Format);
}
catch (Exception ex)
{
if (ex is FormatException || ex.InnerException is FormatException)
{
e.Style.CellValue = e.Text;
// possibly could also change CellValueType here
e.Style.CellValueType = typeof(string);
// - or -
// you could also further analyze the input text and assign a type
// that fits the input text, e.g.
// e.Style.CellValueType = typeof(datetime);
// - or -
// e.Style.CellValueType = typeof(decimal);
// etc.
}
else
throw;
}
e.Handled = true;
}
Private Sub InitializeComponent()
' Initalize code
' ...
AddHandler Me.gridControl1.SaveCellText, AddressOf Me.gridControl1_SaveCellText
AddHandler Me.gridControl1.QueryCellFormattedText, AddressOf Me.gridControl1_QueryCellFormattedText
AddHandler Me.gridControl1.SaveCellFormattedText, AddressOf Me.gridControl1_SaveCellFormattedText
AddHandler Me.gridControl1.QueryCellText, AddressOf Me.gridControl1_QueryCellText
End Sub 'InitializeComponent
Private Sub gridControl1_QueryCellFormattedText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
End Sub 'gridControl1_QueryCellFormattedText
Private Sub gridControl1_QueryCellText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
End Sub 'gridControl1_QueryCellText
Private Sub gridControl1_SaveCellText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
ParseText(e)
End Sub 'gridControl1_SaveCellText
Private Sub gridControl1_SaveCellFormattedText(sender As Object, e As GridCellTextEventArgs)
ParseText(e)
End Sub 'gridControl1_SaveCellFormattedText
Sub ParseText(e As GridCellTextEventArgs)
' By default, the grid will display a warning message box informing the user
' the entered value is not valid and the user will have to change the value.
'
' In this event handler we change the grid default's behavior such that
' when the user enters a value that does not fit the cell's CellValueType,
' the input text is accepted and no warning message is shown.
If e.Handled Then
Return
End If
Dim ci As System.Globalization.CultureInfo = e.Style.CultureInfo
Dim nfi As System.Globalization.NumberFormatInfo = Nothing
If (Not (ci Is Nothing)) Then nfi = ci.NumberFormat
Try
e.Style.CellValue = GridCellValueConvert.Parse(e.Text, e.Style.CellValueType, nfi, e.Style.Format)
Catch ex As Exception
If TypeOf ex Is FormatException OrElse TypeOf ex.InnerException Is FormatException Then
e.Style.CellValue = e.Text
' possibly could also change CellValueType here
' e.Style.CellValueType = typeof(string);
' - or -
' you could also further analyze the input text and assign a type
' that fits the input text, e.g.
' e.Style.CellValueType = typeof(datetime);
' - or -
' e.Style.CellValueType = typeof(decimal);
' etc.
Else
Throw
End If
End Try
e.Handled = True
End Sub 'ParseText
Use this event to provide support for parsing the formatted string and convert
it into the the underlying cell's value
considering and .
This event is raised from GridCellModelBase.ApplyFormattedText after
was raised. The event is raised only
if the SaveCellFormattedText did not set e.Handled.
The grid has built-in support for parsing the Percent format (Format = "P") and Hexadecimal
format (Format = "X"). You should handle this event if you want to add support
for other formats.
GridCellTextEventArgs has information about the style settings of the cell. You can
inspect that style to get information about Format and CellValueType of the cell.
Occurs to determine if the cell belongs to a covered range and returns the covered range of the cell or
the cell itself as if it is not a covered range.
Used internally.Gets or sets the value that indicating whether the value as true mark sorted columns dirty when change the sort positioning
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
The default with default
information for all cell elements in the control. This property lets you control almost every aspect of
the appearance of the grouping grid like cell backcolor, font, or the cell type.
Defines the constants that specify the sort position of the current
record when edited interactively by user.
Invalidate display, do not check position of record
Invalidate only the visible portion of display that is affected by change. If record is above
current view change the top row to minimize scrolling.
Scroll contents. If record is above
current view change the top row to minimize scrolling. Changes will be visible immediately.
In your derived engine class you can then further customize classes that are created. The GridEngine class
contains virtual factory methods such as or
that are called to create objects that belong to a GridGroupingControl
and its engine elements.
A global factory class with the purpose of instantiating a GridEngine object.
Intializes a new instance of the class.
Calls the virtual factory method and instantiates a
GridEngine object.
If the method is not overridden, an empty
object is returned, otherwise an object derived from may be returned.
Occurs when the property was changed.
Lets you assign an application-wide global instance of a derived
GridEngineFactoryBase object with an overridden GridEngineFactoryBase.CreateEngine
factory method.
A factory class object with the purpose of instantiating a GridEngine object.
The virtual GridGroupingControl.CreateEngine function by default calls GridEngineFactory.CreateEngine
to create an engine object.
There are multiple alternatives that let you customize the engine object that is used within a GridGroupingControl.
-
A global solution for all controls in your app is to derive a class from GridEngineFactoryBase,
override CreateEngine, and assign an instance of the derived GridEngineFactoryBase object to GridEngineFactory.Factory.
-
Instantiate manually a GridEngine object and call the constructor of GridGroupingControl, passing in the engine
object as parameter.
-
Derive GridGroupingControl and override the virtual CreateEngine method.
In your derived engine class, you can then further customize classes that are created. The GridEngine class
contains virtual factory methods such as or
that are called to create objects that belong to a GridGroupingControl
and its engine elements.
Initializes a new instance of the class.
Initializes a and optionally marks it as "Default".
True if this engine should be marked as default.
Override this method if you would like to have a derived engine object. The method is called from
to create a default engine object when no engine objects were manually
instantiated. See also the discussion in .
The new grid engine.
Gets the value as True when this factory has been auto-initialized.
A Group defines a group of records that belong to a category. A group has
multiple sections such as CaptionSection, SummarySection, GroupsDetailsSection,
and RecordsDetailsSection.
Groups are created when the records of the table are categorized or when a new record
is inserted. Normally,
the categories are based on the but
programmers can also provide their own categorization routines by implementing
a
for a . Before groups are categorized, the records are
sorted in the order as specified by . After the
records were sorted, the object loops through all records to determine
the categories records belong to.
Another collection in the TableDescriptor that defines categorization is the
collection. RelationChildColumns will be
added when there is a parent-child relation between two tables. The child table of such a relation must be
sorted by the columns that are used to identify a record. These columns match the foreign key
columns of the parent table. For every new category key with regards to RelationChildColumns,
a is created. The ChildTable class is derived from .
A group can either be a final node with records or it can be a node with nested groups. If a
group has records, its collection will be empty and the
collection will contain all records. If a group has nested groups, its
collection will have the nested groups and the collection will be empty.
A group can be expanded and collapsed with its property. Expansion
of groups will show or hide nested elements of the group within the
collection.
A table has at least one group. The is a
which is derived from .
The property will return the group level how deep the group is nested.
Initializes a new instance of the class.
The parent element this object belongs to.
Release the unmanaged resources.
Create the
returns the new
Determines whether this group should be visible. By default a group is hidden if it does
not have any records that meet filter criteria.
true if group should be visible; false otherwise.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
This virtual method is called from and
lets derived elements implement element-specific logic to ensure object
is up to data.
The object that triggered the call.
True if changes were detected and the object was updated; False otherwise.
Determines whether the child of the given element is visible.
The element.
True if it is visible.
Determines whether the caption row should be shown
True if it is made visible.
Returns the formatted summary text for the given group, summary row and column.
Returns the formatted summary text for the given group, summary row and column.
The name of the in the collection.
The name of the GridSummaryColumnDescriptor in the GridSummaryRowDescriptor.Summaries collection.
The summary formatted text as specified with
See for an example.
Returns the formatted summary text for the given group and summary column.
Provides the .
The summary formatted text as specified with GridSummaryColumnDescriptor.Format
Gets the caption text for a group.
Caption text for the group.
Gets the caption text for a group using a specified format.
See GroupOptions.CaptionText, e.g. "{CategoryCaption}: {Category} - {RecordCount} Items";
Caption text for the group.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the Appearance if this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
Gets the value of GroupOptions if it has specified.
Lets you control the look of inner groups like whether the Caption Row is visible or what CaptionText is.
Gets the GroupOptions,If this element is modified; otherwise it
returns a of the first parent element with GroupOptions
in the hierarchy.
Gets or sets this property to false if you are concerned about real-time updates performance.
Determines whether this group can be collapsed.
A ChildTable is either a TopLevelGroup or a group that can be referenced
as a nested table from a record in a parent table. ChildTable groups are created
for every new key found based on .
You can get access to a ChildTable through the
property of a in a record.
A ChildTable defines a group of records that belong to a category specified with
.
ChildTables are created just like regular groups when the records of the table are
categorized or when a new record is inserted. The collection in the TableDescriptor that defines categorization is the
collection. RelationChildColumns will be
added when there is a parent-child relation between two tables. The child table of such a relation must be
sorted by the columns that are used to identify a record. These columns match the foreign key
columns of the parent table. For every new category key with regards to RelationChildColumns,
a is created. The ChildTable class is derived from .
A child table can either be a final node with records or it can be a node with nested groups. If a
group has records, its collection will be empty and the
collection will contain all records. If a group has nested groups, its
collection will have the nested groups and the collection will be empty.
A child table can be expanded and collapsed with its property. Expansion
of child tables will show or hide nested elements of the group within the
and collection.
A Table has at least one child table. The is a
which is derived from .
Initializes a new instance of the class.
The parent element this object belongs to.
Create GroupTypedListRecordsCollection
returns GroupTypedListRecordsCollection
Returns a of the first parent element with appearance in the hierarchy.
A of this element.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Returns a of the first parent element with group options in the hierarchy.
returns IGridGroupOptionsSource for hosting GridGroupOptionStyleInfo
This virtual method is called from and
lets derived elements implement element-specific logic to ensure object
is up to data.
The object that triggered the call.
True if changes were detected and the object was updated; False otherwise.
Determines whether the child of current element is visible.
The specified element.
True if it is visible; False otherwise.
Indicates whether caption row is visible.
True if it is visible; False otherwise.
Returns the formatted summary text for the given group, summary row and column.
Returns the formatted summary text for the given group, summary row and column.
The name of the GridSummaryRowDescriptor in the GridTableDescriptor.SummaryRows collection.
The name of the GridSummaryColumnDescriptor in the GridSummaryRowDescriptor.Summaries collection.
The summary formatted text as specified with GridSummaryColumnDescriptor.Format
See for an example.
Returns the formatted summary text for the given group and summary column.
The provides the .
The summary formatted text as specified with GridSummaryColumnDescriptor.Format
Gets the caption text for a group.
Caption text for a group.
Gets the caption text for a group using a specified format.
See GroupOptions.CaptionText, e.g. "{CategoryCaption}: {Category} - {RecordCount} Items";
Group caption display text.
The current cell for this child table.
Internal only.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the Appearance of the grid table, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets The default with
information for cells of this element.
Gets the value of the GroupOptions if it has specified.
Gets or sets the look of inner groups such as whether the Caption Row is visible or what CaptionText is.
Gets the GroupOptions, If this element is modified; otherwise it
returns a of the first parent element with GroupOptions
in the hierarchy.
Indicates whether this element can be collapsed.
Used internally.
Intializes a new instance of the . Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
The Group that defines a set of records that belong to a category.
The Element.
The GridGroupOptionsStyleInfo.
true if [is child visible] [the specified owner]; otherwise, false.
A record element for adding new records to the underlying data source.
This element represents the empty record that is shown above the table records and / or below
the records for each group and implements logic to add new records.
This element represents the empty record that is shown above the table records and / or below
the records for each group and implements logic to add new records.
The class is derived from a record. It adds special behavior such that the AddNewRecord is
not bound to a record in the underlying table. Instead all fields are initially empty (
or default values based on parent group by criteria). When changes are made, they
will be committed to the underlying table by adding a new record at the end of the
underlying data source. The grouping engine will automatically insert the record into
its sorted records collection and into the group it belongs to. If no group
is found where the record fits in, a new group will be created.
AddNewRecord(s) can be optionally displayed at the start of table below the column headers
and / or at the end of each group.
AddNewRecord belongs to a AddNewRecordSection and is its only element.
If AddNewRecord(s) should be displayed at end of each group (see also Engine.ShowAddNewRecordInGroups)
then AddNewRecordSection(s) are created when the grouping for a table is initialized.
The grouping engine loops through all sorted records and categorizes them. For each new
group the virtual TableDescriptor.CreateGroup factory method is called. The TableDescriptor.CreateGroup
method instantiates a AddNewRecordSection by calling the virtual TableDescriptor.CreateAddNewRecordSection
factory method.
One AddNewRecord is displayed at the top of the table below the column headers. It belongs to
the AddNewRecordSection of the TopLevelGroup of a table. The TopLevelGroup is created with the
virtual TableDescriptor.CreateGroup factory method. The TableDescriptor.CreateGroup method
instantiates an AddNewRecordSection by calling the virtual TableDescriptor.CreateAddNewRecordSection
factory method.
AddNewRecord is a container element. It contains one or multiple RecordParts.
Because AddNewRecord is a container element and not a display element and it will not be an
item returned by the Table.DisplayElements and Table.GroupedElements collection. Instead,
AddNewRecord is only returned by the RecordsDetails.Records collection of its parent
AddNewRecordSection (or the Group.Records collection of its ParentGroup which is a shortcut
instead of accessing it through AddNewRecordSection).
See also the Engine.RecordAsDisplayElements on how to make AddNewRecord be treated as a display
element if you have no need for nested elements within a record., e.g. if you only want to
display a single table and you do not need multiple row elements per record and / or nested tables.
(However, do not change this setting if you intend to use the engine as grid data model.)
The first record part is a RecordRowsPart. A RecordRowsPart contains one or multiple RecordRows
displayed in a grid for the record.
The second record part represents nested tables. If relations have been defined for the table
(see TableDescriptor.Relations) and the current table has a foreign key relationship setup
to other tables, a table is added to the RecordPart[1].NestedTables collection for each relation.
You can access nested tables in a record with the Record.NestedTables collection.
AddNewRecord can be set as the current record in a table if you want to edit its data through
the engine.
The first time a value is changed by the grid, Record.BeginEdit is called before the value is assigned.
When the user moves the current cell in the grid to a new record, the changes are committed with a
Record.EndEdit call. If the user presses Escape, the changes are rolled back with a Record.CancelEdit
call. If the user presses Enter, the changes are committed and the record's new display position is
determined and the current cell is moved to the new display position of the record. If validation
fails during EndEdit, the grid will try to identify the column which violated the record constraints
and display a red error indicator for that column with a ToolTip text showing the exception text
when the user hovers the mouse over the red arrow indicator.
See the CurrentRecordManager class for a description of events raised when modifying columns in the
AddNewRecord row or when BeginEdit, CancelEdit, or EndEdit was called.
See also: CurrentRecordManager, CurrentRecordManager.IsAddNewRecord, CurrentRecordManager.NavigateTo,
Group.AddNewRecord, Table.AddNewRecord, TableDescriptor.CreateGroup, Table.TopLevelGroup,
AddNewRecordSection, IContainerElement, RecordsDetails.Records, Group.Records
The following example shows how you can add records and keep track of sorted
display positions within a table:
// Add a record to Table table2
Record r = table2.AddNewRecord;
r.SetCurrent(); // Makes it the current record, saving any pending changes previous current record.
if (r.IsCurrent)
{
r.BeginEdit();
if (r.IsEditing)
{
r.SetValue("Country", "USA");
r.SetValue("Region", "NC");
r.SetValue("CustomerID", "SYNC
r.SetValue("CompanyName", "Syncfusion");
r.EndEdit();
}
}
int displayPos = table.DisplayElements.IndexOf(r);
// Now, you could navigate the current cell of a grid to row displayPos and highlight the newly added row
// within its correct group category and sort order
Triggers after changes handled in TableCellStyle.
Initializes the new instance of the class.
The parent that this element belongs to.
Returns a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Indicates whether to show the record preview rows.
returns the boolean value False.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the reference to the of the this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets a reference to the parent table this element belongs to.
If this element is modified, the Appearance returns this object's Appearance; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
Gets the current element is collapsible.
Represents a record with data. Each record in the datasource has an associated object
in the engine. Records are created when the datasource is assigned to a table and before they are sorted or filtered.
Also when a new record is inserted in the datasource, a is created. When the grouping or sorting
of a changes, all elements stay in sync with their underlying record-counterparts
in the datasource.
By default a record will not appear in the . Instead a record serves as a container
of multiple row elements and nested tables.
There are multiple ways to get access to a specific record:
-
The collection of the class provides access to the records
in the same order as they appear in the datasource. The method
of an determines the index of any record in the underlying datasource.
-
The collection of the class provides access to the records
in the order as they were sorted in the engine. The method
of a determines the index of any record in the Table.Records collection.
-
The collection of the class provides access to records that
meet filter criteria in the order as they were sorted in the engine. The method
of a determines the index of any record in the Table.FilteredRecords collection.
-
The collection of the class provides access to the records
in the order as they appear in the group. The method
of a determines the index of any record in the Group.Records collection.
-
The collection of the class provides access to the records
in the order as they appear in the group. The method
of a determines the index of any record in the Group.FilteredRecords collection.
Given a or , you can query its
property to determine which record these elements belong to.
Since record elements always stay in sync with their underlying record-counterparts
in the datasource, you can keep a bookmark (reference) to a record. For example you can save a reference to a record,
change the sort order of the table, and then later check Records.IndexOf to determine the new position where
the record can be located after the sort.
By default, a record will not appear in the . Instead a record serves as a container
for multiple row elements and nested tables. One exception is if you specified .
You can set to True if you do not want the engine to treat record and ColumnHeaderSection
elements as ContainerElements and instead have these elements be returned as a display element in the Table.DisplayElements collection.
However, with a GridGroupingControl you must not change this property since a GridGroupingControl
relies on the behavior that a record is not a display element but a container for rows
and nested tables.
The method will return a reference to the original record with data in the datasource.
A record can be navigated to a current record if you call its method.
Individual field contents can be retrieved with its method.
Initializes a new instance of the class.
The table this record belongs to.
Returns a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Overridden to get the display member value for filtering a column.
The field to be retrieved.
The display member value if it is having the display member. otherwise returns the value member.
Gets the value from the underlying datasource based on FilterMode option.
The field to be retrieved.
The value to check for the FilterMode.
Returns value from the underlying datasource.
Gets the value of the record.
The field to be retrieved.
Record value.
Determines whether the record preview rows should be made visible.
True if they are visible.
Determines whether the record rows should be visible.
True if they are visible.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
Gets the object's Appearance if this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
Gets whether this element is collapsible.
Record that shadows values in table and can gives hints which values were changed in ListChanged event. The
new GetOldValue method also gives access to the previous value before a change and can be used for
calculating the difference between two values.
Initializes a new instance of the class.
The parent table.
Resets the record values.
Ensures that record values are cached.
Returns the value for a record.
The field descriptor.
Record value.
Returns the old value for a record.
The index of the field whose value is required.
Old value of the record.
Returns an ArrayList with ChangedFieldInfo objects and updates
the values in the record with changes found in underlying datasource.
Only fields with a PropertyDescriptor are updated, others (unbound, expression fields) are ignored.
An ArrayList with ChangedFieldInfo objects.
Enumerates through values in the collection of ChangedFieldInfo objects
and updates the old and new values in this record.
The changed fields.
The stackedHeader section that contains one or multiple row elements for showing the stackedHeader below a group in . The stackedHeader
information can be determined by calling on the that this stackedHeader section
belongs to.
Initializes a new section in the specified group.
The group this section is created in.
This overridden
lets the elements implement element-specific logic to ensure object
is up to data.
The object that triggered the call.
True if changes were detected and the object was updated; False otherwise.
Resets the counter for all elements.
When true notifies the counter source.
Ensures the object, nested objects and parent elements reflect any changes made to the engine or table descriptor.
The object that triggered the call.
Specifies if the parent element's should also be called.
True if they reflect the changes.
Gets the counter for the element.
The counter for the current element.
To create ChildElementTreeTable
returns Boolean value true
Returns a string holding the current object.
String representation of the current object.
Returns a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the kind of display element for stacked header row or section.
The collection of elements that are contained in this section.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
If this element is modified, the Appearance returns this object's Appearance; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
The default with
information for cells of this element.
A stackedHeader row element that is contained in the collection
of a . A stackedHeader row is added to a GridStackedHeaderSection for every visible
.
Initializes an object with the row index and parent section.
The parent element.
The row index in the collection
of the parent .
Returns a string holding the current object.
String representation of the current object.
Gets the number of elements.
returns value 1.
This overridden
lets the elements implement element-specific logic to ensure object
is up to data.
The object that triggered the call
True if changes were detected and the object was updated; False otherwise
Returns the number of visible elements.
returns value 1.
Gets the element height.
Element height.
Returns a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the kind of display element.
Returns the parent this element belongs to.
Returns a reference to the this row belongs to.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
If this element is modified, the Appearance returns this object's Appearance; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
The default with
information for cells of this element.
A collection of elements that are children of a .
An instance of this collection is returned by the property
of a object.
Determines if the element belongs to this collection.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts an element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls .
Removes the specified element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls
Adds a value to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Removes all elements from the collection.
Gets or sets the element at the zero-based index.
Gets the value as False.
Gets the value as False since this collection has no fixed size.
Gets the value as False since this collection has not synchronized.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
If changes in the TableDescriptor are detected, the
method will reinitialize the collection before returning the count.
Enumerator class for elements of a .
Initializes the enumerator and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Determines whether the enumerator move to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Summarizes string fields and lets you determine the maximum length of a string in the column.
The initial summary object for empty records or tables.
Creates a summary object for the specified and Record.
The summary descriptor.
The element with data.
A new summary object.
Initializes a new instance of the
Maximum length.
Combines the values of this summary with another summary and returns
a new summary object.
Another summary object.
A new summary object with combined values of both summaries.
Combines the values of this summary with another summary and returns
a new summary object.
Another summary object (of the same type).
A new summary object with combined values of both summaries.
Returns a string that represents the current object.
A string that represents the current object.
Gets The maximum length value.
The summary section that contains one or multiple row elements for showing the summary below a group in . The summary
information can be determined by calling on the that this summary section
belongs to.
Initializes a new instance of the class.
The group this section is created in.
This overridden
lets the elements implement element-specific logic to ensure object
is up to data.
The object that triggered the call.
True if changes were detected and the object was updated; False otherwise.
Walks down to the child branches and resets the counter.
If true, notifies the counter source.
Ensures this object, nested objects and parent elements reflect any changes
made to the engine or table descriptor.
The object that triggered the call.
Specifies if the parent elements should also be called.
True if they reflect the changes.
Gets the .
returns the counter for the current element.
Indicates if child elementTreeTable to be created
returns Boolean value true
Indicates if the specified element is the direct child of this element and if it should be made visible.
The specified element.
True if it is a child and is visible.
Returns a string holding the current object.
String representation of the current object.
Returns a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the kind of display element. It is read only.
The collection of elements that are contained in this section.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
If this element is modified, the Appearance returns this object's Appearance; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
The default with
information for cells of this element.
A summary row element that is contained in the collection
of a . A summary row is added to a for every visible
.
Initializes a new instance of the class.
The parent element.
The row index in the collection
of the parent .
Gets a collection of summaries for the table.
The parent table.
Returns true if changes were detected.
A collection of summaries.
Returns a string holding the current object.
String representation of the current object.
Gets the number of elements.
returns value 1.
This overridden Syncfusion.Grouping.Element.OnEnsureInitialized(System.Object)
lets the elements implement element-specific logic to ensure object
is up to data.
The object that triggered the Syncfusion.Grouping.Element.EnsureInitialized(System.Object) call.
True if changes were detected and the object was updated; False otherwise.
Gets the number of visible elements.
returns the value 1.
Gets the summary row height.
Summary row height.
Gets a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Gets the kind of display element.
Gets the parent this element belongs to.
Returns a reference to the this row belongs to.
Gets the value whether this row displays summary columns in grid cells below a certain header column
or if the summary row is one large covered cell that spans the whole row.
Returns the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets a reference to the child table this element belongs.
Gets or sets a reference to the parent table this section belongs to.
If this element is modified, the Appearance returns this object's Appearance; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
A collection of elements that are children of a .
An instance of this collection is returned by the property
of a object.
Determines whether the element belongs to this collection.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading of the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts an element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls .
Removes the specified element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection, the method will do nothing.
The method
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
The method calls
Adds a value to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Removes all elements from the collection.
Gets or sets the element at the zero-based index.
Gets the value False since this collection has not read only.
Gets the value False since this collection has no fixed size.
Gets the value False since this collection has not synchronized.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
If changes in the TableDescriptor are detected, the
method will reinitialize the collection before returning the count.
Enumerator class for elements of a .
Initializes the enumerator and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Determines whether the enumerator move to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Manages all the records from the underlying source list. The source list can be any IList collection.
If it implements IBindingList, the GridTable will listen to the ListChangedEvent and update its internal
data whenever changes are made to the source list.
See the class for more details overview about this class.
Occurs before and after the status of the current record was changed. Check the
of the to get information on which current record state was changed.
Initializes a new instance of the class this object that belongs to a and optionally belongs to a parent table.
The table descriptor with schema information about the table.
The parent table of this table; NULL if this table is not a child table of a relation.
Returns the header column's GridColumnDescriptor at the specified grid row and column or NULL if the specified
grid column is not a column header.
Returns the header column's GridColumnDescriptor for the specified grid column in the first row of the GridColumnHeaderSection
or NULL if no GridColumnHeaderSection is found or the grid column is not a column header.
Column index.
The header column descriptor.
Returns the header columns GridColumnDescriptor at the specified grid row and column or NULL if the specified
row is not a ColumnHeaderRow or the grid column is not a column header.
Row index.
Column index.
The header column descriptor.
Returns the header columns GridStackedHeaderDescriptor at the specified grid row and column or NULL if the specified
row is not a GridStackedHeaderRow or the grid column is not a column header.
Row index.
Column index.
A .
Returns the header columns GridStackedHeaderDescriptor at the specified grid row and column or NULL if the specified
row is not a GridStackedHeaderRow or the grid column is not a column header.
Row index.
Column index.
The stacked header.
Returns the header column's GridColumnDescriptor at the specified grid row and column.
The GridRangeInfo.
The header column descriptor.
Returns the header column's GridStackedHeaderSpan at the specified grid row and column.
The GridRangeInfo.
A .
Returns the record field cell's GridColumnDescriptor at the specified grid row and column.
Record field cell.
The column descriptor.
Returns the record field cell's GridColumnDescriptor at the specified display element and column.
The Element.
Column index.
The column descriptor.
Returns the record field cell's GridStackedHeaderDescriptor at the specified display element and column.
The element.
Column index.
The stacked header.
Returns the record field cell's GridColumnDescriptor at the specified display element and column.
The element.
Column index.
The column descriptor at the specified element and column.
Returns the record field cell's GridColumnDescriptor at the specified grid row and column.
Row index.
Column index.
The column descriptor.
Returns the with the range of cells that an element spans.
The element.
The with the range of cells that an element spans.
Determines if the current thread is the same UI thread as the parent control or if
the current method call should be marshaled.
A control that can be used to marshal the current method by calling its Invoke method.
Returns the maximum length for the given field name in the first n records
of the data source. n is defined by TableOptions.ColumnsMaxLengthFirstNRecords property.
Field name.
Maximum length of the field.
This method is called internally when GridColumnsMaxLengthStrategy.FirstNRecords has been
specified and the column lengths for each field need to be initialized.
The hashtable uses the FieldDescriptor.Name as key and
the column length in characters as value.
Returns list of sample records.
list
Populates pass through groups for specified number of records.
The parent group.
The record count.
Returns the preferred column width in pixels for the specified column taking the
length of the column header text and the value returned by GetColumnMaxLength
into consideration.
Graphics context.
The Column.
Preferred column width.
Returns the preferred column width in pixels for the specified column taking the
length of the column header text and the value returned by GetColumnMaxLength
into consideration.
The
The
Width of the max.
Preferred column width.
Returns the calculated maximum length in characters for the specified column.
The length is taken from a previous call to OnInitializeColumnsMaxLengthFirstNRecords
or from a MaxLengthSummary that automatically tracks changes to fields in the column.
The Column.
Maximum length of the column.
Returns the calculated maximum length in characters for the specified field.
The length is taken from a previous call to OnInitializeColumnsMaxLengthFirstNRecords
or from a MaxLengthSummary that automatically tracks changes to fields in the column.
The column.
The provides the mapping information to a column.
Maximum length of the column.
Determines if the cell belongs to a covered range and returns the covered range of the cell or
the cell itself as if it is not a covered range.
The row index of the cell.
The column index of the cell.
Returns the covered range the cell belongs; if cell is not part of a covered range
the cell itself is returned as .
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Raises the event and calculates the covered range for a cell. Examples for covered ranges are the caption bar of a group,
a summary row with GridSummaryStyle.FillRow, or the first record field cell of an add new record (which spans
over the record field and plus minus button of groups below).
A that contains the event data.
Returns the that spans the cells where a row header for the specified element should be displayed. Can
span multiple rows if a table has multiple rows per record.
The display element.
The cell range.
Calculates the width of row headers and all indent columns before
the first record column.
Total width.
Calculates the width of row headers and all indent columns before
the first record column.
Specifies if width of nested table indents and parent table row headers should be added.
Total width.
Calculates the width of the table considering all indent columns and visible columns.
True if nested tables should also be considered.
Total width.
Calculates the width of the table considering all indent columns and visible columns
and internally updates the lastColumnWidth field to autosize the last grid column after
the last table column if nested tables are wider.
returns HorizontalScrollWidth
Calculates the width of the table considering all indent columns and visible columns
and internally updates the lastColumnWidth field to autosize the last grid column after
the last table column if nested tables are wider.
returns HorizontalScrollWidth
Returns the cell type name for a based on its TableDescriptor name. The
returned name is "RT" + relatedTable.TableDescriptor.Name.
The nested table.
The cell type name.
Returns the for a specified grid row and column.
The record.
The column.
A .
Returns the for a specified grid row and column.
The record.
The column.
A .
Returns the for a specified grid row and column.
The record.
The field for the column.
A .
Returns the for a specified grid row and column.
The record.
The name of field for the column (e.g. GridColumnDescriptor.MappingName returns the field name).
A .
Returns the for a specified grid row and column.
The element.
The column.
A .
Returns the for a specified grid row and column.
The element.
The column.
A .
Returns the for a specified grid row and column.
The row index.
The column index.
A .
Returns the for a specified grid row and column.
YThe element displayed at row index.
The row index.
The column index.
returns GridTableCellStyleInfo
Creates a style object and initializes its identity to
emulate how the value would appear in a cell in the grid.
The Record.
The Column.
A style object for the specified column in the given record.
Create a GridTableCellStyleInfo and fills in values based on the given GridTableCellStyleInfoIdentity. Call this
method if you want to manually setup the GridTableCellStyleInfoIdentity with its TableCellType
and other cell-specific information and then fill its cell value, format etc. The cell
does not have to be visible in the grid.
The
A .
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Returns a of the first parent element with appearance in the hierarchy.
A .
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Used internally.
The column.
returns GridRangeInfo
Used internally.
Clears the internal repaint elements queue. Call this method if you made changes to the table
and you experience an exception triggered by a RepaintElementsInQueue method call. The method
lets you work around any issues if elements are in the queue that have just been deleted from
the table.
Returns the relative row index in the RowElements collection if displayElement is a RecordRow or ColumnHeader row.
(A record can have column sets with multiple rows per record)
The row element
The relative row index of the element.
Returns the style information with TableCellIdentity for the given element and x-coordinate.
The element
The x position in client coordinate.
The style element with identity information for the cell that is displayed at the specified coordinate.
Returns an array of objects that are affected by
changes to the field and need to be redrawn.
Field index.
An array of summary column descriptors.
Gets or sets the that is used to display this table in a grid.
Gets the table descriptor.
Gets the parent table of this table or NULL if this table is not a child table of a relation.
Gets the table descriptor this element belongs to.
Gets the engine this element belongs to.
Gets the of the engine this element belongs to.
Gets a reference to the parent record this element belongs to.
Gets or sets a reference to the parent table this section belongs to.
Gets the kind of display element.
Used internally.
Occurs to determine if the cell belongs to a covered range and returns the covered range of the cell or
the cell itself as if it is not a covered range.
To avoid the RowHeader width calculation when disable the rowheader in Coded-UI assertion.
Gets the column width of the last column. The last column in the grid is used to fill empty space after
the last record field. This is needed for hierarchical display, when a nested table is wider than the current
table.
Gets or sets the default width of row headers.
Gets or sets the default width of table indents.
Gets or sets the default height of group caption rows.
Gets or seets the default height of column header rows.
Gets or sets the default height of empty section rows.
Gets or sets the default height of filter bar rows.
Gets or sets the default height of group footer sections.
Gets or sets the default height of group header sections.
Gets or sets the default height of group preview rows.
Gets or sets the default width of group indents.
Gets or sets the default height of record preview rows.
Gets or sets the default height of record rows.
Gets or sets the default height of summary rows.
Occurs for each cell before a
starts painting and lets users customize the display of cells.
Handling through a
Gets the appearance of this element, If this element is modified; otherwise it
returns a of the first parent element with appearance
in the hierarchy.
Gets or sets the default with
information for cells of this element.
Gets or sets the table-wide properties like the width of the indent column, or whether header rows should be visible.
Represents the method that handles a event which can be
marked as handled.
The source of the event.
A that contains the event data.
Provides data about the event which can be marked as handled.
GridTableQueryCoveredRangeEventArgs is a custom event argument class used by the
event to query information about
covered cells at a specified cell.
This event allows you to specify covered ranges at run-time, e.g when you have
a large grid with repeating patterns of covered ranges. If the specified row and
column index is part of a covered cell's range, you should assign the coordinates
of the covered cell to and
set to True.
indicates that you supplied data
from your event handler and no further querying for data about covered range information
for this cell is necessary.
See the VirtualGrid sample for an example of how to use this event.
Initializes a new instance of the class.
Initalizes a new object.
The
The row index.
The column index.
Initializes a new instance of the .
The
The row index.
The column index.
A that will receive the resulting range for the covered cell.
The Grid table
Provides the functionalities for getting the display member value based on the value member.
This is used for getting the values for sorting based on the display member and filtering based on the display member.
Gets the display member value of the column.
The to get the styles.
The to get the display text.
The to get the data source values.
The display member object value to retrieve the corresponding value member value.
Fills the drop down list items based on the filtered items.
The to get the display text.
The to get the data source values.
Indicates whether exclusive type of drop down.
Implements the class that provides support for serializing and restoring the look and feel of a .
The GridGroupingLookAndFeel maintains a copy for properties of the GridGroupingControl and offers
methods to read and write these settings. After creating a GridGroupingLookAndFeel object from
an XML file, you can apply its settings to a GridGroupingControl.
Initializes a new instance of the class.
Extracts settings from a GridGroupingControl.
The source control.
Applies settings to a GridGroupingControl.
The target control.
Determines a value indicating whether the were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value indicating whether were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value whether were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value indicating whether were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value indicating whether has been modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Resets the property.
Discards any changes for the property.
Determines a value indicating whether were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value indicating whether were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value indicating whether were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines a value indicating whether the were modified
and contents should be serialized or not at design-time.
True if contents were changed; False otherwise.
Discards any changes for the property.
Determines whether were modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Gets the that can be used to
serialize and deserialize this object to XML.
The XML serializer.
Creates an instance of the class from a valid XML stream.
Creates an instance of the class from a valid XML stream.
The XML stream.
An instance of the class.
Creates an instance of the class from a valid XML stream.
The TextReader with XML stream.
An instance of the class.
Saves the settings to an XML stream.
Saves the settings to an XML stream.
An instance of the class.
Saves the settings to an XML stream.
An instance of the class.
Gets or sets the table-wide properties such as the width of the indent column or whether header rows should be visible.
Gets or sets the look of inner groups such as whether the Caption Row is visible or what CaptionText is.
Gets or sets the look of the topmost group such as whether the Caption Row is visible or what CaptionText is.
Gets or sets the look of the topmost group of nested tables such as whether the Caption Row is visible or what CaptionText is.
Gets or sets the default with default
information for all cell elements in the control. This property lets you control almost any aspect of
the appearance of the grouping grid like cell back color, font, or the cell type.
Gets or sets the collection of BaseStyles. Users can add BaseStyles to the engine (also in design time) and
then inherit style settings through the GridStyleInfo.BaseStyle property in
property of .
Gets or sets the VisualStyles (skins) like Office2007, Office2003.
Gets or sets the style of Office2007 scroll bars.
Gets or sets the value indicating whether Office2007 scrollbars should be shown or not.
Gets or sets the style of Office2010 scroll bars.
Gets or sets the grid office scrollbars.
Implements a class that provides event arguments for the and
methods
of the interface.
Initializes a new instance of the class that contains the event data.
The identity object.
The style object.
Specifies the property that is changed.
Gets the identity.
Gets the group options.
Gets the Style info property.
Specifies the property that is changed.
The type converter for objects.
is a . It overrides the method and returns a string with
descriptive information about the properties that were set in the object.
Default Constructor.
Converts the given value object to
the specified destination type using the specified context and arguments.
Format context.
Current culture information.
The value to convert.
The type to convert to.
Converted object.
Properties in this class let you control the look and behavior of the top level group, child groups and nested child tables.
You can control the caption text, where and if AddNewRow will be displayed, or whether captions, footers, previews and summaries are displayed.
GridGroupOptionsStyleInfo supports inheritance properties from parent elements.
Examples for inheritance of properties from parent elements are:
- Group inherits from GridColumnDescriptor.GroupByOptions.
- GridColumnDescriptor.GroupByOptions inherits from GridTableDescriptor.GroupOptions.
- GridTableDescriptor.GroupOptions inherits from GridGroupingControl.GroupOptions
A distinguishes between three different kinds of group options:
- TopLevelGroup: lets you control the look and behavior of the top level group.
- ChildGroupOptions: lets you control the look and behavior of the child groups.
- NestedTableGroupOptions: lets you control the look and behavior of the nested child relations
An empty style object.
Initializes a new style object.
Initializes a new style object and copies all data from an existing style object.
The style object that contains the original data.
Initializes a new style object and associates it with an existing .
A that holds data for this .
All changes in this style object will saved in the object.
Initializes a new style object and associates it with an existing .
A that holds the identity for this .
Initializes a new style object and associates it with an existing .
A that holds the identity for this .
A that holds data for this .
All changes in this style object will saved in the object.
Returns a string holding the current object.
String representation of the current object.
Raises when style info has changed.
Override this method to return a default style object for your derived class.
A default style object.
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Returns a with default settings.
Returns a with default settings for look and behavior of the top level group.
Returns a with default settings for look and behavior of the top level group.
Returns a with default settings for the look and behavior of the nested child relations
Gets or sets the caption text displayed. See the remarks for allowed tokens.
Caption Format Tokens are:
TokenDescription
- {TableName}Displays the CaptionSection.ParentTableDescriptor.Name
- {CategoryName}Displays the CaptionSection.ParentGroup.Name.
- {CategoryCaption}Displays the HeaderText of the column that this group belongs to.
- {Category}Displays the CaptionSection.ParentGroup.Category.
- {RecordCount}Displays the CaptionSection.ParentGroup.GetFilteredRecordCount().
- summary tokensAllows you to display any item you enter as a Summary Column. See discussion below:
Custom Summary Tokens:
Any summary item you add can be included in the CaptionText. You have the option of hiding summaries, so it is possible to add summaries only for the purpose of displaying values in the CaptionText. If you have added a summary row named Row1, and a Summary columns named Column1, then you can also use the value of this summary item in the caption with the token {Row1.Column1}.
When used in ASP.Net you can also use the {PageCount} and {CurrentPage} tokens.
Gets a value that determines if has been initialized for the current object.
Gets or sets the summary row that should be displayed inside CaptionSummaryCells
when ShowCaptionSummaryCells has been set to true.
Gets the value that determines if has been initialized for the current object.
Gets or sets the value indicates whether AddNewRecord can be shown at top of group or not.
Gets the value that determines if has been initialized for the current object.
Gets or sets the value indicates whether AddNewRecord can be shown at bottom of group or not.
Gets the value that determines if has been initialized for the current object.
Gets or sets a value indicates whether the Caption row is visible.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether there is a PlusMinus cell next to the Caption.
Gets the value that determines if has been initialized for the current object.
Gets or sets a value indicates whether the group caption should display summaries in columns instead
of only one large caption bar. The CaptionSummaryRow then lets you specify
a SummaryRow with Summary column information.
Gets a value that determines if has been initialized for the current object.
Indicates whether a header is visible.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether a footer is visible.
Gets the value that determines if has been initialized for the current object.
Gets or sets a value indicates whether summaries are visible.
Gets a value that determines if has been initialized for the current object.
Summaries location.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether the column headers are visible.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether the stacked headers are visible.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether the FilterBar are visible.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether summary items are visible when the group is collapsed.
Gets a value determines if has been initialized for the current object.
Gets or sets a value indicates whether to treat all indent cells for the group as a single covered cell.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether a preview is visible when the group is collapsed.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value indicates whether the caption row should be repainted when a record that belongs to
the group was changed. The setting only has an effect when InvalidateAllWhenListChanged = false.
Gets a value that determines if has been initialized for the current object.
Gets or sets whether groups should be shown expanded initially. IsExpandedInitialValue
will be assigned to groups when the table is categorized, e.g. when GroupedColumns were changed.
This value must be set before the GroupedColumns are changed.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value that indicates whether a preview is visible when group is collapsed.
Gets a value that determines if has been initialized for the current object.
Gets or sets a value that indicates whether the caption bar should be scrolled horizontally or if
it should stay fixed in the view.
Gets a value that determines if has been initialized for the current object.
Returns a collection of custom property objects that have
at least one initialized value. The primary purpose of this
collection is to support design-time code serialization of
custom properties.
GridGroupOptionsStyleInfoStore holds the plain data for a style object excluding identity information.
When persisting style information, are the objects that should be
saved. Identity information can be recreated at runtime when loading cell information but the
cell information must be saved.
GridGroupOptionsStyleInfoStore also holds the static "layout" information for the style.
StaticData contains static variables with the information to access data
in BitVector32 and StyleInfoObjectStore. This information can be shared
among style objects of the same type but collision must be avoided between
style types of different products. Having GridStyleInfoStore and ChartStyleInfoStore
types solves that collision problem.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Initializes a
Initializes a new empty
Initializes a new from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Returns a copy of the current object.
A duplicate of the current object.
Defines the type of group options: TopLevelGroup, ChildTable or inner groups.
Any type of group.
Top-level group.
Child table of a nested relation
Inner groups (grouped by groups)
Summaries locations.
Show Summaries before filter bar.
Show Summaries before details.
Show Summaries after details.
Provides identity information for objects and
methods for inheriting default setting from parent elements.
Releases all resources used by this component.
Initializes the identity object with the host.
Initializes the identity object with the host.
The host for the object.
Initializes the identity object with the host.
The host for the object.
The kind of group options.
Initializes a new and copies its data from an existing object.
The existing object to copy data from.
Overriden. Returns base styles from by calling .
A reference to a
An array of base styles.
Returns a string that represents the current object.
A string that represents the current object.
Occurs when a property in the has changed.
A reference to the that has changed.
Identity for the property to operate on.
Occurs before a property in the is changing.
A reference to the that is changed.
Identity for the property to operate on.
Returns a base style that has specific property initialized.
Style information.
Identity for the property to operate on.
returns StyleInfoBase
The host element.
Gets the results of ToString method.
Represents a class that adds design-time support for custom properties by adding empty custom property
objects and later calling ,
which will result in changing the property for this object
and forces copying all properties of this object to the style object.
The that holds and
gets the data for this custom property object.
Initializes a new instance of the class.
with a that the properties of this
class will belong to.
The that holds and
gets the data for this custom property object.
Determine the style info of custom properties.
The instance of the that holds the values of style properties.
Initializes a new instance of the class with the specified instance of the class.
An instance of the that holds the identity.
Initializes a new instance of the class with the specified instance of the and
class.
An instance of the that holds the style identity values.
An instance of the that holds the style values.
Initializes a new instance of the class
with an empty instance of class. When you later
set the property, the changes in this object
will be copied over to the new object.
The collection adds
design-time support for custom properties by adding empty custom property
objects and later calling ,
which will result in changing the property for this object
and forces copying all properties of this object to the style object.
Registers a new custom property.
>
Registers a new custom property.
The type of your derived custom property class.
The type of the property.
The name of the property. This must match a property member in your class.
A object that you should use for getting and setting
values.
Registers a new custom property.
The type of your derived custom property class.
The name of the property. This must match a property member in your class.
A object that you should use for getting and setting
values.
Registers a new custom property.
The type of your derived custom property class.
The name of the property. This must match a property member in your class.
Specifies attributes for the property.
A object that you should use for getting and setting
values.
Registers a new custom property.
The type of your derived custom property class.
The type of the property.
The name of the property. This must match a property member in your class.
Specifies attributes for the property.
A object that you should use for getting and setting
values.
Registers a for the specified property.
The type of your derived custom property class.
The type of the property.
The name of the property.
The maximal possible Int16 value for the property.
Indicates whether this StyleInfoProperty should be registered as a member of the BitArray and not to allocate
an object reference.
The StyleInfoProperty with information about the property.
Gets or sets the style values of the instances.
The instance of class that holds and
gets the data for this custom property object. When you
set the property, all prior changes in this object
will be copied over to the new instance of the class.
Implements a collection of custom property objects that have
at least one initialized value. The primary purpose of this
collection is to support design-time code serialization of
custom properties.
Initializes a new instance of the class class with a reference
to the parent style object.
The instance of the class.
Copies the initialized properties of the specified custom property
to the parent style object and attaches the custom property object
with the parent style object.
A GridGroupOptionsStyleInfoCustomProperties with
custom properties.
Copies the elements of class to a one-dimensional at the specified index.
The one-dimensional that is the destination of the object's from instance. The must have zero-based indexing.
The zero-based index in at which copying begins.
Copies the elements of the to a starting at a particular index.
The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
The zero-based index in array at which copying begins.
Gets an enumerator that iterates through a collection for the current object.
An object that can be used to iterate through the collection.
Gets a value indicating whether to access to the is synchronized or not (thread safe).
The number of objects in this collection.
Gets an object that can be used to synchronize access to the interface.
Represents a class that adds design-time support for custom properties by adding empty custom property
objects and later calling ,
which will result in changing the property for this object
and forces copying all properties of this object to the style object.
The that holds and
gets the data for this custom property object.
Initializes a new instance of the class
with a that the properties of this
class will belong to.
The that holds and
gets the data for this custom property object.
Initializes a new instance of the class with the specified instances of the class.
An instance of the class.
Initializes a new instances of the class with a specified instance of the
and class.
An instance of the class.
An instance of the class.
Initializes a new instance of the class
with an empty object. When you later
set the property, the changes in this object
will be copied over to the new object.
The collection adds
design-time support for custom properties by adding empty custom property
objects and later calling ,
which will result in changing the property for this object
and forces copying all properties of this object to the style object.
Registers a new custom property.
>
Registers a new custom property.
The type of your derived custom property class.
The type of the property.
The name of the property. This must match a property member in your class.
A object that you should use for getting and setting
values.
Registers a new custom property.
The type of your derived custom property class.
The name of the property. This must match a property member in your class.
A object that you should use for getting and setting
values.
Registers a new custom property.
The type of your derived custom property class.
The name of the property. This must match a property member in your class.
Specifies attributes for the property.
A object that you should use for getting and setting
values.
Registers a new custom property.
The type of your derived custom property class.
The type of the property.
The name of the property. This must match a property member in your class.
Specifies attributes for the property.
A object that you should use for getting and setting
values.
Registers a for the specified property.
The type of your derived custom property class.
The type of the property.
The name of the property.
The maximal possible Int16 value for the property.
Indicates whether this StyleInfoProperty should be registered as a member of the BitArray and not to allocate
an object reference.
The StyleInfoProperty with information about the property.
Gets or sets the style values of the instances.
The that holds and
gets the data for this custom property object. When you
set the property, all prior changes in this object
will be copied over to the new object.
Implements a collection of custom property objects that have
at least one initialized value. The primary purpose of this
collection is to support design-time code serialization of
custom properties.
Initializes a instance of the with a reference
to the parent style object.
An instance of the class.
Copies the initialized properties of the specified custom property
to the parent style object and attaches the custom property object
with the parent style object.
An instances of the with
custom properties.
Copies the elements to a one-dimensional at the specified index.
The one-dimensional that is the destination of the object's from instance. The must have zero-based indexing.
The zero-based index in at which copying begins.
Copies the elements of the System.Collections.ICollection to an System.Array,starting at a particular System.Array index.
The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
The zero-based index in array at which copying begins.
Returns an enumerator that iterates through a collection.
An System.Collections.IEnumerator object that can be used to iterate through the collection.
The number of objects in this collection.
Gets an object that can be used to synchronize access to the System.Collections.ICollection.
Represents a class that provides
a type converter to convert expandable objects to and from various
other representations.
Overrides and determines a value indicating whether this converter can convert the object to the specified type, using the specified context.
An that provides a format context.
A that represents the type you want to convert to.
true if this converter can perform the conversion; otherwise, false.
Converts the given value object to the specified type, using the specified context and culture information.
An that provides a format context.
A . If null is passed, the current culture is assumed.
The to convert.
The to convert the parameter to.
An that represents the converted value.
An entry for the
Initializes a new object.
Initializes a new object.
Initializes a new object.
The Name for GridPropertyTypeDefaultStyle.
Returns the name.
Returns the Name.
Disposes the events.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Copies this object.
Copied object.
Initializes this object with contents from another source.
The source object.
Compares two objects
The object to compare.
True if both objects are equivalent.
Serves as a hash function for a particular type.
A hash code for the current object.
Gets the parent collection
Internal only.
Internal only.
Internal only.
Gets or sets the Name (e.g. System.Boolean)
Specifies if cells of this type should show UITypeEditor, StandardValues
if available.
Gets the default style setting.
Returns whether this converter can convert the object to the specified type,using the specified context.
Converts the given value object to the specified type, using the specified context and culture information.
A collection of with default
information for RecordFieldCell elements
based on the column's System.Type. Each basic type has default style information
registered with this collection.
The collection contains pre-defined settings such as HorizontalAlignment for numbers and
cell type (e.g. CheckBox for boolean).
GridPropertyTypeDefaultStyle settings have less precedence in styles inheritance than
styles.
Note: Changes you make to this collection do not get serialized, you will need
to reapply any changes even if you read back the schema from an XML file.
Disposes the collection.
Used internally.
Initializes an empty collection
Initializes collection from another collection
The source object.
Reset and initialize with default settings.
Used internally.
Creates a copy of this collection.
Copied object.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Adds multiple elements.
An array of elements to add.
Checks if the group belongs to the details section and is visible.
Checks if the group belongs to the details section and is visible.
The given group.
True if it belongs to the details section and is visible.
Checks if collection contains element.
Element name to check.
True if it contains.
Gets the index of the occurence of an GridPropertyTypeDefaultStyle from the GridPropertyTypeDefaultStyleCollection.
Gets the index of the occurence of an GridPropertyTypeDefaultStyle from the GridPropertyTypeDefaultStyleCollection.
The GridPropertyTypeDefaultStyle.
The Index of the GridPropertyTypeDefaultStyle.
Gets the index of the occurence of an element.
Element name.
returns the Index of the element.
Copies the elements to an array
The Array of GridPropertyTypeDefaultStyle.
Index to copy.
Internal only.
The GridPropertyTypeDefaultStyleCollectionEnumerator
Inserts an element
The Index.
Value to insert.
Removes an element
Value to remove.
Adds a new element
Value to add.
Index of the new value.
Adds a new element.
Element name.
Index of the new element.
Removes an element.
Name of the element to be removed.
Removes an element.
Index of the element to be removed.
Clears the collection
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Returns a string that represents the current object.
A string that represents the current object.
Internal only.
The default collection
Internal only.
Internal only.
Internal only.
Gets or sets the element at an index
Gets or sets the element with the specified name.
Returns False.
Returns False.
Returns False.
The number of elements in this collection.
Internal only.
Internal only.
Enumerator class for elements of a .
Initializes the enumerator
The collection.
Resets the enumerator
Moves to the next position
True if next element exists.
Returns the current element
Internal only.
Disposes the object.
Internal only.
Used internally.
Overridden. Returns base styles from by calling .
A reference to a .
An array of base styles.
Returns a string that represents the current object.
A string that represents the current object.
Overridden. If the style is not off line, saves its changes in the .
A reference to the object.
The that identifies the changed style property.
Property Owner (GridPropertyTypeDefaultStyle).
Provides identity information for a object.
Initializes the identity object for a .
The base style object.
Returns an array with base styles for the specified style object.
The style object.
An array of style objects that are base styles for the current style object.
Gets the base style object.
The type converter for objects. The
is a . It overrides the default behavior of the
ConvertTo method and adds support for design-time code serialization.
Default Constructor.
Indicates whether this object can be converted to the specified type.
Format context.
The type
you want to convert to.
True if this conversion is allowed.
Converts the given value to the specified type.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Gets a collection of properties for the specified type.
Format context.
Value specifying the type.
An array of System.Attribute objects that will be used as a filter.
A list of properties.
The type converter for the string of a
.
overrides the GetStandardValues method and returns possible BaseStyles from
the of the .
Default Constructor.
Returns a collection of standard values for the data type this type converter is
designed for when provided with a format context.
Format
context that can be used to extract additional information about the environment
from which this converter is invoked. This parameter or properties of this
parameter can be null.
A
that holds a standard set of valid values, or null if the data type does not
support a standard set of values.
Returns whether the collection of standard values returned from is an
exclusive list of possible values, using the specified context.
A format
context.
true if the
returned from is an
exhaustive list of possible values; false if other values are possible.
Returns whether this object supports a standard set of values that can be picked
from a list, using the specified context.
A format context.
returns true
Returns whether this converter can convert an object of the given type to the
type of this converter, using the specified context.
A format
context.
The type
you want to convert from.
true if this converter can perform the conversion; otherwise, false.
Converts the given object to the type of this converter, using the specified
context and culture information.
A format
context.
Current culture information.
The to convert.
An that represents the converted value.
A GridTableBaseStyle
declares BaseStyles for the whole engine.
GridTableBaseStyles are managed by the which
is returned by the property
of a .
Returns a string holding the current object.
String representation of the current object.
Initializes a new empty object.
Initializes a new object with a name.
The name of the GridTableBaseStyle.
Gets the name of the descriptor.
The name of this descriptor. This name is used to look up the summary in the
.
Resets the style.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Creates a copy of this descriptor.
A copy of this descriptor.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Checks if name is not empty.
True if not empty; False if empty.
Resets the name to empty string.
Determines if style information has been set and should be serialized into code at design-time.
True if style information has been set; False otherwise.
Resets style information.
Occurs when a property is changed.
Occurs before a property is changed.
Gets the collection this descriptor belongs to.
Gets or sets the name of this descriptor. This name is used to look up the summary in the
.
Gets or sets the style information for this base style.
A collection from that
declares BaseStyles for the whole engine.
An instance of this collection
is returned by the property
of a .
A Read-only and empty collection.
Returns a string that represents the current object.
A string that represents the current object.
Ensures type correctness when a new element is added to the collection.
The newly added object.
Copies settings from another collection and raises and
events if differences to the other collection are detected.
The source collection.
Initializes a new empty collection.
Initializes a new empty collection.
Clears the collection.
Adds multiple elements at the end of the collection.
The array with elements that should be added to the end of the collection.
The array and its elements cannot be NULL references (Nothing in Visual Basic).
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Creates a new empty GridTableBaseStyle with the specified name.
The name of the new base style.
A new GridTableBaseStyle.
Creates a copy of the collection and all its elements.
A copy of the collection and all its elements.
Creates a copy of this collection and all its inner elements. This method is called from Clone.
A copy of the collection and all its elements.
Called from InternalClone to create a new collection and attach it to the specified table descriptor
and insert the specified columns. The BaseStyle objects have already been cloned.
The GridEngine.
The cloned base styles.
A new GridTableBaseStyleCollection.
Determines whether the specified is equal to the
current .
The to compare with the current
.
true if the specified is equal to the current
; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current object.
Compares each element with the element of another collection.
The collection to compare to.
True if all elements are equal and in the same order; False otherwise.
Determines if the element belongs to this collection.
The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
True if item is found in the collection; otherwise, False.
Searches for the element with the specified name.
The name of the element to locate in the collection.
True if item is found in the collection; otherwise, False.
Returns the zero-based index of the occurrence of the element in the collection.
The element to locate in the collection. The value can be a NULLreference (Nothing in Visual Basic).
The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.
Searches for the element with the specified name.
The name of the element to locate in the collection.
The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
The zero-based index in an array at which copying begins.
Returns an enumerator for the entire collection.
An Enumerator for the entire collection.
Enumerators only allow reading the data in the collection.
Enumerators cannot be used to modify the underlying collection.
Inserts a descriptor element into the collection at the specified index.
The zero-based index at which the element should be inserted.
The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).
Removes the specified descriptor element from the collection.
The element to remove from the collection. If the value is NULL or the element is not contained
in the collection the method will do nothing.
Adds an object to the end of the collection.
The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Called to get a new default name when a new BaseStyle is created (e.g. when pressing "Add" in a collection editor).
The base style to be named.
Adds an object to the end of the collection.
The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).
The zero-based collection index at which the value has been added.
Called from Add(string name) to create a new base style with the given name.
The name of the new base style.
A new GridTableBaseStyle
Removes the specified descriptor element with the specified name from the collection.
The name of the element to remove from the collection. If no element with that name is found
in the collection, the method will do nothing.
Removes the element at the specified index of the collection.
The zero-based index of the element to remove.
Disposes the object and collection items.
Removes all elements from the collection.
Inserts an item to the System.Collections.IList at the specified index.
The zero-based index at which value should be inserted.
The object to insert into the System.Collections.IList.
Removes the first occurrence of a specific object from the System.Collections.IList.
The object to remove from the System.Collections.IList.
Determines whether the System.Collections.IList contains a specific value.
The object to locate in the System.Collections.IList.
true if the System.Object is found in the System.Collections.IList; otherwise,false.
Determines the index of a specific item in the System.Collections.IList.
The object to locate in the System.Collections.IList.
The index of value if found in the list; otherwise, -1.
Adds an item to the System.Collections.IList.
The object to add to the System.Collections.IList.
The position into which the new element was inserted, or -1 to indicate that
the item was not inserted into the collection.
Copies the elements of the System.Collections.ICollection to an System.Array,
starting at a particular System.Array index.
The one-dimensional System.Array that is the destination of the elements
copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
The zero-based index in array at which copying begins.
Returns an enumerator that iterates through a collection.
An System.Collections.IEnumerator object that can be used to iterate through the collection.
Copies a BaseStyle and all BaseStyles it depends on into an array.
The name of the base style.
The maximum number of levels to look at when walking referenced
BaseStyles.
An array of objects with the first BaseStyle and all BaseStyles it depends on.
Occurs after a property in a nested element or the collection is changed.
Occurs before a property in a nested element or the collection is changed.
Gets or sets whether the collection is manipulated inside a collection editor.
The version number of this collection. The version is increased each time the
collection or an element within the collection was modified.
Gets or sets whether the collection is modified from its default state.
Gets or sets the element at the zero-based index.
Gets or sets the element with the specified name.
Determines if the collection is Read-only.
Returns normally False since this collection has no fixed size. Only when it is Read-only
IsFixedSize returns True.
Returns False.
Gets the number of elements contained in the collection. The property also
ensures that the collection is in sync with the underlying
table if changes have been made to the table or the TableDescriptor.
Gets or sets the element at the specified index.
The zero-based index of the element to get or set.
The element at the specified index.
Gets an object that can be used to synchronize access to the System.Collections.ICollection.
Enumerator class for elements of a .
Initializes the enumerator and attaches it to the collection.
The parent collection to enumerate.
Sets the enumerator to its initial position, which is before the first element in the collection.
Advances the enumerator to the next element of the collection.
True if the enumerator was successfully advanced to the next element; False if the enumerator has passed the end of the collection.
Gets the current element in the collection.
Defines cell types used by . For each GridTableCellType,
the can be modified in a .
Represents None.
Any cell in the grid.
Any record cell.
Any nested table cell.
Any cell in a group item.
Any summary cell.
Any header cell.
Any indent cell.
Any preview cell.
Empty cells.
The top-left header cell.
Any row header cell.
Column header cell.
Filter bar header cell.
Any header cell in a record row.
Any header cell in a record preview row.
Any header cell in a group footer.
Any header cell in a group header.
Any header cell in a group preview section.
Any header cell in a new record row.
Any header cell in an alternate record row.
Any cell in a group caption.
Any filter bar row header cell.
Any row header cell in an empty section.
PlusMinus cell in a record row.
Field cell in a non-alternate record row.
Field cell in an alternate record row.
Field cell in new record row.
Cell in record preview row.
Cell in group preview section.
Row header cell in parent table for rows with indented nested table.
Indent cell in parent table for rows with indented nested table.
Indent cell with T-line in parent table for rows with indented nested table.
Indent cell with closing L-line in parent table for rows with indented nested table.
Indent cell with continuous I-line in parent table for rows with indented nested table.
The nested table cell in which the nested table is drawn.
Indent cell in group.
Indent cell with continuous I-line in group.
Indent cell with T-line in group.
Indent cell with closing L-line in group.
PlusMinus cell in group caption.
Group caption cell.
Any cell in group header section.
Any cell in group footer section.
Indent cell in group header section.
Indent cell in group footer section.
Field cell in filter bar.
Field cell in summary row.
Field cell in summary row with GridSummaryStyle.FillRow.
Title cell in summary row.
Row header cell in summary row.
Empty cell in summary row.
Summary cell in caption bar.
Stacked header cells.
The type converter for objects. The
is an . It overrides the method and returns only appearance properties
that were not filtered out with of the object.
Gets a collection of properties for the specified type.
Format context.
Value specifying the type.
An array of System.Attribute objects.
A list of properties.
Gets a value indicating whether this object supports properties using the
specified context.
Fformat
context.
true because
should be called to find the properties of this object. This method never
returns false.
The class stores
information for all cell elements in a grouping grid. GridTableCellAppearance has
an inheritance mechanism that allows child elements to inherit default settings from
parent elements. GridTableCellAppearance lets you control almost any aspect of
the appearance of the grouping grid such as cell back color, font, or the cell type.
GridTableCellAppearance supports both inheritance of style properties from parent elements and
also inheritance of style settings within cell elements of one appearance object.
Inheritance of style settings within cell elements of one appearance object has higher precedence
than inheritance of style properties from parent elements.
Examples for inheritance of style properties from parent elements are:
- RecordField inherits from GridColumnDescriptor.Appearance and GridRecord.Appearance.
- GridRecord.Appearance inherits from ParentGroup.Appearance.
- ParentGroup.Appearance inherits from TableDescriptor.Appearance.
Inheritance of style properties is defined by the
object. It has a method that returns
the objects that form an inheritance chain. Check the
method to get string / debug
information about the inheritance chain for a specific element. Also, the designer will show
this debug information about the inheritance chain in a ToolTip when you hover the mouse over
a cell within the "Preview and Edit" window.
Inheritance of style settings within cell elements of one appearance object is defined as follows:
TableCellTypeInherits from
- None
- None
- AnyCell
- AnyHeaderCell, AnyCell
- AnyCell
- AnyCell
- AnyHeaderCell, AnyCell
- ColumnHeaderCell, AnyHeaderCell, AnyCell
- AnyHeaderCell, AnyCell
- AnyHeaderCell, AnyCell
- AnyRecordFieldCell, AnyCell
- AnyCell
- AnyNestedTableCell, AnyCell
- AnyIndentCell, AnyNestedTableCell, AnyCell
- AnyNestedTableCell, AnyCell
- AnyHeaderCell, AnyCell
- AnyRecordFieldCell, AnyCell
- RowHeaderCell, AnyHeaderCell, AnyCell
- AnyRecordFieldCell, AnyCell
- RowHeaderCell, AnyHeaderCell, AnyCell
- AnyRecordFieldCell, AnyCell
- RowHeaderCell, AnyHeaderCell, AnyCell
- AnyCell
- AnyIndentCell, AnyGroupCell, AnyCell
- GroupIndentCell, AnyIndentCell, AnyGroupCell, AnyCell
- GroupIndentCell, AnyIndentCell, AnyGroupCell, AnyCell
- GroupIndentCell, AnyIndentCell, AnyGroupCell, AnyCell
- AnyGroupCell, AnyCell
- AnyRecordFieldCell, AnyCell
- AnyGroupCell, AnyCell
- RowHeaderCell, AnyHeaderCell, AnyCell
- AnyCell
- RowHeaderCell, AnyHeaderCell, AnyCell
- AnyCell
- AnySummaryCell, AnyCell
- AnySummaryCell, AnyCell
- AnySummaryCell, AnyCell
- RowHeaderCell, AnyHeaderCell, AnyCell
- AnySummaryCell, AnyCell
- AnyCell
- AnyCell
- GroupIndentCell, AnyIndentCell, AnyCell
- GroupIndentCell, AnyIndentCell, AnyCell
- AnyCell
- AnyPreviewCell, AnyCell
- AnyPreviewCell, AnyCell
- RowHeaderCell, AnyCell
- RowHeaderCell, AnyCell
- RowHeaderCell, AnyCell
- RowHeaderCell, AnyCell
Initializes a new appearance object.
Initializes a new appearance object.
Initializes a new appearance object.
The parent element that hosts this appearance object and receives notification about changes.
Sets the owner.
The parent element that hosts this appearance object and receives notification about changes.
Returns a string that represents the current object.
A string that represents the current object.
Initializes this object and copies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised.
The source object.
Applies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised. All properties that are specified in the other appearance
will be applied using StyleModifyType.Override.
The source object.
Applies properties from another object.
and events are raised for every property that is modified. If both
objects are equal, no events are raised. Properties that are specified in the other appearance
will be applied using the specified StyleModifyType.
The source object.
The source style modify type.
Determines if the for the specified
is modified.
Specifies the cell type.
True if the is modified; False if all properties are default.
Resets all properties in the for the specified
back to default values.
Specifies the cell type.
Returns a reference to the for the specified .
Specifies the cell type.
The for the specified .
Returns an array of style objects representing the inheritance chain of style settings within cell elements of the appearance object for
the specified table cell type.
Returns an array of style objects representing the inheritance chain of style settings within cell elements of the appearance object for
the specified table cell type.
The table cell type.
An array of GridTableCellStyleInfo.
Returns an array of style objects representing the inheritance chain of style settings within cell elements of the appearance object for
the specified table cell type.
The table cell type.
Indicates if style objects that were not modified from their default settings should be included. If True, a NULL object
is added to the array for default styles; otherwise the empty style object is added.
An array of GridTableCellStyleInfo.
Gets a string that indicates parent styles within the appearance object for the specified table cell element.
The table cell type.
A string with debug information.
Resets all styles within the appearance object.
Initializes the appearance. Any appearance will inherit default settings
that were not initialized from the appearance.
Raises the event.
A that contains the event data.
Raises the event.
A that contains the event data.
Defines styles to show in a property grid for the Appearance object of a
and .
Defines styles to show in a property grid for the Appearance object of a
.
Defines styles to show in a property grid for the Appearance object of a
.
Defines styles to show in a property grid for the Appearance object of a
.
Defines styles to show in a property grid for the GroupByApperance object of a
.
Determines whether has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and contents should be serialized at design-time.
True if contents were changed; False otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Determines whether has been modified
and its contents should be serialized at design-time.
true if contents were changed; false otherwise.
Discards any changes for the object.
Disposes of the object and inner style object.
Gets the parent element that hosts this appearance object.
Returns True if any style of the appearance object was modified; False if all are default.
Returns True if all styles of the appearance object are default; False if any are modified.
Returns whether the object can be modified.
The appearance. Any appearance will inherit default settings
that were not initialized from the appearance.
Occurs after a style is changed.
Occurs before a style is changed.
Defines styles to show in a property grid for this appearance object at design-time.
Gets or sets the with cell settings for
any cell in the grid.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
cells in record preview row.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any cell in group header section.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any cell in the group footer section.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells in the group header section.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells in the group footer section.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any header cell in a record preview row.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See the overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any header cell in a group preview section.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See the overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any header cell in a group footer.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any header cell in a group header.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
cells in group preview section.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any preview cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any header cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any indent cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
empty cell in summary rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
column header cells.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
stacked header cells.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
filter bar header cells.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
the top-left header cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
row header cells in an empty section.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
headers cell in non-alternate record rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
header cells in a new record row.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
header cells in alternate record rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
row header cells in the same row as a group caption.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any filter bar row header cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
row header cells in summary row.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
PlusMinus cells in a record row.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any cells related to nested tables.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
row header cells in parent table for rows with indented nested tables.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells in parent table for rows with indented nested tables.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells with closing L-line in parent table for rows with indented nested tables.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells with T-lines in parent table for rows with indented nested tables.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells with continuous I-line in parent table for rows with indented nested tables.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
nested table cells in which the child table is drawn.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any record field cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
field cells in the non-alternate record row.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
field cells in alternate record rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
field cells in new record row.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any group-related cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells in groups.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells with closing L-line in groups.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells with T-lines in groups.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
indent cells with continuous I-lines in groups.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
group caption cells.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
the PlusMinus cell in group captions.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See the overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
field cells in filter bars.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
any summary cell.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
field cells in summary rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
field cells in summary rows with GridSummaryStyle.FillRows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
the title cell in summary rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
row header cells in summary rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
empty cells in summary rows.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Gets or sets the with cell settings for
summary cells in the caption bar.
When you assign a new object, the setter will
not assign a reference to the object. Instead all properties of the new style object
will be copied over to the existing style object.
See overview for information on inheritance of
style settings.
Represents a class that provides identity information for a object of a
and defines the inheritance of style properties.
Inheritance of style properties is defined by the
object. It has a method that returns
the objects that form an inheritance chain. Check the
method to get string / debug
information about the inheritance chain for a specific element. Also, the designer will show
this debug information about the inheritance chain in a ToolTip when you hover the mouse over
a cell within the "Preview and Edit" window.
Overrides and manages the unwanted resources.
Initializes a new instance of the class.
The An instance of the class.
The parent that owns the object.
The that uniquely identifies the
with the that owns it.
Initializes a new instance of the class and copies its data from an existing object.
The existing object to copy data from.
Adds the style for the Appearance.
An array that holds the values for the style instances.
The instance of the that holds the style info of all the cells.
Overrides and gets the base styles for the current object.
Inheritance of style properties is defined by the
object. It has a method that returns
the objects that form an inheritance chain. Check the
method to get string / debug
information about the inheritance chain for a specific element. Also, the designer will show
this debug information about the inheritance chain in a ToolTip when you hover the mouse over
a cell within the "Preview and Edit" window.
A reference to a interface.
An array of base styles.
Overrides and gets the string format of the current object.
A string that represents the current object.
Overrides and raises the event.
The StyleInfoBase instance that has changed.
An identity for the property to operate on.
Overrides and raises the event.
The StyleInfoBase instance that has changed.
An identity for the property to operate on.
Gets or sets the that owns the object.
Gets or sets the that uniquely identifies the
with the that owns it.
Gets the this object belongs to.
Gets the string format of the current object.
Represents a method that handles an event with .
The source of the event.
The event data.
Represents a class that provides data about and
events raised by which occur when a style property of a
is changed.
Initializes a new instance of the class with the specified instance of the class that the style object belongs to and the that uniquely identifies the .
Initializes a new instance of the class with the specified instance of the that uniquely identifies the classes.
The parent that owns the object.
The that uniquely identifies the
with the that owns it.
Initializes a new instance of the class with the specified instance of the and classes.
The parent instance of the class that owns the instance of the class.
The that uniquely identifies the instance of
with the that owns it.
The contains the event data.
Gets the parent instance of the that owns the instance of the class.
Gets the enum value of that uniquely identifies the
with the that owns it.
Gets the value of the instances of class.
Represents a method that handles an event with .
The source of the event.
The contains the event data.
Represents a class that provides the data about
events raised by and which occur
for each cell before a grid
starts painting and lets users customize the display of cells.
Initializes a new instance of the class object with GridTableCellStyleInfoIdentity, GridTableCellStyleInfo and the StyleInfoProperty that was modified.
The identity object.
The style object.
Specifies the property that is changed.
Gets the identity object.
Gets the style instance style of the object.
Specifies the property that is changed.
Provides identity information for a object that is
created by for each cell in the grid. GridTableCellStyleInfoIdentity
defines the inheritance of style properties from parent elements inside the grid.
Inheritance of style properties is defined by the
object. It has a method that returns
the objects that form an inheritance chain. Check the
method to get string / debug
information about the inheritance chain for a specific element. Also, the designer will show
this debug information about the inheritance chain in a ToolTip when you hover the mouse over
a cell within the "Preview and Edit" window.
Compares two objects if they are equal. Works also with NULL references.
The first object to compare.
The second object to compare.
True if both objects are equal.
Disposes the current object.
Initializes the identity object with a reference to the volatile data cache, row, and column index.
Reference to the volatile data cache.
The row index.
The column index.
Initializes a new and copies its data from an existing object.
The existing object to copy data from.
Returns the this object belongs to.
The engine object.
Overridden. Returns base styles that define the inheritance of style properties.
Inheritance of style properties is defined by the
object. It has a method that returns
the objects that form an inheritance chain. Check the
method to get string / debug
information about the inheritance chain for a specific element. Also, the designer will show
this debug information about the inheritance chain in a ToolTip when you hover the mouse over
a cell within the "Preview and Edit" window.
A reference to a .
An array of base styles.
Used internally.
Used internally.
Used internally.
Used internally.
Used internally.
Debug helper.
An array of styles.
Gets a string that indicates parent styles within the appearance object for the specified table cell element.
A string with debug information.
Returns a for the specified id / cell type name.
Cell type name.
The for the given id.
Calls .
Returns the this style belongs to or NULL if the style is used outside a grid model.
A reference to the grid model or NULL if the style is used outside a grid model.
Returns the active for the this style belongs to or NULL
if the style is used outside a grid model.
A reference to the grid control base or NULL if the style is used outside a grid model.
Returns a string holding the current object.
String representation of the current object.
Occurs when a property in is changed.
The instance that was changed.
An identity for the property to operate on.
The for the grouped column, if this cell is associated with a
column that is grouped by, e.g. if this is a caption cell or an indent cell.
Gets or sets the Grid table.
The that created this object.
Gets or sets the cell type of Grid table.
The that specifies what kind of cell this is.
Gets or sets the display element of the row.
The column this cell displays if it is RecordFieldCell, column header cell, or any cell associated with a
.
Gets or sets the stacked header descriptor,if it is StackedHeaderCell.
The summary this cell displays if it is Summary cell or any cell associated with a
.
The summary this cell displays if it is Summary cell or any cell associated with a
.
Results of ToString method.
The type converter for objects.
is a . It overrides the method and returns a string with
descriptive information about the properties that were set in the object.
Default Constructor.
Converts the given value object to
the specified destination type using the specified context and arguments.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Holds the plain data for a style object excluding identity information.
Initializes a .
Initializes a new empty .
Initializes a new from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
Returns a duplicate of the current object.
A duplicate of the current object.
Gets the Static data source.
Lets you control almost any aspect of the appearance of the grouping grid like cell backcolor,
font, or the cell type. Objects of this class are accessible through the
class, e.g. the property.
The class stores
information for all cell elements in a grouping grid. GridTableCellAppearance has
an inheritance mechanism that allows child elements to inherit default settings from
parent elements. GridTableCellAppearance lets you control almost any aspect of
the appearance of the grouping grid like cell backcolor, font or the cell type.
GridTableCellAppearance supports both inheritance of style properties from parent elements and
also inheritance of style settings within cell elements of one appearance object.
Inheritance of style properties is defined by the
object. It has a method that returns
the objects that form a inheritance chain. Check the
method to get a string/debug
information about the inheritance chain for a specific element. Also, the designer will show
this debug information about inheritance chain in a tooltip when you hover the mouse over
a cell within the "Preview and Edit" window.
An empty style object.
Initializes a new style object.
Initializes a new style object and copies all data from an existing style object.
The style object that contains the original data.
Initializes a new style object and associates it with an existing .
A that holds data for this .
All changes in this style object will saved in the object.
Initializes a new style object and associates it with an existing .
A that holds the identity for this .
Initializes a new style object and associates it with an existing .
A that holds the identity for this .
A that holds data for this .
All changes in this style object will saved in the object.
Resets .
Gets the GridTableCellStyleInfoIdentity for a style, checks also the InnerIdentity of the
Identity.
The style object.
The TableCellIdentity if found; NULL otherwise.
Resets .
Checks whether this style object has a GridTableCellStyleInfoIdentity attached.
Returns the GridTableCellStyleInfoIdentity object with Identity information about this style object.
Specifies the BaseStyle for this style instance with default values for properties that are not initialized for this style object.
Gets the value of the grouping grid UIA provider
Contains cell type information of a cell.
Represents a class that provides identity information for a temporary object
that is created by the of a
just before a cell is drawn and disposed afterwards.
Changes made to style properties that have a GridTableCellViewStyleInfoIdentity object are not
permanent. When the object is disposed, any changes are discarded. This has the benefit that
you can change temporary the style settings for drawing the cell.
Initializes a new instance of the identity object.
The parent style object.
The Identity object of the object.
Overrides and manages the unwanted resources.
Overrides and gets the BaseStyles that holds the style properties.
Inheritance of style properties is defined by the
object. It has a method that returns
the objects that form an inheritance chain. Check the
method to get string / debug
information about the inheritance chain for a specific element. Also, the designer will show
this debug information about the inheritance chain in a ToolTip when you hover the mouse over
a cell within the "Preview and Edit" window.
A reference to a .
An array of BaseStyles.
Triggered when the event is done.
A StyleInfoBase instance that was changed.
An identity for the property to operate on.
Gets or sets the parent style object.
Gets or sets the Identity of the property.
Represents the class that provides event arguments for the
and methods
of the interface.
Initializes a new instance of the class with the specified instance of the ,
and that were modified.
An instance of the class.
An instance of the class.
An instance of the class and which specifies the changed property.
Gets the identity instance.
Gets the style instance.
Gets the property that is changed.
The type converter for objects.
is a . It overrides the method and returns a string with
descriptive information about the properties that were set in the object.
Default Constructor.
Converts the given value object to
the specified destination type using the specified context and arguments.
Format context.
Current culture information.
Value to convert.
Target type.
Converted object.
Properties in this class let you control the look and behavior of the top level group, child groups, and nested child tables.
You can control the caption text, where and if AddNewRow will be displayed, or whether captions, footers, previews, and summaries will be displayed.
GridGroupOptionsStyleInfo supports inheritance properties from parent elements.
Examples for inheritance of properties from parent elements are:
- Group inherits from GridColumnDescriptor.GroupByOptions.
- GridColumnDescriptor.GroupByOptions inherits from GridTableDescriptor.GroupOptions.
- GridTableDescriptor.GroupOptions inherits from GridGroupingControl.GroupOptions
A distinguishes between three different kinds of group options:
- TopLevelGroup lets you control the look and behavior of the top level group.
- ChildGroupOptions lets you control the look and behavior of the child groups.
- NestedTableGroupOptions lets you control the look and behavior of the nested child relations.
An empty style object.
Initializes a new style object.
Initializes a new style object and copies all data from an existing style object.
The style object that contains the original data.
Initializes a new style object and associates it with an existing .
A that holds data for this .
All changes in this style object will be saved in the object.
Initializes a new style object and associates it with an existing .
A that holds the identity for this .
Initializes a new style object and associates it with an existing .
A that holds the identity for this .
A that holds data for this .
All changes in this style object will be saved in the object.
Returns a string holding the current object.
String representation of the current object.
Override this method to return a default style object for your derived class.
A default style object.
Resets the .
Resets .
Resets .
Resets the .
Indicates whether the specified property has been initialized for current project.
Returns the boolean value to indicate TableIndentProperty has been initialized or not.
Resets the .
Indicates whether the specified property has been initialized for current project.
Returns the boolean value to indicate RowHeaderProperty has been initialized or not.
Resets .
Resets .
Resets .
Indicates whether the specified property has been initialized for current project.
Provides information about the
Resets .
Resets .
Resets the .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Resets .
Returns a with default settings.
Gets or sets a value indicating whether filter bar should be shown or not.
Determines if the has been initialized for the current object.
Gets or sets a value indicating whether a nested table has a preview row or not. Only applicable for nested tables.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether a PlusMinus cell should appear next to records or not. Only applicable for nested tables.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether children of the records in the parent table should be indented or not. Only applicable for nested tables.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the row header column should be visible or not.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the cells in a particular indent level are treated as a single covered cell or not. Only applicable for nested tables.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the row header cells for a particular nested table are treated as a single covered cell or not. Only applicable for nested tables.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the column header should be shown with Filter button or not.
Determines if has been initialized for the current object.
Gets or sets the width in pixels of the indentation of each child group.
Determines if has been initialized for the current object.
Gets or sets the width in pixels of the row header cells.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the record previews.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the record rows.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the caption rows.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the column header rows.
Determines if has been initialized for the current object.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the group footers.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the group previews.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the group headers.
Determines if has been initialized for the current object.
Determines if has been initialized for the current object.
Gets or sets the height in pixels of the summary rows. The value -1 is a special setting to indicate the summary row height should always be the same as the RecordRowHeight.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the PlusMinus cells are shown connected with lines or not.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the user can click on column headers to sort them.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the user can ctrl-click on additional column headers to sort by multiple columns.
Determines if has been initialized for the current object.
Indicates whether the grid can show a drop-down list for cells in this column if
column represents a foreign key field from a related table.
Determines if has been initialized for the current object.
Gets or sets a value indicating whether the user can drag column headers and rearrange the order of columns.
Determines if has been initialized for the current object.
Gets or sets the style of the line to draw the tree lines.
Determines if has been initialized for the current object.
Gets or sets the style of the line used to draw the grid lines.
Determines if has been initialized for the current object.
Defines selection behavior of the grid. When you set this property GridSelectionFlags.None and
specify then a record-based selection mechanism is used. If you
set this property to a value different from GridSelectionFlags.None a 2.x version compatible
selection mechanism is used.
A that specifies options to be applied.
Starting version 3.x the GridGroupingControl now supports multiple record selection and navigation
across nested tables. In order to use the new record selection mechanism you need to set
TableOptions.ListBoxSelection = SelectionMode.XYZ and make sure that
TableOptions.AllowSelection = GridSelectionFlags.None. Optional settings can be specified
with TableOptions.ListBoxSelectionColorOptions and TableOptions.ListBoxSelectionCurrentCellOptions.
With the new record-based selection mode selected records can be found in Table.SelectedRecords collection.
If you specify a different value for TableOptions.AllowSelection other than GridSelectionFlags.None
the grid will operate in a backward-compatible mode and continue to use the old selection mechanism
that was in place with 2.x and 1.x versions of the GridGroupingControl.
Use TableOptions.AllowSelection only if you explicitly want the old selection behavior,
e.g. if you want to be able to select individual cells or want to use Excel-like selection behavior.
With the backward compatible selection mode selected rows and cells can be found in TableModel.Selections.Ranges collection.
Determines if has been initialized for the current object.
Lets you specify behavior and appearance of the current cell when ListBoxSelectionMode was set
Determines if has been initialized for the current object.
Lets you specify the appearance of selected cells
Determines if has been initialized for the current object.
Indicates whether child records of a record should automatically be selected when a parent record is selected (when using multiple selection listbox mode).
Determines if has been initialized for the current object.
Lets you specify a border that should be drawn around a block of selected records.
Determines if has been initialized for the current object.
The background color for selected records.
Determines if has been initialized for the current object.
The text color for selected records.
Determines if has been initialized for the current object.
Enables list box-like selection behavior for the grid when the user moves the current cell.
When you set to GridSelectionFlags.None and
specify then a record-based selection mechanism is used. If you
set this property to a value different from GridSelectionFlags.None a 2.x version compatible
selection mechanism is used.
A that defines the list box-like selection behavior of the grid.
Starting version 3.x the GridGroupingControl now supports multiple record selection and navigation
across nested tables. In order to use the new record selection mechanism you need to set
TableOptions.ListBoxSelection = SelectionMode.XYZ and make sure that
TableOptions.AllowSelection = GridSelectionFlags.None. Optional settings can be specified
with TableOptions.ListBoxSelectionColorOptions and TableOptions.ListBoxSelectionCurrentCellOptions.
With the new record-based selection mode selected records can be found in Table.SelectedRecords collection.
If you specify a different value for TableOptions.AllowSelection other than GridSelectionFlags.None
the grid will operate in a backward-compatible mode and continue to use the old selection mechanism
that was in place with 2.x and 1.x versions of the GridGroupingControl.
Use TableOptions.AllowSelection only if you explicitly want the old selection behavior,
e.g. if you want to be able to select individual cells or want to use Excel-like selection behavior.
With the backward compatible selection mode selected rows and cells can be found in TableModel.Selections.Ranges collection.
Determines if has been initialized for the current object.
Gets or sets the VisualStyles (skins) like Office2010, Office2007, Office2003
Each of the components that is incorporated into the Grouping Grid is being affected with Visual Styles.
Choosing one of the options will change the look and feel of the individual grid elements.
The VisualStyles can be set by assigning a enumeration value to the GridVisualStyles property
this.gridGroupingControl1.TableOptions.GridVisualStyles = GridVisualStyles.Office2007Blue;
Me.GridGroupingControl1.TableOptions.GridVisualStyles = GridVisualStyles.Office2007Blue
Determines if has been initialized for the current object.
Gets or sets the Skin values for the Grid.
Determines if has been initialized for the current object.
Gets or sets the maximum size for the drop-down table of a foreign key related table.
Determines if has been initialized for the current object.
Gets or sets the maximum size for the drop-down part of a filter bar choice list.
Determines if has been initialized for the current object.
Gets or sets the number of rows to be evaluated for GridColumnsMaxLengthStrategy.FirstNRecords strategy.
Determines if has been initialized for the current object.
Defines strategy for resizing columns to optimal width.
Determines if has been initialized for the current object.
Gets or sets the default width for columns.
Determines if has been initialized for the current object.
Gets or sets whether this table should support pixel scrolling. Note: You also need to
have YAmountCounter enabled (see Engine.CounterLogic).
Determines if has been initialized for the current object.
Gets or sets a value indicating whether text should be drawn using GDI interop drawing routines.
Determines if has been initialized for the current object.
Returns a collection of custom property objects that have
at least one initialized value. The primary purpose of this
collection is to support design-time code serialization of
custom properties.
GridTableOptionsStyleInfoStore holds the plain data for a style object excluding identity information.
When persisting style information, are the objects that should be
saved. Identity information can be recreated at run-time when loading cell information but the
cell information must be saved.
GridTableOptionsStyleInfoStore also holds the static "layout" information for the style.
StaticData contains static variables with the information to access data
in BitVector32 and StyleInfoObjectStore. This information can be shared
among style objects of the same type but collision must be avoided between
style types of different products. Having GridStyleInfoStore and ChartStyleInfoStore
types solves that collision problem.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Provides information about the property.
Initializes a .
Initializes a new empty .
Initializes a new from a serialization stream.
An object that holds all the data needed to serialize or deserialize this instance.
Describes the source and destination of the serialized stream specified by info.
A copy of the current object.
A duplicate of current object.
Gets the Static data source.
Defines the type of TableOptions.
TableOptions for the main table.
TableOptions for child tables.
Provides identity information for objects and
methods for inheriting default setting from parent elements.
Disposes the current object.
Initializes the identity object with the host.
Initializes the identity object with the host.
The host for the object.
Initializes the identity object with the host.
The host for the object.
The kind of group options.
Initializes a new and copies its data from an existing object.
The existing object to copy data from.
Overridden. Returns BaseStyles from by calling .
A reference to a .
An array of BaseStyles.
Returns a string that represents the current object.
A string that represents the current object.
Occurs when a property in the has changed.
A object that has changed.
Identity for the property to operate on.
Occurs before a proeprty in the is changing.
A object that has changed.
Identity for the property to operate on.
Loops through all the base style until it finds a style that has specific property initialized.
The style info object that holds the property details.
Identity for the property to operate on.
returns the StyleInfoBase
Gets or sets the host element.
Results of ToString method.