Version

TreeGridFiltering Class Members

The following tables list the members exposed by TreeGridFiltering.

Public Constructors
 NameDescription
Public ConstructorTreeGridFiltering Constructorcreates a new tree grid filtering setting with default values  
Public Fields
 NameDescription
Public FieldCOUNT_FILTERING_RECORDS_KEYdefault key for count of matching filtered records - used in metadata  
Public FieldDISPLAY_MODEdefault property name in GET request used to populate ToLevel property  
Public FieldFROM_LEVELdefault property name in GET request used to populate FromLevel property  
Public FieldMATCH_FILTERINGdefault property in the dataRecord object that indicates whether the dataRow matches the filtering conditions.  
Public FieldRECORD_COUNT_KEYproperty name in the response which holds the total number of records in the data source on the backend  
Public FieldTO_LEVELdefault property name in GET request used to populate ToLevel property  
Public Properties
 NameDescription
Public PropertyAdvancedModeEditorsVisibledefines whether to show/hide editors in advanced mode (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyAdvancedModeHeaderButtonLocationlocation of the advanced filtering button when advancedModeEditorsVisible is false (i.e. when the button is rendered in the header) (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyCaseSensitiveenables/disables case sensitivity. Default is true (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyColumnSettingsa list of column settings that define custom filtering options per column (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyDialogWidgetName of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyDisplayModeif displayMode is showWithAncestorsAndDescendants - even if child records don't match filtering conditions. If displayMode is showWithAncestors show only those records that match filtering conditions and do not show child records(if any) that don't match filtering conditions  
Public PropertyFilterButtonLocationthe filter dropdown button can be placed either on the left or on the right of the filter edit box (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDelaytimeout in milliseconds (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogAddButtonWidthadd button width - in the advanced filter dialog (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogAddConditionDropDownTemplateCustom template for options in dropdown in add condition area in the filter dialog (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogAddConditionTemplateCustom template for add condition area in the filter dialog (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogColumnDropDownDefaultWidthused for Advanced Filtering - this is the dialog that appears when a custom filter is configured (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogContainmentused for Advanced Filtering - Controls containment behavior (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogExprInputDefaultWidthused for Advanced Filtering - this is the dialog that appears when a custom filter is configured (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogFilterConditionTemplateCustom template for options in condition list in filter dialog (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogFilterDropDownDefaultWidthused for Advanced Filtering - this is the dialog that appears when a custom filter is configured (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogFilterTemplateCustom template for filter dialog (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogHeightused for Advanced Filtering - this is the dialog that appears when a custom filter is configured (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogMaxFilterCountused for Advanced Filtering - this is the dialog that appears when a custom filter is configured (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogOkCancelButtonWidthWidth of the Ok and Cancel buttons in the advanced filtering dialogs (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDialogWidthused for Advanced Filtering - this is the dialog that appears when a custom filter is configured (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDropDownAnimationDurationduration in milliseconds (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDropDownAnimationsanimation settings (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDropDownHeightheight (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDropDownItemIconsif enabled, there will be icons rendered in front of every list item in the filter dropdown (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterDropDownWidthwidth (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterExprUrlKeyurl key for the filter feature to encode in the request (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterLogicUrlKeyurl key for the filtering logic (AND or OR) - matching ALL ,or ANY of the expressions, respectively (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFilterSummaryAlwaysVisibleEnable/disable footer visibility with summary info about the filter. (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyFromLevelspecifies from which data bound level to be applied filtering - 0 is the first level  
Public PropertyInheritif this property is set to true in a feature it means that it will be inherited in child layouts, if any (Inherited from Infragistics.Web.Mvc.GridInheritableFeature)
Public PropertyLanguageGets/sets Language the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyLocaleDefines locale specific options of igTreeGrid  
Public PropertyMatchFilteringName of property in dataRecord object - indicates whether dataRow matches filtering conditions.  
Public PropertyModeFiltering mode - single or multiple (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyNamename of the feature, need to be set by every feature (Inherited from Infragistics.Web.Mvc.GridFeature)
Public PropertyPersistEnables / disables filtering persistence between states (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyRenderFCRender in feature chooser. Feature chooser is dialog which lists all the enabled features (like Sorting, Filtering, Hiding etc.) of igGrid. (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyRenderFilterButtonenables disables filter dropdowns (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyShowEmptyConditionsshows or hides empty/notEmpty conditions in the filter dropdowns / advanced dialog dropdowns (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyShowNullConditionsshows or hides null/notNull conditions in the filter dropdowns / advanced dialog dropdowns (Inherited from Infragistics.Web.Mvc.GridFiltering)
Public PropertyToLevelspecifies to which data bound level to be applied filtering - if -1 filtering should be applied to the last data bound level  
Public PropertyTypeoperation type specifically for filtering (Inherited from Infragistics.Web.Mvc.GridFiltering)
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
Public Methods
 NameDescription
Public MethodAddClientEventAdds javascript function to process client event of widget. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public MethodFilterDataRecursivelyFilters the data recursively as traversing the whole data source and setting metadata information for record - like which record matches to the filtering conditions  
Public MethodHandleResponseOverloaded. Overridden. Add metadata information about filtering like count of matching records. When paging is enabled it is possible count of filtering records to be less than the total records count. Example child records match filtering condition(but parent records do not match)  
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Public MethodTransformDataSourceOverridden. Implementation for filtering on the data source level. When transformDataSource is called, the filtering feature analyzes the query string and then applies a LINQ Where clause on the IQueryable data source, also translating filtering expression objects to a LINQ where predicate  
Protected Methods
 NameDescription
Protected MethodBuildInitialExpressionsBuilds the initial filtering expressions defined in the column filtering settings (Inherited from Infragistics.Web.Mvc.GridFiltering)
Protected MethodCamelizeConverts the provided string to camel case. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodEnsureClientEventsAdds client events to Serializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodGetBoolGets the value of a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetCharSets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDateTimeGets the value of a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDoubleGets the value of a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIEnumerable<T>Gets the value of an IEnumerable property of the model. If the value is null a new IEnumerable of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIntGets the value of an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetJSLiteralSets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetLongGets the value of a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetModel<T>Gets the value of an IModel property of the model. If the value is null a new model of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringGets the value of a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringEnum<T>Gets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValue<T>Gets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValueModel<T>Gets the value of an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromBoolSerializes a bool object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDateTimeSerializes a DateTime object into json Date object. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDoubleSerializes a double object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromFloatSerializes a float object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIDictionarySerializes an IDictionary of objects into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIEnumerableSerializes an IEnumerable object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIntSerializes an int object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromModelStoreSerializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodJsonFromObjectSerializes an arbitrary object in json using the typed serialization methods. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromStringSerializes a string object into json string, escaping all single quotes. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBoolSets a value to a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBrush (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCamelizedStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCharGets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDateTimeSets a value to a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDoubleSets a value to a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIEnumerable<T>Sets a value to an IEnumerable property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIntSets a value to an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetJSLiteralGets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetLongSets a value to a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetModel<T>Sets a value to an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringSets a value to a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetValue<T>Sets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodTransformDataTransforms the data. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodValidValueType<T>Checks type for value of existing property. Returns false as well if non existing property. (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub