Class DataGridStyle

Represents the different styles maintained for the SFDataGrid.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
StyleInfoBase
StyleInfoSubObjectBase
VisualStyleBase
ScrollerVisualStyle
DataGridStyle
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.WinForms.DataGrid.Styles
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class DataGridStyle : ScrollerVisualStyle, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

Constructors

DataGridStyle()

Initializes a new instance of the DataGridStyle class.

Declaration
public DataGridStyle()

DataGridStyle(DataGridStyleInfoIdentity)

Initializes a new instance of the DataGridStyle class.

Declaration
public DataGridStyle(DataGridStyleInfoIdentity identity)
Parameters
Type Name Description
DataGridStyleInfoIdentity identity

A DataGridStyleInfoIdentity value.

Properties

AddNewRowStyle

Gets or sets the style applied to all the AddNew row cells in SFDataGrid.

Declaration
public AddNewRowStyleInfo AddNewRowStyle { get; set; }
Property Value
Type Description
AddNewRowStyleInfo

The style that is applied to all the AddNew row cells in SFDataGrid. The default value is null.

Border3DStyle

Gets or sets the 3D border style of the control.

Declaration
public Border3DStyle Border3DStyle { get; set; }
Property Value
Type
System.Windows.Forms.Border3DStyle

BorderColor

Gets or sets the border color for the SfDataGrid.

Declaration
public Color BorderColor { get; set; }
Property Value
Type
System.Drawing.Color

BorderSides

Gets or sets the border sides of the control.

Declaration
public Border3DSide BorderSides { get; set; }
Property Value
Type
System.Windows.Forms.Border3DSide

BorderStyle

Gets or sets the border style for the control.

Declaration
public BorderStyle BorderStyle { get; set; }
Property Value
Type
System.Windows.Forms.BorderStyle

BusyIndicatorImage

Gets or sets the cell validation error icon.

Declaration
public Image BusyIndicatorImage { get; set; }
Property Value
Type
System.Drawing.Image

ButtonStyle

Gets or sets the style applied to button column in SFDataGrid.

Declaration
public ButtonCellStyleInfo ButtonStyle { get; set; }
Property Value
Type Description
ButtonCellStyleInfo

The style that is applied to button column in SFDataGrid. The default value is null.

CaptionSummaryRowStyle

Gets or sets the style applied to CaptionSummaryRowStyle in SFDataGrid.

Declaration
public CaptionSummaryStyleInfo CaptionSummaryRowStyle { get; set; }
Property Value
Type Description
CaptionSummaryStyleInfo

The style that is applied to CaptionSummaryRowStyle in SFDataGrid. The default value is null.

CellStyle

Gets or sets the style applied to all the record cells in SFDataGrid.

Declaration
public CellStyleInfo CellStyle { get; set; }
Property Value
Type Description
CellStyleInfo

The style that is applied to all the record cells in SFDataGrid. The default value is null.

CheckBoxStyle

Gets or sets the style of the check box.

Declaration
public CheckBoxCellStyleInfo CheckBoxStyle { get; set; }
Property Value
Type
CheckBoxCellStyleInfo

CurrentCellStyle

Gets or sets the style applied to CurrentCellStyle in SFDataGrid.

Declaration
public CurrentCellStyleInfo CurrentCellStyle { get; set; }
Property Value
Type Description
CurrentCellStyleInfo

The style that is applied to CurrentCellStyle in SFDataGrid. The default value is null.

DefaultStyle

Gets the default style of the form.

Declaration
public static DataGridStyle DefaultStyle { get; }
Property Value
Type
DataGridStyle

ErrorIcon

Gets or sets the cell validation error icon.

Declaration
public Bitmap ErrorIcon { get; set; }
Property Value
Type
System.Drawing.Bitmap

FilterRowStyle

Gets or sets the style applied to all the filter row cells in SFDataGrid.

Declaration
public FilterRowStyleInfo FilterRowStyle { get; set; }
Property Value
Type Description
FilterRowStyleInfo

The style that is applied to all the filter row cells in SFDataGrid. The default value is null.

FreezePaneLineStyle

Gets or sets the appearance for freeze pane line which being drawing when freezing rows and columns.

Declaration
public FreezePaneLineStyleInfo FreezePaneLineStyle { get; set; }
Property Value
Type
FreezePaneLineStyleInfo

GroupDropAreaItemStyle

Gets or sets the style applied to GroupDropAreaItem in SFDataGrid.

Declaration
public GroupDropAreaItemStyleInfo GroupDropAreaItemStyle { get; set; }
Property Value
Type Description
GroupDropAreaItemStyleInfo

The style that is applied to GroupDropAreaItem in SFDataGrid. The default value is null.

GroupDropAreaStyle

Gets or sets the style applied to GroupDropArea in SFDataGrid.

Declaration
public GroupDropAreaStyleInfo GroupDropAreaStyle { get; set; }
Property Value
Type Description
GroupDropAreaStyleInfo

The style that is applied to GroupDropArea in SFDataGrid. The default value is null.

GroupSummaryRowStyle

Gets or sets the style applied to GroupSummaryRowStyle in SFDataGrid.

Declaration
public SummaryStyleInfo GroupSummaryRowStyle { get; set; }
Property Value
Type Description
SummaryStyleInfo

The style that is applied to GroupSummaryRowStyle in SFDataGrid. The default value is null.

HasBorderColor

Gets a value indicating whether the BorderColor property has been changed or not.

Declaration
public bool HasBorderColor { get; }
Property Value
Type
System.Boolean

HasBorderSides

Gets a value indicating whether the BorderSides property has been changed or not.

