Version

TreeGridPaging Class Members

The following tables list the members exposed by TreeGridPaging.

Public Constructors
 NameDescription
Public ConstructorTreeGridPaging Constructorcreates a new tree grid paging setting with default values  
Public Fields
 NameDescription
Public FieldCONTEXT_ROW_MODE_KEYdefault property name in GET request used to populate contextRowMode property  
Public FieldMODE_KEYdefault property name in GET request used to populate Mode property  
Public Properties
 NameDescription
Public PropertyBreadcrumbDelimiterSets/gets (it is set via $.html()) delimiter between ancestors in the breadcrumb trail. It is used only when contextRowMode is breadcrumb  
Public PropertyBreadcrumbKeySets/gets the column key of ancestor to be shown in the breadcrumb trail. It is used only when contextRowMode is breadcrumb  
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 PropertyContextRowLoadingTextSets/gets the text message shown while loading content of the context row(while processing breadcrumb/immediate parent row). It is set via $.html(). If set to null loading message is not shown.  
Public PropertyContextRowModeGets or sets the context row mode.When data flows to the next page there are a couple of different modes that can help communicate the context of a leaf level row.  
Public PropertyContextRowRootTextSets/gets the content of the context row when the first record in the page is root(hasn't ancestors) record. It is set via $.html()  
Public PropertyCurrentPageIndexCurrent Page Index (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyDefaultDropDownWidthdropdown width for page size and page index dropdowns (Inherited from Infragistics.Web.Mvc.GridPaging)
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.GridPaging)
Public PropertyModeWhen Mode is RootLevelOnly: Only pages records at the root of the tree grid are displayed. When mode is AllLevelsincludes all visible records in paging.  
Public PropertyNamename of the feature, need to be set by every feature (Inherited from Infragistics.Web.Mvc.GridFeature)
Public PropertyPageCountLimitif this number of pages exceeds the given value, a dropdown will be rendered instead of a list of page links (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyPageSizePage Size (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyPageSizeDropDownLocationlocation of the page size dropdown. Accepted values are "above" and "inpager" (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyPageSizeLista list of page sizes that will fill the page size dropdown (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyPersistEnables / disables paging persistence between states (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyPrevPageLabelTexttext for teh previous page label (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyRenderContextRowFuncReference to the function, called before rendering context row content(rendering loading message/bread crumb/parent row). The function takes 3 arguments- dataRow, array of parent rows and context mode - "loading"|"breadcrumb"|"parent". When the function returns true rendering of the context row should be handled by the developer(it is like canceling of rendering context row content).  
Public PropertyShowFirstLastPagesenables / disables rendering of teh first and last page buttons (Default is true) (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyShowPagerRecordsLabelenables / disables a summary records label that will be shown on the left side of the paging area (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyShowPageSizeDropDownenables / disables the pagesize dropdown from where the end user can change the number of records per page (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyShowPrevNextPagesenables / disables rendering of the previois and next page buttons (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyTypepaging type - local or remote (Inherited from Infragistics.Web.Mvc.GridPaging)
Public PropertyVisiblePageCountnumber of page links that will be visible at once, if this number is exceeded, the mode is changed to QuickPages (Inherited from Infragistics.Web.Mvc.GridPaging)
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 MethodGetAncestorsGets the ancestors for the specified record. For the grid model it should have processed data and properties flatData and FlatVisibleData should be populated  
Public MethodHandleResponseOverloaded. Overridden. Add information about breadcrumb  
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Public MethodTransformDataSourceOverridden. applies Skip, Take and Count on the IQueryable. It overrides TransformDataSource of the base GridPaging. If Type is remote and Mode AllLevels then it is applied paging based on the visible records(taking into account expanded/collapsed records). Otherwise it is used base GridPaging - TransformDataSource.  
Protected Methods
 NameDescription
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