Version

GridPaging Class Members

The following tables list the members exposed by GridPaging.

Public Constructors
 NameDescription
Public ConstructorGridPaging Constructorinitializes the grid paging feature with default values  
Public Fields
 NameDescription
Public FieldDEFAULT_PAGE_COUNT_LIMITdefault number of pages, above which the rendering will switch from page links to a dropdown from which the end user can choose a page index  
Public FieldDEFAULT_PAGE_SIZEdefault page size  
Public FieldDEFAULT_VISIBLE_PAGESdefault number of visible pages  
Public FieldPAGE_INDEX_KEYkey used to encode the current page index in the GET request  
Public FieldPAGE_SIZE_KEYkey used to encode the current page size in the GET request  
Public FieldRECORD_COUNT_KEYproperty name in the response which holds the total number of pages in the data source on the backend  
Public Properties
 NameDescription
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 PropertyCurrentPageIndexCurrent Page Index  
Public PropertyDefaultDropDownWidthdropdown width for page size and page index dropdowns  
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.  
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  
Public PropertyPageSizePage Size  
Public PropertyPageSizeDropDownLocationlocation of the page size dropdown. Accepted values are "above" and "inpager"  
Public PropertyPageSizeLista list of page sizes that will fill the page size dropdown  
Public PropertyPersistEnables / disables paging persistence between states  
Public PropertyPrevPageLabelTexttext for teh previous page label  
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyShowFirstLastPagesenables / disables rendering of teh first and last page buttons (Default is true)  
Public PropertyShowPagerRecordsLabelenables / disables a summary records label that will be shown on the left side of the paging area  
Public PropertyShowPageSizeDropDownenables / disables the pagesize dropdown from where the end user can change the number of records per page  
Public PropertyShowPrevNextPagesenables / disables rendering of the previois and next page buttons  
Public PropertyTypepaging type - local or remote  
Public PropertyVisiblePageCountnumber of page links that will be visible at once, if this number is exceeded, the mode is changed to QuickPages  
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. Overridden. sets the total records count in the response  
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Public MethodTransformDataSourceOverridden. applies Skip, Take and Count on the IQueryable  
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