Declaration
public bool HasBorderSides { get; }
Property Value
Type
System.Boolean

HasBorderStyle

Gets a value indicating whether the BorderStyle property has been changed or not.

Declaration
public bool HasBorderStyle { get; }
Property Value
Type
System.Boolean

HasBusyIndicatorImage

Gets a value indicating whether the BusyIndicatorImage property has been changed or not.

Declaration
public bool HasBusyIndicatorImage { get; }
Property Value
Type
System.Boolean

HeaderStyle

Gets or sets the style applied to all the header cells in SFDataGrid.

Declaration
public HeaderStyleInfo HeaderStyle { get; set; }
Property Value
Type Description
HeaderStyleInfo

The style that is applied to all the header cells in SFDataGrid. The default value is null.

HyperlinkStyle

Gets or sets the style of the hyperlink column.

Declaration
public HyperlinkCellStyleInfo HyperlinkStyle { get; set; }
Property Value
Type
HyperlinkCellStyleInfo

IndentCellStyle

Gets or sets the style applied to indent cell in SFDataGrid.

Declaration
public CellStyleInfo IndentCellStyle { get; set; }
Property Value
Type Description
CellStyleInfo

The style that is applied to indent cell in SFDataGrid. The default value is null.

PreviewRowStyle

Gets or sets the style applied to all the preview row cells in SfDataGrid.

Declaration
public PreviewRowStyleInfo PreviewRowStyle { get; set; }
Property Value
Type Description
PreviewRowStyleInfo

The style that is applied to all the Preview row cells in SFDataGrid. The default value is null.

ProgressBarStyle

Gets or sets the style of the progress bar.

Declaration
public ProgressBarCellStyleInfo ProgressBarStyle { get; set; }
Property Value
Type
ProgressBarCellStyleInfo

RowHeaderStyle

Gets or sets the style applied to all the RowHeader cells in SFDataGrid.

Declaration
public RowHeaderCellStyleInfo RowHeaderStyle { get; set; }
Property Value
Type Description
RowHeaderCellStyleInfo

The style that is applied to all the RowHeader cells in SFDataGrid. The default value is null.

SelectionStyle

Gets or sets the style applied to SelectionStyle in SFDataGrid.

Declaration
public SelectionStyleInfo SelectionStyle { get; set; }
Property Value
Type Description
SelectionStyleInfo

The style that is applied to SelectionStyle in SFDataGrid. The default value is null.

StackedHeaderStyle

Gets or sets the style applied to all the stacked header cells in SFDataGrid.

Declaration
public StackedHeaderStyleInfo StackedHeaderStyle { get; set; }
Property Value
Type Description
StackedHeaderStyleInfo

The style that is applied to all the stacked header cells in SFDataGrid. The default value is null.

TableSummaryRowStyle

Gets or sets the style applied to TableSummaryRow in SFDataGrid.

Declaration
public SummaryStyleInfo TableSummaryRowStyle { get; set; }
Property Value
Type Description
SummaryStyleInfo

The style that is applied to TableSummaryRow in SFDataGrid. The default value is null.

ToolTipStyle

Gets or sets the style applied to the tooltip.

Declaration
public ToolTipStyleInfo ToolTipStyle { get; set; }
Property Value
Type
ToolTipStyleInfo

UnboundRowStyle

Gets or sets the style applied to all the unbound row cells in SFDataGrid.

Declaration
public CellStyleInfo UnboundRowStyle { get; set; }
Property Value
Type Description
CellStyleInfo

The style that is applied to all the unbound row cells in SFDataGrid. The default value is null.

ValidationErrorToolTipStyle

Gets or sets the style of the validation error tooltip.

Declaration
public ToolTipStyleInfo ValidationErrorToolTipStyle { get; set; }
Property Value
Type
ToolTipStyleInfo

Methods

CreateSubObjectIdentity(StyleInfoProperty)

Overridden to create a product-specific identity object for the sub object.

Declaration
public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)
Parameters
Type Name Description
StyleInfoProperty sip

StyleInfoProperty descriptor for this sub object.
Returns
Type Description
StyleInfoSubObjectIdentity

Identity for the sub object.
Overrides

GetDefaultStyle()

Provide the default style of the MDI form.

Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type Description
StyleInfoBase

Default style object.
Overrides

ShouldSerializeCellStyle()

Determines whether CellStyle has been modified and its contents should be serialized at design-time.

Declaration
public bool ShouldSerializeCellStyle()
Returns
Type Description
System.Boolean

True if contents were changed; False otherwise.

ShouldSerializeGroupDropAreaItemStyle()

Determines whether GroupDropAreaItemStyle has been modified and its contents should be serialized at design-time.

Declaration
public bool ShouldSerializeGroupDropAreaItemStyle()
Returns
Type Description
System.Boolean

True if contents were changed; False otherwise.

ShouldSerializeGroupDropAreaStyle()

Determines whether GroupDropAreaStyle has been modified and its contents should be serialized at design-time.

Declaration
public bool ShouldSerializeGroupDropAreaStyle()
Returns
Type Description
System.Boolean

True if contents were changed; False otherwise.

ShouldSerializeHeaderStyle()

Determines whether HeaderStyle has been modified and its contents should be serialized at design-time.

Declaration
public bool ShouldSerializeHeaderStyle()
Returns
Type Description
System.Boolean

True if contents were changed; False otherwise.

ShouldSerializeToolTipStyle()

Determines whether HeaderStyle has been modified and its contents should be serialized at design-time.

Declaration
public bool ShouldSerializeToolTipStyle()
Returns
Type Description
System.Boolean

True if contents were changed; False otherwise.

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable