Class HeaderStyleInfo

Represents the functionalities that holds all information stored for a header cell.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
StyleInfoBase
StyleInfoSubObjectBase
CellStyleInfo
HeaderStyleInfo
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 HeaderStyleInfo : CellStyleInfo, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

Constructors

HeaderStyleInfo()

Initializes a new instance of the HeaderStyleInfo class.

Declaration
public HeaderStyleInfo()

HeaderStyleInfo(StyleInfoSubObjectIdentity)

Initializes a new instance of the HeaderStyleInfo class.

Declaration
public HeaderStyleInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

to create an identity for HeaderStyleInfo.

HeaderStyleInfo(StyleInfoSubObjectIdentity, CellStyleInfoStore)

Initializes a new instance of the HeaderStyleInfo class and associates it with an existing CellStyleInfoStore.

Declaration
public HeaderStyleInfo(StyleInfoSubObjectIdentity identity, CellStyleInfoStore store)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A StyleInfoSubObjectIdentity that holds the identity for this StyleInfoBase.
CellStyleInfoStore store

A StyleInfoStore that holds data for this object. All changes in this style object will be saved in the CellStyleInfoStore object.

Properties

Default

Gets the default HeaderStyleInfo value.

Declaration
public static HeaderStyleInfo Default { get; }
Property Value
Type
HeaderStyleInfo

FilteredIcon

Gets or sets the custom filtered icon for a filtered column's header.

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

FilterIcon

Gets or sets the custom filter icon for a non filtered column's header.

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

FilterIconColor

Gets or sets the foreground color of the filter icon.

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

FilterIconSize

Gets or sets the size of the filter icon.

Declaration
public Size FilterIconSize { get; set; }
Property Value
Type
System.Drawing.Size
Remarks

This property will have no effect on the default filter icon if the width and height are different. Width and height for this property should be same when loading default filter icon.

HasFilteredIcon

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

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

HasFilterIcon

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

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

HasSortIcon

Gets a value indicating whether SortIcon has been initialized for the current object.

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

HoverBackColor

Gets or sets the hover state back color.

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

HoverFilterIconColor

Gets or sets the hover foreground color of the filter icon.

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

HoverSortIconColor

Gets or sets the hover foreground color of the sort icon.

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

HoverTextColor

Gets or sets the hover state text color.

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

PressedBackColor

Gets or sets the pressed state back color.

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

PressedFilterIconColor

Gets or sets the pressed foreground color of the filter icon.

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

PressedSortIconColor

Gets or sets the pressed foreground color of the sort icon.

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

PressedTextColor

Gets or sets the pressed state text color.

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

SortIcon

Gets or sets the sort icon of the header.

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

SortIconColor

Gets or sets the foreground color of the sort icon.

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

Store

Gets the CellStyleInfoStore object that holds all the data for this style object.

Declaration
public CellStyleInfoStore Store { get; }
Property Value
Type
CellStyleInfoStore

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()

Override this method to return a default style object for your derived class.

Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type Description
StyleInfoBase

A default style object.
Overrides

MakeCopy(StyleInfoBase, StyleInfoProperty)

Makes an exact copy of the current object.

Declaration
public override IStyleInfoSubObject MakeCopy(StyleInfoBase newOwner, StyleInfoProperty sip)
Parameters
Type Name Description
StyleInfoBase newOwner

The new owner style object for the copied object.
StyleInfoProperty sip

The identifier for this object.
Returns
Type Description
IStyleInfoSubObject

A copy of the current object registered with the new owner style object.
Overrides

Implements

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