System.Web 2.0.0.0 System.Object System.Web.UI.IStateManager System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))

Controls that support pagination (such as the , , and controls) can display a set of controls called the pager that allows the user to navigate the pages within the control. The class is used by these controls to represent the properties of the pager. In general, the object is stored in the PagerSettings property of the control. You can customize the pager by setting the properties of the object.

The pager supports several different display modes. To specify the mode in which to display the pager, set the property. The following table describes the different modes.

Mode

Description

Previous-page and next-page buttons.

Previous-page, next-page, first-page, and last -page buttons.

Numbered link buttons to access pages directly.

Numbered-link, first-link, and last-link buttons.

When the property is set to the , , or value you can customize the text of the non-numeric buttons by setting the properties shown in the following table.

Property

Description

Text for the first-page button.

Text for the previous-page button.

Text for the next-page button.

Text for the last-page button.

As an alternative, you can also display images for the non-numeric buttons by setting the properties as shown in the following table.

Property

Description

The URL to an image to display for the first-page button.

The URL to an image to display for the previous-page button.

The URL to an image to display for the next-page button.

The URL to an image to display for the last-page button.

When an image property is set, the corresponding text property acts as the alternate text for the image. For example, when the property is set, the text that is specified by the property is displayed as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

When the property is set to the or value, you can specify the number of page buttons to display in the pager by setting the property.

The pager can be displayed at the top, the bottom, or both the top and bottom of a control. To specify the position of the pager, set the property. To show or hide the pager, use the property.

Represents the properties of the paging controls in a control that supports pagination. This class cannot be inherited.

- Constructor

  Use the constructor to create a new instance of the class.

  The constructor generally is used by control developers when providing paging support in a custom control.

  Initializes a new instance of the class.

  2.0.0.0
- Property
  System.ComponentModel.Editor("System.Web.UI.Design.ImageUrlEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")
  System.ComponentModel.DefaultValue("")
  System.Web.UI.UrlProperty
  System.ComponentModel.NotifyParentProperty(true)
  System.String To be added.

  When the property is set to the or value, use the property to specify the URL to an image to display for the first-page button.

  As an alternative, you can display text for the first-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the URL to an image to display for the first-page button.

  2.0.0.0
- Property
  System.ComponentModel.NotifyParentProperty(true)
  System.ComponentModel.DefaultValue("&lt;&lt;")
  System.String To be added.

  When the property is set to the or value, use the property to specify the text to display for the first-page button.

  As an alternative, you can display an image for the first-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the text to display for the first-page button.

  2.0.0.0
- Property
  System.ComponentModel.Editor("System.Web.UI.Design.ImageUrlEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")
  System.ComponentModel.DefaultValue("")
  System.Web.UI.UrlProperty
  System.ComponentModel.NotifyParentProperty(true)
  System.String To be added.

  When the property is set to the or value, use the property to specify the URL to an image to display for the last-page button.

  As an alternative, you can simply display text for the last-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the URL to an image to display for the last-page button.

  2.0.0.0
- Property
  System.ComponentModel.DefaultValue("&gt;&gt;")
  System.ComponentModel.NotifyParentProperty(true)
  System.String To be added.

  When the property is set to the or value, use the property to specify the text to display for the last-page button.

  As an alternative, you can display an image for the last-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the text to display for the last-page button.

  2.0.0.0
- Property
  System.ComponentModel.DefaultValue(System.Web.UI.WebControls.PagerButtons.Numeric)
  System.ComponentModel.NotifyParentProperty(true)
  System.Web.UI.WebControls.PagerButtons To be added.

  Controls that support pagination provide multiple modes in which to display the paging controls. Use the property to specify the mode. The following table describes the different modes for pagination controls.

  Mode

  Description

  Previous-page and next-page buttons.

  Previous-page, next-page, first-page, and last-page buttons.

  Numbered link buttons to access pages directly.

  Numbered and first-link and last-link buttons.

  When the property is set to the , , or value, you can specify custom text for the non-numeric buttons by setting the properties shown in the following table.

  Property

  Description

  Text for the first-page button.

  Text for the previous-page button.

  Text for the next-page button.

  Text for the last-page button.

  As an alternative, you can also display images for the non-numeric buttons by setting the properties shown in the following table.

  Property

  Description

  The URL to an image to display for the first-page button.

  The URL to an image to display for the previous-page button.

  The URL to an image to display for the next-page button.

  The URL to an image to display for the last-page button.

  When an image property is set, the corresponding text property acts as the alternate text for the image. For example, when the property is set, the text that is specified by the property is displayed as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the mode in which to display the pager controls in a control that supports pagination.

  2.0.0.0
