Class FilterControlVisualStyle

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

Inheritance
System.Object
ShouldSerializeBasedPersisterType
StyleInfoBase
StyleInfoSubObjectBase
VisualStyleBase
FilterControlVisualStyle
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.GridCommon
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class FilterControlVisualStyle : VisualStyleBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

Constructors

FilterControlVisualStyle()

Initializes a new instance of the FilterControlVisualStyle class.

Declaration
public FilterControlVisualStyle()

FilterControlVisualStyle(StyleInfoSubObjectIdentity)

Initializes a new instance of the FilterControlVisualStyle class.

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

A DataGridStyleInfoIdentity that holds the identity for this .

FilterControlVisualStyle(StyleInfoSubObjectIdentity, FilterControlVisualStyleInfoStore)

Initializes a new instance of the FilterControlVisualStyle class.

Declaration
public FilterControlVisualStyle(StyleInfoSubObjectIdentity identity, FilterControlVisualStyleInfoStore store)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A DataGridStyleInfoIdentity that holds the identity for this .
FilterControlVisualStyleInfoStore store

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

FilterControlVisualStyle(FilterControlVisualStyle)

Initializes a new instance of the FilterControlVisualStyle class.

Declaration
public FilterControlVisualStyle(FilterControlVisualStyle style)
Parameters
Type Name Description
FilterControlVisualStyle style

The style object that contains the original data.

FilterControlVisualStyle(FilterControlVisualStyleInfoStore)

Initializes a new instance of the FilterControlVisualStyle class.

Declaration
public FilterControlVisualStyle(FilterControlVisualStyleInfoStore store)
Parameters
Type Name Description
FilterControlVisualStyleInfoStore store

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

Fields

Empty

Maintains the empty FilterControlStyleInfo.

Declaration
public static readonly FilterControlVisualStyle Empty
Field Value
Type
FilterControlVisualStyle

Properties

ActiveCasingButtonImage

Gets or sets the image added for the casing button when it is active state.

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

ActiveSortAscendingIcon

Gets or sets the icon for the ascending filter button.

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

ActiveSortDescendingIcon

Gets or sets the icon for the descending filter button.

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

AdvancedFilterDropDownIcon

Gets or sets the image that needs to be displayed for Advanced filter button for drop down.

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

AdvancedFilterDroppedDownIcon

Gets or sets the image that needs to be displayed for Advanced filter button for dropped down.

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

BackColor

Gets or sets a value indicating whether the BackColor of a cell instead of using .

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

Border3DStyle

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

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

BorderColor

Gets or sets the border color of the filter control.

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

BorderSides

Gets or sets the border sides of the filter control.

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

BorderStyle

Gets or sets the border style of the filter control.

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

CasingButtonImage

Gets or sets the image added for the first casing button.

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

ClearFilterIcon

Gets or sets the image for the clear filter option.

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

CloseIcon

Gets or sets the close icon that needs to be added to the SerachTextbox of the CheckBox filter.

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

DateFilterButtonImage

Gets or sets the image added for the second casing button.

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

DateTimeCasingButtonImage

Gets or sets the image added for the date time casing button.

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

Default

Gets a FilterControlVisualStyle with default settings.

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

DisabledClearFilterIcon

Gets or sets the image for the disabled clear filter option.

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

ForeColor

Gets or sets a value indicating whether the BackColor of a cell instead of using .

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

SearchIcon

Gets or sets the search icon added to the SerachTextbox of the CheckBox filter.

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

SeparatorColor

Gets or sets a value indicating whether the SeparatorColor of a cell instead of using .

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

SortAscendingIcon

Gets or sets the icon for the ascending filter button.

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

SortDescendingIcon

Gets or sets the icon for the descending filter button.

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

Store

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

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

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