Class GridTableFilterBarGridListCellModel

Implements the DataModel part for a TableFilterBar GridListControl cell.

Inheritance

System.Object

NonFinalizeDisposable

GridDropDownCellModel

GridComboBoxCellModel

GridDropDownGridListControlCellModel

GridTableFilterBarGridListCellModel

GridTableFilterBarGridListCellModelExt

Implements

System.Runtime.Serialization.ISerializable

System.IDisposable

Inherited Members

GridCellModelBase.ActiveTextChanged

GridCellModelBase.ApplyText(GridStyleInfo, String)

GridCellModelBase.BindingContext

GridCellModelBase.ButtonBarSize

GridCellModelBase.CalculatePreferredCellSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)

GridCellModelBase.CreateCopy(GridModel)

GridCellModelBase.Description

GridCellModelBase.Dispose()

GridCellModelBase.ForceCoveredCellFullBounds

GridCellModelBase.GetActiveText(Int32, Int32)

GridCellModelBase.GetCellClientSize(Int32, Int32, GridStyleInfo)

GridCellModelBase.GetCellSize(Int32, Int32)

GridCellModelBase.GetFormattedOrActiveTextAt(Int32, Int32, GridStyleInfo)

GridCellModelBase.GetLocalizedString(String)

GridCellModelBase.GetPropertyDescriptor(GridStyleInfo)

GridCellModelBase.GetText(GridStyleInfo, Object)

GridCellModelBase.GetTypeConverter(GridStyleInfo)

GridCellModelBase.Grid

GridCellModelBase.IsDisposed

GridCellModelBase.IsDisposing

GridCellModelBase.MeasureEmptyCellString

GridCellModelBase.MeasureSampleWString(Graphics, Font)

GridCellModelBase.OnActiveTextChanged(GridCellEventArgs)

GridCellModelBase.OnBindingContextChanged(EventArgs)

GridCellModelBase.OnModelDeserialization(Object, GridModel)

GridCellModelBase.ResetActiveText(Int32, Int32)

GridCellModelBase.SerializeSchemeVersion

GridCellModelBase.SetActiveText(Int32, Int32, String)

GridCellModelBase.SubtractBorders(Rectangle, GridStyleInfo)

GridCellModelBase.SubtractBorders(Rectangle, GridStyleInfo, Boolean)

GridComboBoxCellModel.AllowDoubleClickChangeSelectedIndex

GridComboBoxCellModel.ApplyFormattedText(GridStyleInfo, String, Int32)

GridComboBoxCellModel.CacheDataSource

GridComboBoxCellModel.Dispose(Boolean)

GridComboBoxCellModel.FindValue(GridStyleInfo, Object)

GridComboBoxCellModel.GetFormattedText(GridStyleInfo, Object, Int32)

GridComboBoxCellModel.GetItemValue(Object, String, Object)

GridDropDownCellModel.GetObjectData(SerializationInfo, StreamingContext)

GridDropDownCellModel.OnQueryPrefferedClientSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)

GridDropDownCellModel.SupportsChoiceList

GridStaticCellModel.AllowFloating

GridStaticCellModel.AllowMerging

GridStaticCellModel.OnQueryCanFloatCell(Int32, Int32, GridStyleInfo, GridQueryFloatCell)

GridStaticCellModel.OnQueryCanMergeCell(Int32, Int32, GridStyleInfo, GridMergeCellDirection)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GridTableFilterBarGridListCellModel : GridDropDownGridListControlCellModel, ISerializable, IDisposable

Remarks

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

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

See GridTableFilterBarGridListCellRenderer for more detailed information about this cell type.

Constructors

GridTableFilterBarGridListCellModel(GridModel)

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

Declaration

public GridTableFilterBarGridListCellModel(GridModel grid)

Parameters

Type	Name	Description
GridModel	grid	The GridModel for this cell model.

Remarks

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

GridTableFilterBarGridListCellModel(GridModel, Boolean)

Initializes a new GridTableFilterBarCellModel object and stores a reference to the GridModel this cell belongs to.

Declaration

public GridTableFilterBarGridListCellModel(GridModel grid, bool isCombobox)

Parameters

Type	Name	Description
GridModel	grid	The GridModel for this cell model.
System.Boolean	isCombobox	To set GridListControl's appearance as Combobox

Remarks

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

GridTableFilterBarGridListCellModel(SerializationInfo, StreamingContext)

Initializes a new GridTableFilterBarCellModel from a serialization stream.

Declaration