- Property
  System.ComponentModel.Editor("System.Web.UI.Design.ImageUrlEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")
  System.ComponentModel.DefaultValue("")
  System.Web.UI.UrlProperty
  System.ComponentModel.NotifyParentProperty(true)
  System.String To be added.

  When the property is set to the or value, use the property to specify the URL to an image to display for the next-page button.

  As an alternative, you can simply display text for the next-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the URL to an image to display for the next-page button.

  2.0.0.0
- Property
  System.ComponentModel.DefaultValue("&gt;")
  System.ComponentModel.NotifyParentProperty(true)
  System.String To be added.

  When the property is set to the or value, use the property to specify the text to display for the next-page button.

  As an alternative, you can display an image for the next-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the text to display for the next-page button.

  2.0.0.0
- Property
  System.ComponentModel.DefaultValue(10)
  System.ComponentModel.NotifyParentProperty(true)
  System.Int32 To be added.

  When the property is set to the or value, use the property to specify the number of page buttons to display in the pager.

  The value of this property is stored in view state.

  Gets or sets the number of page buttons to display in the pager when the property is set to the or value.

  2.0.0.0
- Property
  System.ComponentModel.NotifyParentProperty(true)
  System.ComponentModel.DefaultValue(System.Web.UI.WebControls.PagerPosition.Bottom)
  System.Web.UI.WebControls.PagerPosition To be added.

  Use the property to specify the location at which to display the pager. The following table describes the different positions.

  Position

  Location

  The bottom of the control.

  The top of the control.

  At both the top and bottom of the control.

  The value of this property is stored in view state.

  Gets or sets a value that specifies the location where the pager is displayed.

  2.0.0.0
- Property
  System.ComponentModel.Editor("System.Web.UI.Design.ImageUrlEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")
  System.ComponentModel.DefaultValue("")
  System.Web.UI.UrlProperty
  System.ComponentModel.NotifyParentProperty(true)
  System.String To be added.

  When the property is set to the or value, use the property to specify the URL to an image to display for the previous-page button.

  As an alternative, you can display text for the previous-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the URL to an image to display for the previous-page button.

  2.0.0.0
- Property
  System.ComponentModel.NotifyParentProperty(true)
  System.ComponentModel.DefaultValue("&lt;")
  System.String To be added.

  When the property is set to the or value, use the property to specify the text to display for the previous-page button.

  As an alternative, you can display an image for the previous-page button by setting the property instead of the property. If the and properties are both set, the image is displayed with the property acting as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button.

  The value of this property is stored in view state.

  Gets or sets the text to display for the previous page button.

  2.0.0.0
- Event
  System.EventHandler

  The event is raised each time a property of a object changes values. The event commonly is used by data-bound controls that support pagination to rebind the data to the control when the pager settings change.

  For more information about handling events, see Consuming Events.

  Occurs when a property of a object changes values.

  2.0.0.0
- Property
  2.0.0.0
  System.Boolean To be added.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to the interface.

  Gets a value that indicates whether the server control is tracking its view state changes.

- Method
  2.0.0.0
  System.Void `` To be added.

  Use the method to load the previously saved view state of the object.

  The method is private and cannot be called.

  Loads the previously saved view state of the object.

- Method
  2.0.0.0
  System.Object

  The method is a helper method that is used by the class to save the state of the object.

  The method is private and cannot be called.

  Saves the current view state of the object.

  An object that contains the saved state of the .

- Method
  2.0.0.0
  System.Void

  The method is overridden to mark the starting point at which to begin tracking and saving changes to the object as part of the view state for the object.

  The method is private and cannot be called.

  Marks the starting point at which to begin tracking and saving view state changes to the object.

- Method
  System.String

  The method is used to retrieve a string representation of a object. The method has been overridden to always return an empty string.

  Retrieves the string representation of a object.

  An empty string ("").

  2.0.0.0
- Property
  System.ComponentModel.NotifyParentProperty(true)
  System.ComponentModel.DefaultValue(true)
  System.Boolean To be added.

  Use the property to specify whether the paging controls are displayed in a control that supports pagination. To hide the paging controls, set the property to false.

  The value of this property is stored in view state.

  Gets or sets a value indicating whether the paging controls are displayed in a control that supports pagination.

  2.0.0.0