【下载文档: AspNetPager分页控件源代码(Version 4.2)第1_2页.txt 】
AspNetPager分页控件源代码(Version 4.2)第1/2页
//AspNetPager分页控件源代码(Version 4.2): using System; using System.IO; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.HtmlControls; using System.Collections.Specialized; using System.Text; using System.ComponentModel; using System.ComponentModel.Design; using System.Collections; namespace Wuqi.Webdiyer { #region AspNetPager Server Control #region 控件说明及示例 ///
/// 用于ASP.NET Web应用程序中对数据进行分页的的服务器控件。 /// ///
不同于DataGrid控件,AspNetPager分页控件本身并不显示任何数据,而只显示页导航元素,数据在页面上的显示方式与该控件无关。该控件可以为DataGrid、DataList、Repeater以及自定义控件进行分页,配合Sql存储过程,分页性能较使用DataGrid分页有明显提升,尤其是当数据量大时性能可提升数倍! /// AspNetPager 2.0 中新增了通过Url来分页的功能,这使得访问者可以直接输入相应的Url来访问任何页面,并且搜索引擎也可以直接检索每个页面,若使用DataGrid的分页功能,这是无法实现的。
/// 要使用 AspNetPager 分页控件,必须最少指定它的 属性,指定并编写 事件的处理程序。 /// 属性指定要分页的所有数据的总项数,若未指定该值或该值小于等于 ,则AspNetPager控件不会显示任何内容。 /// 若未指定并编写 事件处理程序,则当用户点击页导航元素或在页索引文本框中手式输入页索引并提交时AspNetPager不会跳转到指定的页。 /// AspNetPager控件的分页方法和DataGrid基本相同,即在它的 事件处理程序中将传递事件数据的 的 值赋给 AspNetPager的 属性,然后重新将新的数据与数据显示控件绑定。
///
以下示例说明如何用AspNetPager对DataGrid进行分页。 /// ///<%@ Import Namespace="System.Data"%> ///<%@Import Namespace="System.Data.SqlClient"%> ///<%@Import Namespace="System.Configuration"%> ///<%@Register TagPrefix="Webdiyer" Namespace="Wuqi.Webdiyer" Assembly="aspnetpager"%> /// /// ///Welcome to Webdiyer.com /// /// /// /// /// /// /// /// /// /// /// ]]> ///
/// 下面是该示例所用的Sql Server存储过程:
/// /// @PageLowerBound and t.id<=@PageUpperBound order by t.id /// end /// set nocount off ///GO /// ]]> ///
#endregion [DefaultProperty("PageSize")] [DefaultEvent("PageChanged")] [ParseChildren(false)] [PersistChildren(false)] [Description("专用于ASP.Net Web应用程序的分页控件")] [Designer(typeof(PagerDesigner))] [ToolboxData("<{0}:AspNetPager runat=server>{0}:AspNetPager>")] public class AspNetPager:Panel,INamingContainer,IPostBackEventHandler,IPostBackDataHandler { private string cssClassName; private string urlPageIndexName="page"; private bool urlPaging=false; private string inputPageIndex; private string currentUrl=null; private NameValueCollection urlParams=null; #region Properties #region Navigation Buttons ///
/// 获取或设置一个值,该值批示当鼠标指针悬停在导航按钮上时是否显示工具提示。 /// [Browsable(true), Category("导航按钮"), DefaultValue(true), Description("指定当鼠标停留在导航按钮上时,是否显示工具提示")] public bool ShowNavigationToolTip { get { object obj=ViewState["ShowNavigationToolTip"]; return (obj==null)?true:(bool)obj; } set { ViewState["ShowNavigationToolTip"]=value; } } ///
/// 获取或设置导航按钮工具提示文本的格式。 /// [Browsable(true), Category("导航按钮"), DefaultValue("转到第{0}页"), Description("页导航按钮工具提示文本的格式")] public string NavigationToolTipTextFormatString { get { object obj=ViewState["NavigationToolTipTextFormatString"]; return (obj==null)?"转到第{0}页":(string)obj; } set { string tip=value; if(tip.Trim().Length<1&&tip.IndexOf("{0}")<0) tip="{0}"; ViewState["NavigationToolTipTextFormatString"]=tip; } } ///
/// 获取或设置一个值,该值指示是否将页索引按钮用中文数字代替。 /// ///
/// 将该值设为true并且未使用图片按钮时,页索引按钮中的数值1、2、3等将会被中文字符一、二、三等代替。 /// [Browsable(true), Category("导航按钮"), DefaultValue(false), Description("是否将页索引数值按钮用中文数字一、二、三等代替")] public bool ChinesePageIndex { get { object obj=ViewState["ChinesePageIndex"]; return (obj==null)?false:(bool)obj; } set { ViewState["ChinesePageIndex"]=value; } } ///
/// 获取或设置页索引数值导航按钮上文字的显示格式。 /// ///
/// 字符串,指定页索引数值按钮上文字的显示格式,默认值为,即未设置该属性。 ///
/// 使用NumericButtonTextFormatString属性指定页索引数值按钮的显示格式,如未设置该值时索引按钮文本将会是:1 2 3 ...,设置该值将改变索引按钮文本的显示格式, /// 如将该值设为“[{0}]”则索引文本会显示为:[1] [2] [3] ...,将该值设为“-{0}-”则会使索引文本变为:-1- -2- -3- ...。 /// [Browsable(true), DefaultValue(""), Category("导航按钮"), Description("页索引数值按钮上文字的显示格式")] public string NumericButtonTextFormatString { get { object obj=ViewState["NumericButtonTextFormatString"]; return (obj==null)?String.Empty:(string)obj; } set { ViewState["NumericButtonTextFormatString"]=value; } } ///
/// 获取或设置分页导航按钮的类型,即使用文字还是图片。 /// ///
/// 要使用图片按钮,您需要准备以下图片:从0到9的十个数值图片(当ShowPageIndex设为true时),第一页、上一页、下一页、最后一页及更多页(...)五个按钮图片(当ShowFirstLast及ShowPrevNext都设为true时), /// 若需要使当前页索引的数值按钮不同于别的页索引数值按钮,则还需准备当前页索引的按钮图片; /// 若需要使已禁用的第一页、上一页、下一页及最后一页按钮图片不同于正常的按钮图片,则还需准备这四个按钮在禁用状态下的图片; /// 图片文件的命名规则如下:
/// 从0到9十张数值按钮图片必须命名为“数值+ButtonImageNameExtension+ButtonImageExtension”,其中的ButtonImageNameExtension可以不用设置, /// ButtonImageExtension是图片文件的后缀名,如 .gif或 .jpg等可以在浏览器中显示的任何图片文件类型。如页索引“1”的图片文件可命名为“1.gif”或“1.jpg”, /// 当您有两套或更多套图片文件时,可以通过指定ButtonImageNameExtension属性值来区分不同套的图片,如第一套图片可以不用设ButtonImageNameExtension,则图片文件名类似于“1.gif”、“2.gif”等等,而第二套图片则设置ButtonImageNameExtension为“f”,图片文件名类似于“1f.gif”,“2f.gif”等等。
/// 第一页按钮的图片文件名以“first”开头,上一页按钮图片名以“prev”开头,下一页按钮图片名以“next”开头,最后一页按钮图片名以“last”开头,更多页按钮图片名以“more”开头,是否使用ButtonImageNameExtension取决于数值按钮的设置及是否有更多套图片。
/// ///
/// 以下代码片段示例如果使用图片按钮: /// /// /// ]]> ///
///
/// [Browsable(true), DefaultValue(PagingButtonType.Text), Category("导航按钮"), Description("分页导航按钮的类型,是使用文字还是图片")] public PagingButtonType PagingButtonType { get { object obj=ViewState["PagingButtonType"]; return (obj==null)?PagingButtonType.Text:(PagingButtonType)obj; } set { ViewState["PagingButtonType"]=value; } } ///
/// 获取或设置页导航数值按钮的类型,该值仅当PagingButtonType设为Image时才有效。 /// ///
/// 当您将PagingButtonType设为Image当又不想让页索引数值按钮使用图片时,可以将该值设为Text,这会使页索引数据按钮使用文本而不是图片按钮。 /// [Browsable(true), DefaultValue(PagingButtonType.Text), Category("导航按钮"), Description("页导航数值按钮的类型")] public PagingButtonType NumericButtonType { get { object obj=ViewState["NumericButtonType"]; return (obj==null)?PagingButtonType:(PagingButtonType)obj; } set { ViewState["NumericButtonType"]=value; } } ///
/// 获取或设置第一页、上一页、下一页和最后一页按钮的类型,该值仅当PagingButtonType设为Image时才有效。 /// ///
/// 当您将PagingButtonType设为Image但又不想让第一页、下一页、下一页和最后一页按钮使用图片,则可以将该值设为Text,这会使前面的四个按钮使用文本而不是图片按钮。 /// [Browsable(true), Category("导航按钮"), DefaultValue(PagingButtonType.Text), Description("第一页、上一页、下一页和最后一页按钮的类型")] public PagingButtonType NavigationButtonType { get { object obj=ViewState["NavigationButtonType"]; return (obj==null)?PagingButtonType:(PagingButtonType)obj; } set { ViewState["NavigationButtonType"]=value; } } ///
/// 获取或设置“更多页”(...)按钮的类型,该值仅当PagingButtonType设为Image时才有效。 /// ///
/// 当您将PagingButtonType设为Image但又不想让更多页(...)按钮使用图片时,可以将此值设为Text,这会使更多页按钮使用文本而不是图片按钮。 /// [Browsable(true), Category("导航按钮"), DefaultValue(PagingButtonType.Text), Description("“更多页”(...)按钮的类型")] public PagingButtonType MoreButtonType { get { object obj=ViewState["MoreButtonType"]; return (obj==null)?PagingButtonType:(PagingButtonType)obj; } set { ViewState["MoreButtonType"]=value; } } ///
/// 获取或设置分页导航按钮之间的间距。 /// [Browsable(true), Category("导航按钮"), DefaultValue(typeof(Unit),"5px"), Description("分页导航按钮之间的间距")] public Unit PagingButtonSpacing { get { object obj=ViewState["PagingButtonSpacing"]; return (obj==null)?Unit.Pixel(5):(Unit.Parse(obj.ToString())); } set { ViewState["PagingButtonSpacing"]=value; } } ///
/// 获取或设置一个值,该值指示是否在页导航元素中显示第一页和最后一页按钮。 /// [Browsable(true), Description("是否在页导航元素中显示第一页和最后一页按钮"), Category("导航按钮"), DefaultValue(true)] public bool ShowFirstLast { get { object obj=ViewState["ShowFirstLast"]; return (obj==null)?true:(bool)obj; } set{ViewState["ShowFirstLast"]=value;} } ///
/// 获取或设置一个值,该值指示是否在页导航元素中显示上一页和下一页按钮。 /// [Browsable(true), Description("是否在页导航元素中显示上一页和下一页按钮"), Category("导航按钮"), DefaultValue(true)] public bool ShowPrevNext { get { object obj=ViewState["ShowPrevNext"]; return (obj==null)?true:(bool)obj; } set{ViewState["ShowPrevNext"]=value;} } ///
/// 获取或设置一个值,该值指示是否在页导航元素中显示页索引数值按钮。 /// [Browsable(true), Description("是否在页导航元素中显示数值按钮"), Category("导航按钮"), DefaultValue(true)] public bool ShowPageIndex { get { object obj=ViewState["ShowPageIndex"]; return (obj==null)?true:(bool)obj; } set{ViewState["ShowPageIndex"]=value;} } ///
/// 获取或设置为第一页按钮显示的文本。 /// [Browsable(true), Description("第一页按钮上显示的文本"), Category("导航按钮"), DefaultValue("
9")] public string FirstPageText { get { object obj=ViewState["FirstPageText"]; return (obj==null)?"
9":(string)obj; } set{ViewState["FirstPageText"]=value;} } ///
/// 获取或设置为上一页按钮显示的文本。 /// [Browsable(true), Description("上一页按钮上显示的文本"), Category("导航按钮"), DefaultValue("
3")] public string PrevPageText { get { object obj=ViewState["PrevPageText"]; return (obj==null)?"
3":(string)obj; } set{ViewState["PrevPageText"]=value;} } ///
/// 获取或设置为下一页按钮显示的文本。 /// [Browsable(true), Description("下一页按钮上显示的文本"), Category("导航按钮"), DefaultValue("
4")] public string NextPageText { get { object obj=ViewState["NextPageText"]; return (obj==null)?"
4":(string)obj; } set{ViewState["NextPageText"]=value;} } ///
/// 获取或设置为最后一页按钮显示的文本。 /// [Browsable(true), Description("最后一页按钮上显示的文本"), Category("导航按钮"), DefaultValue("
:")] public string LastPageText { get { object obj=ViewState["LastPageText"]; return (obj==null)?"
:":(string)obj; } set{ViewState["LastPageText"]=value;} } ///
/// 获取或设置在 控件的页导航元素中同时显示的数值按钮的数目。 /// [Browsable(true), Description("要显示的页索引数值按钮的数目"), Category("导航按钮"), DefaultValue(10)] public int NumericButtonCount { get { object obj=ViewState["NumericButtonCount"]; return (obj==null)?10:(int)obj; } set{ViewState["NumericButtonCount"]=value;} } ///
/// 获取或设置一个值,该值指定是否显示已禁用的按钮。 /// ///
/// 该值用来指定是否显示已禁用的分页导航按钮,当当前页为第一页时,第一页和上一页按钮将被禁用,当当前页为最后一页时,下一页和最后一页按钮将被禁用,被禁用的按钮没有链接,在按钮上点击也不会有任何作用。 /// [Browsable(true), Category("导航按钮"), Description("是否显示已禁用的按钮"), DefaultValue(true)] public bool ShowDisabledButtons { get { object obj=ViewState["ShowDisabledButtons"]; return (obj==null)?true:(bool)obj; } set { ViewState["ShowDisabledButtons"]=value; } } #endregion #region Image Buttons ///
/// 获取或设置当使用图片按钮时,图片文件的路径。 /// [Browsable(true), Category("图片按钮"), Description("当使用图片按钮时,指定图片文件的路径"), DefaultValue(null)] public string ImagePath { get { string imgPath=(string)ViewState["ImagePath"]; if(imgPath!=null) imgPath=this.ResolveUrl(imgPath); return imgPath; } set { string imgPath=value.Trim().Replace("\\","/"); ViewState["ImagePath"]=(imgPath.EndsWith("/"))?imgPath:imgPath+"/"; } } ///
/// 获取或设置当使用图片按钮时,图片的类型,如gif或jpg,该值即图片文件的后缀名。 /// [Browsable(true), Category("图片按钮"), DefaultValue(".gif"), Description("当使用图片按钮时,图片的类型,如gif或jpg,该值即图片文件的后缀名")] public string ButtonImageExtension { get { object obj=ViewState["ButtonImageExtension"]; return (obj==null)?".gif":(string)obj; } set { string ext=value.Trim(); ViewState["ButtonImageExtension"]=(ext.StartsWith("."))?ext:("."+ext); } } ///
/// 获取或设置自定义图片文件名的后缀字符串,以区分不同类型的按钮图片。 /// ///
注意:该值不是文件后缀名,而是为区分不同的图片文件而在图片名中加入的字符串,如: /// 当前有两套按钮图片,其中一套中的“1”的图片名可为“1f.gif”,另一套中的“1”的图片名可起为“1n.gif”,其中的f和n即为ButtonImageNameExtension。 [Browsable(true), DefaultValue(null), Category("图片按钮"), Description("自定义图片文件名的后缀字符串(非文件后缀名),如图片“1f.gif”的ButtonImageNameExtension即为“f”")] public string ButtonImageNameExtension { get { return (string)ViewState["ButtonImageNameExtension"]; } set { ViewState["ButtonImageNameExtension"]=value; } } ///
/// 获取或设置当前页索引按钮的图片名后缀。 /// ///
/// 当 设为 Image 时,该属性允许您设置当前页索引数值按钮使用的图片名后缀字符,因此可以使当前页索引按钮与其它页索引按钮使用不同的图片,若未设置该值,则默认值为,即当前页索引按钮与其它页索引按钮使用相同的图片。 /// [Browsable(true), DefaultValue(null), Category("图片按钮"), Description("当前页索引按钮的图片名后缀字符串")] public string CpiButtonImageNameExtension { get { object obj=ViewState["CpiButtonImageNameExtension"]; return (obj==null)?ButtonImageNameExtension:(string)obj; } set { ViewState["CpiButtonImageNameExtension"]=value; } } ///
/// 获取或设置已禁用的页导航按钮图片名后缀字符串。 /// ///
/// 当 设为 Image 时, 该值允许您设置已禁用(即没有链接,因而点击后无反应)的页导航按钮(包括第一页、上一页、下一页、最后一页四个按钮)的图片文件名后缀字符串,因此可以使已禁用的页导航按钮不同于正常的页导航按钮。若未设置该值,则默认值为,即已禁用的页导航按钮与正常的页导航按钮使用相同的图片。 /// [Browsable(true), DefaultValue(null), Category("图片按钮"), Description("已禁用的页导航按钮的图片名后缀字符串")] public string DisabledButtonImageNameExtension { get { object obj=ViewState["DisabledButtonImageNameExtension"]; return (obj==null)?ButtonImageNameExtension:(string)obj; } set { ViewState["DisabledButtonImageNameExtension"]=value; } } ///
/// 指定当使用图片按钮时,图片的对齐方式。 /// [Browsable(true), Description("指定当使用图片按钮时,图片的对齐方式"), DefaultValue(ImageAlign.Baseline), Category("图片按钮")] public ImageAlign ButtonImageAlign { get { object obj=ViewState["ButtonImageAlign"]; return (obj==null)?ImageAlign.Baseline:(ImageAlign)obj; } set{ViewState["ButtonImageAlign"]=value;} } #endregion #region Paging ///
/// 获取或设置是否启用url来传递分页信息。 /// ///
/// 启用Url分页方式是将用户欲访问的页索引通过Url来传递,由于该分页方式不使用页面向自身回发来传递数据, /// 所以每次分页时所有的数据都恢复为初始值或需要重新获取。使用Url分页方式不支持动态改变分页控件的属性值, /// 因暂时无法将新的属性值通过Url来传递给下一页。 /// ///
以下示例说明如何用AspNetPager的Url分页方式对DataGrid进行分页(使用Access数据库): /// ///<%@Import Namespace="System.Data.OleDb"%> ///<%@ Import Namespace="System.Data"%> ///<%@ Page Language="C#" debug=true%> /// /// /// Welcome to Webdiyer.com /// /// /// /// /// /// /// /// /// /// /// ]]>
/// [Browsable(true), Category("分页"), DefaultValue(false), Description("是否使用url传递分页信息的方式来分页")] public bool UrlPaging { get { return urlPaging; } set { urlPaging=value; } } ///
/// 获取或设置当启用Url分页方式时,在url中表示要传递的页索引的参数的名称。 /// ///
/// 该属性允许您自定义通过Url传递页索引时表示要传递的页索引的参数的名称,以避免与现有的参数名重复。 /// 该属性的默认值是“page”,即通过Url分页时,显示在浏览器地址栏中的Url类似于:
http://www.webdiyer.com/aspnetpager/samples/datagrid_url.aspx?page=2 /// 如将该值改为“pageindex”,则上面的Url将变为:
http://www.webdiyer.com/aspnetpager/samples/datagrid_url.aspx?pageindex=2
/// [Browsable(true), DefaultValue("page"), Category("分页"), Description("当启用Url分页方式时,显示在url中表示要传递的页索引的参数的名称")] public string UrlPageIndexName { get{return urlPageIndexName;} set{urlPageIndexName=value;} } ///
/// 获取或设置当前显示页的索引。 /// ///
使用此属性来确定在 AspNetPager 控件中当前显示的页,当前显示的页的数字索引将以红色字体加粗显示。此属性还用于以编程的方式控制所显示的页。 /// 注意:不同于DataGrid控件的CurrentPageIndex,AspNetPager的CurrentPageIndex属性是从1开始的。
[ReadOnly(true), Browsable(false), Description("当前显示页的索引"), Category("分页"), DefaultValue(1), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public int CurrentPageIndex { get { object cpage=ViewState["CurrentPageIndex"]; int pindex=(cpage==null)?1:(int)cpage; if(pindex>PageCount&&PageCount>0) return PageCount; else if(pindex<1) return 1; return pindex; } set { int cpage=value; if(cpage<1) cpage=1; else if(cpage>this.PageCount) cpage=this.PageCount; ViewState["CurrentPageIndex"]=cpage; } } ///
/// 获取或设置需要分页的所有记录的总数。 /// ///
/// 当页面第一次加载时,应以编程方式将从存储过程或Sql语句中返回的数据表中所有要分页的记录的总数赋予该属性,AspNetPager会将其保存的ViewState中并在页面回发时从ViewState中获取该值,因此避免了每次分页都要访问数据库而影响分页性能。AspNetPager根据要分页的所有数据的总项数和 属性来计算显示所有数据需要的总页数,即 的值。 /// ///
/// 下面的示例显示如何以编程方式将从Sql语句返回的记录总数赋给该属性: /// /// /// /// Welcome to Webdiyer.com /// /// /// /// /// /// /// /// /// ///