Class GridTableFilterBarCellModel

Implements the DataModel part for a TableFilterBar cell.

Inheritance
System.Object
NonFinalizeDisposable
Disposable
GridCellModelBase
GridStaticCellModel
GridTextBoxCellModel
GridDropDownCellModel
GridComboBoxCellModel
GridTableFilterBarCellModel
GridFilterByDisplayMemberCellModel
Implements
System.Runtime.Serialization.ISerializable
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridTableFilterBarCellModel : GridComboBoxCellModel, ISerializable, IDisposable
Remarks

You can typically access cell models through the CellModels property of the GridModel class.

A GridTableFilterBarCellModel can serve as model for several GridTableFilterBarCellRenderer instances if there are several GridControlBase views for a GridModel.

See GridTableFilterBarCellRenderer for more detailed information about this cell type.

Constructors

GridTableFilterBarCellModel(GridModel)

Initializes a new instance of the GridTableFilterBarCellModel class and stores a reference to the GridModel this cell belongs to.

Declaration
public GridTableFilterBarCellModel(GridModel grid)
Parameters
Type Name Description
GridModel grid

The GridModel for GridTableFilterBarCellModel model.
Remarks

You can typically access cell models through the CellModels property of the GridModel class.

GridTableFilterBarCellModel(SerializationInfo, StreamingContext)

Initializes a new instances of the GridTableFilterBarCellModel class from a serialization stream.