protected GridTableFilterBarGridListCellModel(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info	An object that holds all the data needed to serialize or deserialize this instance.
System.Runtime.Serialization.StreamingContext	context	Describes the source and destination of the serialized stream specified by info.

Properties

SelectAllText

Gets or sets the value "(Select All)" text.

Declaration

public string SelectAllText { get; set; }

Property Value

Type
System.String

SelectCustomText

Gets or sets the values of the "(Custom...)" text.

Declaration

public string SelectCustomText { get; set; }

Property Value

Type
System.String

SelectEmptyText

Gets or sets the value of the "(Empty)" text.

Declaration

public string SelectEmptyText { get; set; }

Property Value

Type
System.String

Methods

ApplyFilters()

Initialize the record filters. Internal only.

Declaration

public void ApplyFilters()

CreateRenderer(GridControlBase)

Overrides and creates a GridTableFilterBarGridListCellRenderer for the cell model that is specific to the GridControlBase.

Declaration

public override GridCellRendererBase CreateRenderer(GridControlBase control)

Parameters

Type	Name	Description
GridControlBase	control	The GridControlBase the cell renderer is created for.

Returns

Type	Description
GridCellRendererBase	A new GridTableFilterBarGridListCellRenderer specific for a GridControlBase.

Overrides

GridDropDownGridListControlCellModel.CreateRenderer(GridControlBase)

FillWithChoices(GridListControl, GridStyleInfo, out Boolean)

Initializes a System.Windows.Forms.ListBox with data binding information from an instance of the GridStyleInfo class.

Declaration

public void FillWithChoices(GridListControl listBox, GridStyleInfo style, out bool exclusive)

Parameters

Type	Name	Description
GridListControl	listBox	The System.Windows.Forms.ListBox to be initialized with data binding information.
GridStyleInfo	style	The style object with binding information.
System.Boolean	exclusive	A place holder that indicates whether the GridListControl is filled with an exclusive list of possible choices or if non-standard values are allowed.

FillWithChoices(ListBox, GridStyleInfo, out Boolean)

Overrides and gets the data to fill with choices.

Declaration

public override void FillWithChoices(ListBox listBox, GridStyleInfo style, out bool exclusive)

Parameters

Type	Name	Description
System.Windows.Forms.ListBox	listBox	The System.Windows.Forms.ListBox to be initialized with data binding information.
GridStyleInfo	style	An instance of the GridStyleInfo that holds the values of style properties.
System.Boolean	exclusive	If True then the list box values will be filled with unique values; Otherwise False and allows non-standard values.

Overrides

GridComboBoxCellModel.FillWithChoices(ListBox, GridStyleInfo, out Boolean)

GetDataSource(GridStyleInfo)

Gets the datasource for filter bar choices.

Declaration

public override object GetDataSource(GridStyleInfo style)

Parameters

Type	Name	Description
GridStyleInfo	style	An instance of the GridStyleInfo that holds the values of style properties.

Returns

Type	Description
System.Object	The data source instance associated withe the filterbar cell.

Overrides

GridComboBoxCellModel.GetDataSource(GridStyleInfo)

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	Identity for the table cell.

Returns

Type	Description
System.Object[]	Filter bar choices.

GetRecordFilters(RecordFilterDescriptorCollection, GridTableCellStyleInfoIdentity, String)

Gets an array of RecordFilterDescriptors for the specific column with respect to the particular GroupUniqueID

Declaration

public RecordFilterDescriptor[] GetRecordFilters(RecordFilterDescriptorCollection recordFilters, GridTableCellStyleInfoIdentity tableCellIdentity, string filterName)

Parameters

Type	Name	Description
RecordFilterDescriptorCollection	recordFilters	An instance of the RecordFilterDescriptorCollection.
GridTableCellStyleInfoIdentity	tableCellIdentity	Specified grid table cell.
System.String	filterName	Name of the filter.

Returns

Type	Description
RecordFilterDescriptor[]	Array of RecordFilterDescriptor instance value.

GetUniqueColumnGroupId(GridTableCellStyleInfoIdentity)

Gets the unique group id value for the column. 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 UniqueGroupId value.

GetUniqueGroupId(GridTableCellStyleInfoIdentity)

Gets an array of unique group id for the top level group. 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 value.

ResetFilterBar(GridTableCellStyleInfoIdentity)

Resets the filter for the specified cell identifier.

Declaration

protected void ResetFilterBar(GridTableCellStyleInfoIdentity tableCellIdentity)

Parameters

Type	Name	Description
GridTableCellStyleInfoIdentity	tableCellIdentity	An instance of the GridTableCellStyleInfoIdentity that identifies the table cell.

Select(GridTableCellStyleInfoIdentity, Int32)

Applies a 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	Identifies the table cell.
System.Int32	index	Index of the filter bar choice to be selected.

SelectCustomFilterBar(GridTableCellStyleInfoIdentity)

A method to initiate collection dialog editor while selecting custom filter option.

Declaration

protected void SelectCustomFilterBar(GridTableCellStyleInfoIdentity tableCellIdentity)

Parameters

Type	Name	Description
GridTableCellStyleInfoIdentity	tableCellIdentity	An instance of the GridTableCellStyleInfoIdentity that identifies the table cell.

SelectItem(GridTableCellStyleInfoIdentity, Int32)

Selects the item at the selected index in respective cell identifier.

Declaration

protected void SelectItem(GridTableCellStyleInfoIdentity tableCellIdentity, int index)

Parameters

Type	Name	Description
GridTableCellStyleInfoIdentity	tableCellIdentity	An instance of the GridTableCellStyleInfoIdentity that identifies the table cell.
System.Int32	index	The 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	An object.
System.String	propertyName	Name of the property.
System.IServiceProvider	provider	An instance of the System.IServiceProvider value.
System.Type	type	An instance of the System.Type value.

Returns

Type	Description
System.Windows.Forms.DialogResult	Returns the DialogResult.

Events

ShowingCustomFilterDialog

Occurs immediately before the RecordFilterCollectionEditor Dialog is displayed. The ControlEventArgs.Control the form.

Declaration

public event ControlEventHandler ShowingCustomFilterDialog

Event Type

Type
System.Windows.Forms.ControlEventHandler

Implements

System.Runtime.Serialization.ISerializable

System.IDisposable