Class PageOptionsBuilder<T>
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class PageOptionsBuilder<T>
where T : classType Parameters
| Name | Description |
|---|---|
| T |
Constructors
PageOptionsBuilder(PageSettings)
Initializes a new instance of the
Declaration
public PageOptionsBuilder(PageSettings page)Parameters
| Type | Name | Description |
|---|---|---|
| PageSettings | page | It displays the list of pageSettings option |
Methods
CurrentPage(Int32)
It sets a value that indicates whether to define which page to display currently in the grid
Declaration
public PageOptionsBuilder<T> CurrentPage(int currentPage)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | currentPage | It accepts the integer value and display the current page |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
EnableQueryString()
It sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page.
Declaration
public PageOptionsBuilder<T> EnableQueryString()Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
EnableQueryString(Boolean)
It sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page.
Declaration
public PageOptionsBuilder<T> EnableQueryString(bool enableQueryString)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableQueryString | It accepts the boolean value and enables or disables the current page information as a query string |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
EnableTemplates()
It sets a value that indicates whether to enables pager template for the grid.
Declaration
public PageOptionsBuilder<T> EnableTemplates()Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
IsResponsive()
Declaration
public PageOptionsBuilder<T> IsResponsive()Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> |
IsResponsive(Boolean)
Declaration
public PageOptionsBuilder<T> IsResponsive(bool isResponsive)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isResponsive |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> |
Locale(String)
It sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region.
Declaration
public PageOptionsBuilder<T> Locale(string locale)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | locale | It accepts the string and displays in customized language |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
PageCount(Int32)
It sets a value that indicates whether to define the number of pages displayed in the pager for navigation
Declaration
public PageOptionsBuilder<T> PageCount(int pageCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | pageCount | It accepts the integer value and define the number of pages displayed in the pager |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
PageSize(Int32)
It sets a value that indicates whether to define the number of records displayed per page
Declaration
public PageOptionsBuilder<T> PageSize(int pageSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | pageSize | It accepts the integervalue and display the records |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
PageSizeList(List<Int32>)
It sets a list of values as dropdown which can be selected to define the number of records displayed per page
Declaration
public PageOptionsBuilder<T> PageSizeList(List<int> pageSizeList)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.Int32> | pageSizeList | It accepts a list of integer values and display them as drop down |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
PrintMode(PrintMode)
It sets a value that indicates whether to define the number of pages to print
Declaration
public PageOptionsBuilder<T> PrintMode(PrintMode printMode)Parameters
| Type | Name | Description |
|---|---|---|
| PrintMode | printMode | It defines the number of pages to print |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
ShowDefaults()
It sets a value that indicates whether to enables default pager for the grid.
Declaration
public PageOptionsBuilder<T> ShowDefaults()Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
ShowDefaults(Boolean)
It sets a value that indicates whether to enables default pager for the grid.
Declaration
public PageOptionsBuilder<T> ShowDefaults(bool showDefaults)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showDefaults | It accepts the boolean value and enables or disables the default pager |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
Template(String)
It sets a value that indicates to add the template as a pager template for grid.
Declaration
public PageOptionsBuilder<T> Template(string templateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | templateId | It accepts the string as templateId to display the template |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
TotalPages(Int32)
Set the value of total number of pages in the grid. The totalPages value is calculated based on page size and total records of grid
Declaration
public PageOptionsBuilder<T> TotalPages(int totalPages)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | totalPages | It accepts the integer value and displays the value of total number of pages |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |
TotalRecordsCount(Int32)
Set the value of total number of records which is bound to the grid. The totalRecordsCount value is calculated based on dataSource bound to the grid.
Declaration
public PageOptionsBuilder<T> TotalRecordsCount(int totalRecordsCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | totalRecordsCount | It accepts the integer value and displays the total number of records |
Returns
| Type | Description |
|---|---|
| PageOptionsBuilder<T> | PageOptionsBuilder |