Version

TreeGridSorting Class Members

The following tables list the members exposed by TreeGridSorting.

Public Constructors
 NameDescription
Public ConstructorTreeGridSorting Constructorcreates a new tree grid sorting setting with default values  
Public Fields
 NameDescription
Public FieldFROM_LEVELdefault property name in GET request used to populate FromLevel property  
Public FieldTO_LEVELdefault property name in GET request used to populate ToLevel property  
Public Properties
 NameDescription
Public PropertyApplySortedColumnCssif true, a special ascending/descending class will be applied to every cell in the sorted column. This can be turned off for performance reasons (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyCaseSensitiveSorting case sensitivity (Inherited from Infragistics.Web.Mvc.GridSorting)
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 PropertyColumnSettingslist of column settings (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyCustomSortFunctioncustom sort function(or name of the function as a string) accepting three parameters - the data to be sorted, an array of data source field definitions, and the direction to sort with (optional). The function should return the sorted data array (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyDialogWidgetName of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyFirstSortDirectionthe sorting direction that will be applied on an unsorted column when it's clicked for teh first time throught the UI (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyFromLevelspecifies from which data bound level to be applied sorting - 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 PropertyLocalea list of configurable and localized labels. (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyModalDialogAnimationDurationSpecifies time of milliseconds for animation duration to show/hide modal dialog (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyModalDialogButtonApplyTextSpecifies text of button which apply changes in modal dialog (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyModalDialogCaptionButtonUnsortSpecifies caption for unsort button in multiple sorting dialog (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyModalDialogHeightSpecifies height of multiple sorting dialog (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyModalDialogSortOnClickSpecifies whether sorting to be applied immediately when click sort/unsort columns in multiple sorting dialog. When it is false Apply button shows and sorting is applied when the button is clicked (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyModalDialogWidthSpecifies width of multiple sorting dialog (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyModesorting mode - single or multiple (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyNameFeature name (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyPersistEnables / disables sorting persistence between states (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertySortedColumnTooltipcustom tooltip format for a sorted column (using jQuery templating syntax). Usage: "sorted ${direction}" (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertySortingDialogContainmentControls containment behavior of multiple sorting dialog. (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertySortUrlKeySort URL key encoded in the GET request (when sorting is configured remotely) (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertySortUrlKeyAscValueascending value name in the URL params . ?sort(col1)=SortUrlKeyAscValue (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertySortUrlKeyDescValuedescending value name in the url params . Example ?sort(col1)=SortUrlKeyDescValue (Inherited from Infragistics.Web.Mvc.GridSorting)
Public PropertyToLevelspecifies to which data bound level to be applied sorting - if -1 filtering should be applied to the last data bound level  
Public PropertyTypeoperation type - Local or Remote (Inherited from Infragistics.Web.Mvc.GridSorting)
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 MethodHandleResponseOverloaded. should be implemented in classes where necessary (Inherited from Infragistics.Web.Mvc.GridFeature)
Public MethodSortDataSourceRecursivelySorts the data source recursively.  
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Public MethodTransformDataSourceOverridden. apply a LINQ OrderBy clause  
Protected Methods
 NameDescription
Protected MethodBuildInitialExpressionsBuilds the initial sort expressions defined in the column sorting settings (Inherited from Infragistics.Web.Mvc.GridSorting)
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