Class GridTableCellStyleInfoIdentity
Provides identity information for a GridTableCellStyleInfo object that is created by GridTable for each cell in the grid. GridTableCellStyleInfoIdentity defines the inheritance of style properties from parent elements inside the grid.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridTableCellStyleInfoIdentity : GridStyleInfoIdentity, IDisposable, IGridModelSource
Remarks
Inheritance of style properties is defined by the GridTableCellStyleInfoIdentity object. It has a GetBaseStyles(IStyleInfo) method that returns the GridStyleInfo objects that form an inheritance chain. Check the GetBaseStyleNames() 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.
Constructors
GridTableCellStyleInfoIdentity(GridTableCellStyleInfoIdentity)
Initializes a new GridStyleInfoIdentity and copies its data from an existing object.
Declaration
protected GridTableCellStyleInfoIdentity(GridTableCellStyleInfoIdentity other)
Parameters
Type | Name | Description |
---|---|---|
GridTableCellStyleInfoIdentity | other | The existing object to copy data from. |
GridTableCellStyleInfoIdentity(IGridData, Int32, Int32)
Initializes the identity object with a reference to the volatile data cache, row, and column index.
Declaration
public GridTableCellStyleInfoIdentity(IGridData data, int rowIndex, int colIndex)
Parameters
Type | Name | Description |
---|---|---|
IGridData | data | Reference to the volatile data cache. |
System.Int32 | rowIndex | The row index. |
System.Int32 | colIndex | The column index. |
Properties
Column
The column this cell displays if it is RecordFieldCell, column header cell, or any cell associated with a GridColumnDescriptor.
Declaration
public GridColumnDescriptor Column { get; set; }
Property Value
Type |
---|
GridColumnDescriptor |
DisplayElement
Gets or sets the display element of the row.
Declaration
public Element DisplayElement { get; set; }
Property Value
Type |
---|
Element |
FilterBarSummaryDescriptor
The summary this cell displays if it is Summary cell or any cell associated with a GridSummaryColumnDescriptor.
Declaration
public SummaryDescriptor FilterBarSummaryDescriptor { get; set; }
Property Value
Type |
---|
SummaryDescriptor |
GroupedColumn
The SortColumnDescriptor 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.
Declaration
public SortColumnDescriptor GroupedColumn { get; set; }
Property Value
Type |
---|
SortColumnDescriptor |
Info
Results of ToString method.
Declaration
public override string Info { get; }
Property Value
Type |
---|
System.String |
Overrides
StackedHeader
Gets or sets the stacked header descriptor,if it is StackedHeaderCell.
Declaration
public GridStackedHeaderDescriptor StackedHeader { get; set; }
Property Value
Type |
---|
GridStackedHeaderDescriptor |
SummaryColumn
The summary this cell displays if it is Summary cell or any cell associated with a GridSummaryColumnDescriptor.
Declaration
public GridSummaryColumnDescriptor SummaryColumn { get; set; }
Property Value
Type |
---|
GridSummaryColumnDescriptor |
Table
Gets or sets the Grid table. The GridTable that created this object.
Declaration
public GridTable Table { get; set; }
Property Value
Type |
---|
GridTable |
TableCellType
Gets or sets the cell type of Grid table. The GridTableCellType that specifies what kind of cell this is.
Declaration
public GridTableCellType TableCellType { get; set; }
Property Value
Type |
---|
GridTableCellType |
Methods
AddBaseStyle(IStyleInfo, ArrayList, GridEngine)
Used internally.
Declaration
public static void AddBaseStyle(IStyleInfo style, ArrayList styleList, GridEngine engine)
Parameters
Type | Name | Description |
---|---|---|
IStyleInfo | style | |
System.Collections.ArrayList | styleList | |
GridEngine | engine |
AddBaseStyles(ArrayList, GridEngine)
Used internally.
Declaration
public static void AddBaseStyles(ArrayList styleList, GridEngine engine)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.ArrayList | styleList | |
GridEngine | engine |
AddColumnStyles(ArrayList, GridColumnDescriptor)
Used internally.
Declaration
public static void AddColumnStyles(ArrayList styleList, GridColumnDescriptor column)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.ArrayList | styleList | |
GridColumnDescriptor | column |
AddStyle(IStyleInfo, ArrayList, GridEngine)
Used internally.
Declaration
public static void AddStyle(IStyleInfo style, ArrayList styleList, GridEngine engine)
Parameters
Type | Name | Description |
---|---|---|
IStyleInfo | style | |
System.Collections.ArrayList | styleList | |
GridEngine | engine |
AddStyles(IStyleInfo[], ArrayList, GridEngine)
Used internally.
Declaration
public static void AddStyles(IStyleInfo[] styles, ArrayList styleList, GridEngine engine)
Parameters
Type | Name | Description |
---|---|---|
IStyleInfo[] | styles | |
System.Collections.ArrayList | styleList | |
GridEngine | engine |
Dispose()
Disposes the current object.
Declaration
public override void Dispose()
Overrides
DumpStyles(ArrayList)
Debug helper.
Declaration
public static void DumpStyles(ArrayList styleList)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.ArrayList | styleList | An array of styles. |
GetActiveGridView()
Returns the active GridControlBase for the GridModel this style belongs to or NULL if the style is used outside a grid model.
Declaration
public override GridControlBase GetActiveGridView()
Returns
Type | Description |
---|---|
GridControlBase | A reference to the grid control base or NULL if the style is used outside a grid model. |
Overrides
GetBaseStyleNames()
Gets a string that indicates parent styles within the appearance object for the specified table cell element.
Declaration
public string[] GetBaseStyleNames()
Returns
Type | Description |
---|---|
System.String[] | A string with debug information. |
GetBaseStyles(IStyleInfo)
Overridden. Returns base styles that define the inheritance of style properties.
Declaration
public override IStyleInfo[] GetBaseStyles(IStyleInfo thisStyleInfo)
Parameters
Type | Name | Description |
---|---|---|
IStyleInfo | thisStyleInfo | A reference to a IStyleInfo. |
Returns
Type | Description |
---|---|
IStyleInfo[] | An array of base styles. |
Overrides
Remarks
Inheritance of style properties is defined by the GridTableCellStyleInfoIdentity object. It has a GetBaseStyles(IStyleInfo) method that returns the GridStyleInfo objects that form an inheritance chain. Check the GetBaseStyleNames() 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.
GetEngine()
Returns the GridEngine this object belongs to.
Declaration
public GridEngine GetEngine()
Returns
Type | Description |
---|---|
GridEngine | The engine object. |
GetGridModel()
Returns the GridModel this style belongs to or NULL if the style is used outside a grid model.
Declaration
public override GridModel GetGridModel()
Returns
Type | Description |
---|---|
GridModel | A reference to the grid model or NULL if the style is used outside a grid model. |
Overrides
LookupCellModel(String)
Returns a GridCellModelBase for the specified id / cell type name.
Declaration
public override GridCellModelBase LookupCellModel(string id)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | Cell type name. |
Returns
Type | Description |
---|---|
GridCellModelBase | The GridCellModelBase for the given id. |
Overrides
Remarks
Calls LookupCellModel(String).
OnStyleChanged(StyleInfoBase, StyleInfoProperty)
Occurs when a property in StyleInfoBase is changed.
Declaration
public override void OnStyleChanged(StyleInfoBase style, StyleInfoProperty sip)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoBase | style | The StyleInfoBase instance that was changed. |
StyleInfoProperty | sip | An identity for the property to operate on. |
Overrides
ToString()
Returns a string holding the current object.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String representation of the current object. |
Overrides
Explicit Interface Implementations
IGridModelSource.Model
Declaration
GridModel IGridModelSource.Model { get; }
Returns
Type |
---|
GridModel |