Declaration
protected GridTableFilterBarCellModel(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info

An instance of the System.Runtime.Serialization.SerializationInfo that holds all the data needed to serialize or deserialize this instance.
System.Runtime.Serialization.StreamingContext context

An instance of the System.Runtime.Serialization.StreamingContext that describes the source and destination of the serialized stream specified by info parameter.

Properties

SelectAllText

Gets or sets the value of FilterBar string "(All)".

Declaration
public string SelectAllText { get; set; }
Property Value
Type Description
System.String

SelectCustomText

Gets or sets the value of FilterBar string "(Custom)".

Declaration
public string SelectCustomText { get; set; }
Property Value
Type Description
System.String

SelectEmptyText

Gets or sets the value of FilterBar string "(Empty)".

Declaration
public string SelectEmptyText { get; set; }
Property Value
Type Description
System.String

Methods

ApplyFilters()

Applies the record filter for table. Internal only.

Declaration
public void ApplyFilters()

CreateRenderer(GridControlBase)

Overrides and creates an instance of the GridTableFilterBarCellRenderer for GridTableFilterBarCellModel class that is specific to the GridControlBase.

Declaration
public override GridCellRendererBase CreateRenderer(GridControlBase control)
Parameters
Type Name Description
GridControlBase control

The GridControlBase for which the cell renderer is created.
Returns
Type Description
GridCellRendererBase

A new GridTableFilterBarCellRenderer specified by the instance of the GridControlBase class.
Overrides

FillWithChoices(ListBox, GridStyleInfo, out Boolean)

Overrides and initializes the ListBox with data binding information from a GridStyleInfo object.

Declaration
public override void FillWithChoices(ListBox listBox, GridStyleInfo style, out bool exclusive)
Parameters
Type Name Description
System.Windows.Forms.ListBox listBox

The list box to be initialized with data binding information.
GridStyleInfo style

An instance of the GridStyleInfo that holds the values of style properties.
System.Boolean exclusive

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.
Overrides

GetFilterBarChoices(GridTableCellStyleInfoIdentity)

Gets the unique choices to be displayed in the filter bar cell.

Declaration
public virtual object[] GetFilterBarChoices(GridTableCellStyleInfoIdentity tableCellIdentity)
Parameters
Type Name Description
GridTableCellStyleInfoIdentity tableCellIdentity

An instance of the GridTableCellStyleInfoIdentity class that identifies the table cell.
Returns
Type Description
System.Object[]

Filter bar choices.

GetRecordFilters(RecordFilterDescriptorCollection, GridTableCellStyleInfoIdentity, String)

Gets an array of instances of the RecordFilterDescriptor class for the specific column with respect to the particular UniqueGroupId value.

Declaration
public RecordFilterDescriptor[] GetRecordFilters(RecordFilterDescriptorCollection recordFilters, GridTableCellStyleInfoIdentity tableCellIdentity, string filterName)
Parameters
Type Name Description
RecordFilterDescriptorCollection recordFilters

Record filters collection.
GridTableCellStyleInfoIdentity tableCellIdentity

Specified grid table cell.
System.String filterName

Name of the filter.
Returns
Type Description
RecordFilterDescriptor[]

Array of instances of the RecordFilterDescriptor class.

GetUniqueColumnGroupId(GridTableCellStyleInfoIdentity)

Gets the UniqueGroupId value for the unique columns. Internal only.

Declaration
public string GetUniqueColumnGroupId(GridTableCellStyleInfoIdentity tableCellIdentity)
Parameters
Type Name Description
GridTableCellStyleInfoIdentity tableCellIdentity

The table cell identity.
Returns
Type Description
System.String

Returns the unique group id for every column.

GetUniqueGroupId(GridTableCellStyleInfoIdentity)

Gets the UniqueGroupId value. Internal only.

Declaration
public object[] GetUniqueGroupId(GridTableCellStyleInfoIdentity tableCellIdentity)
Parameters
Type Name Description
GridTableCellStyleInfoIdentity tableCellIdentity

The table cell identity.
Returns
Type Description
System.Object[]

returns the UniqueGroupId

ResetFilterBar(GridTableCellStyleInfoIdentity)

Resets the filter of respective cell identifier.

Declaration
protected void ResetFilterBar(GridTableCellStyleInfoIdentity tableCellIdentity)
Parameters
Type Name Description
GridTableCellStyleInfoIdentity tableCellIdentity

An instance of the GridTableCellStyleInfoIdentity class that identifies the cell.

Select(GridTableCellStyleInfoIdentity, Int32)

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.

Declaration
public void Select(GridTableCellStyleInfoIdentity tableCellIdentity, int index)
Parameters
Type Name Description
GridTableCellStyleInfoIdentity tableCellIdentity

Identity for the table cell.
System.Int32 index

Index of the filter bar choice to be selected.

SelectCustomFilterBar(GridTableCellStyleInfoIdentity)

Initiate the collection dialog editor while selecting custom option from the filter.

Declaration
protected void SelectCustomFilterBar(GridTableCellStyleInfoIdentity tableCellIdentity)
Parameters
Type Name Description
GridTableCellStyleInfoIdentity tableCellIdentity

An instance of the GridTableCellStyleInfoIdentity class that identifies the cell.

SelectItem(GridTableCellStyleInfoIdentity, Int32)

Selects the item at the specified index from respective cell identifier.

Declaration
protected void SelectItem(GridTableCellStyleInfoIdentity tableCellIdentity, int index)
Parameters
Type Name Description
GridTableCellStyleInfoIdentity tableCellIdentity

An instance of the GridTableCellStyleInfoIdentity class that identifies the cell.
System.Int32 index

Index of the selected item.

ShowCollectionDialog(Object, String, IServiceProvider, Type)

Shows the collection dialog.

Declaration
protected DialogResult ShowCollectionDialog(object instance, string propertyName, IServiceProvider provider, Type type)
Parameters
Type Name Description
System.Object instance

The object instance.
System.String propertyName

Name of the property.
System.IServiceProvider provider

An instance of the System.IServiceProvider interface.
System.Type type

The instance of the System.Type class.
Returns
Type Description
System.Windows.Forms.DialogResult

An instance of the WindowsFormsEditorServiceContainer instance.

Events

ShowingCustomFilterDialog

Occurs immediately before the RecordFilterCollectionEditor dialog is being displayed.

Declaration
public event ControlEventHandler ShowingCustomFilterDialog
Event Type
Type Description
System.Windows.Forms.ControlEventHandler

Implements

System.Runtime.Serialization.ISerializable
System.IDisposable