ASP.NET WebForm也玩强类型URL调用之二:PageMethods的基本使用

在熟悉了PageMethods的基本介绍后,我们来看一个简单的示例程序,这个示例程序很简单,只有两个网页。第一个页面是客户详情编辑页面,叫做FrtmCustomer.aspx,第二个页面叫做ListCustomer.aspx,用来显示客户列表。虽然这个示例程序很简单,但用来说明PageMethods的基本使用却是很合适的,现在让我们来一步步构建这个示例程序。

步骤一:创建FrmCustomer页面

首先我们需要确定安装在VS2008中的PageMethods插件是被激活的。

然后我们创建一个ASP.NET WebSite项目(当然你也可以创建Web Application)

创建网站后,添加一个名叫"FrmCustomer.aspx"新Web Form 。

然后在新添加的Web Form中构造一个用来编辑客户ID、姓名、国家的界面,三个文本框的ID分别为txtID,txtName,txtCountry,界面如下:

然后我们在后台代码中添加用来完成新建和编辑客户的代码:

直到现在我们一直按照标准的方法来实现,还没有和PageMethods产生关系, 但从这一步我们就要用到PageMethods里面的东西了,我们需要给上面的两个方法添加PageMethods属性,这需要引用PageMethods类库(位于PageMethods.dll程序集中)。

在添加类库引用时请确保添加的是.NET2.0版本的,在添加完类库引用后,在FrmCustomer的后台类中引入MetaSapiens.PageMethods命名空间。

引入命名空间后,在方法上标注PageMethods属性。

在标注完属性后,我们还需要做一件事情,就是在页面的Page_Load方法中加入如下代码:

然后我们在项目的属性窗口中将PageMethodsEnabled属性设为true.

最后我们在配置文件中注册PageMethods的生成提供器(当然如果你选择的是Web Application,这步可以省略)

<?xml version="1.0"?>
<configuration >
  <appSettings />
  <system.web>
    <compilation debug="true">
      <buildProviders>
        <add
    extension=".xml"
type="MetaSapiens.PageMethods.PageMethodsBuildProvider, PageMethods" />
      </buildProviders>
    </compilation>
  </system.web>

</configuration>

在做完了上面所有的操作后,编译代码,PageMethods将会在App_Code目录下自动生成一个叫做PageList.xml的文件,这里面包含了PageMethods要用到的代码,请不要手工编辑它。

步骤二:引用FrmCustomer页面

在定义完FrmCustomer页面后我们就需要调用它,一般来说我们我们通过HTML锚标记(<a href=…> )或是给ASP.NET HyperLink的NavigateUrl赋一个静态值来调用页面,但是在PageMethods中,我们通过后台代码来调用页面,这会带来编译时检查并保证链接是正确的。

下面让我们在Default.aspx页面中添加一个HyperLink控件

在Default.aspx的后台类中加入下面的代码以调用FrmCustomer页面:

请注意我们在编写上面的代码时是可以使用智能提示的,所以说使用上面的方式调用页面是简单且有效的,因为我们不但可以利用智能提示知道都有哪些页面和参数,还能使用编译时检查来确保调用是正确的。

做完了上面的步骤后,就可以在浏览器中打开Default.aspx页面来验证了,但是请注意,如果你使用的不是IE浏览器,请不要选择"NTLM Authentication"。

步骤三:改进FrmCustomer页面

PageMethods还提供了一些其它的属性,比如我们可以利用ParamRequired属性来声明一个引用类型(比如string)的参数是必须的,我们不能对值类型的参数应用ParamRequired属性,因为值类型的参数值不能为null.

在应用了ParamRequired属性的,如果在调用时没有传递值就会引发异常。

如果我们想重定义参数的名称,我们可以使用ParamName属性

对些一些类型的参数(如时间型、整型)我们还可以利用ParamFormat属性来定义参数的格式。

步骤四:实现ListCustomer页面

ListCustomer页面包含了客户的列表,我们新建一个叫做ListCustomer.aspx的Web Form并添加一个DataList控件。

然后编辑DataList控件的模板

在ItemTemplate中加入一个HyperLink控件

然后我们创建用来绑定数据的强类型DataSet

注意我们不需要任何数据连接或是TableAdapter对象,我们只需要定义一个叫做"Customer"的数据表,"Customer"表格有三个字段: CustID (System.Int32), Name (System.String), Country (System.String)。

现在让我们来模拟一些数据

然后给DataList控件的ItemDataBound事件添加处理程序

经过上面的步骤后我们就可以在浏览器中测试ListCustomer页面了。

更多特性

页面基类

你可能会注意到我们在FrmCustomer的Page_Load事件中调用了PageMethodsEngine.InvokeMethod() 方法,实际上你完全可以将这个调用放到自定义的基类中,或者是直接让你的页面类继承自MetaSapiens.PageMethods.BasePage类中。

默认方法

PageMethods还有一个额外的特性叫做默认方法,如果一个页面只有一个方法或是有一个主方法,我们可以在方法上引用[PageMethod(true)]属性来代替[PageMethod],这样会将方法设为默认方法,其结果是我们在调用方法时不需要在URL上添加参数。

URL格式化

如果你在项目中应用了URL重写,你可以提供给PageMethods一个格式化字符串来格式化你的URL,下面是一个示例:

上面代码的引用链接一般是" http://myserver/PageMethodsTutorial/Pages/FrmCustomer.aspx?PageMethod=EditCustomer&CustomerID=12"形式的,但当我们像下图一样应用了PageMethods.UrlFormat属性后,链接会变成"http://myserver/PageMethodsTutorial/Customer12.aspx"的形式。

了解更多

关于PageMethods的更多特性,你可以访问PageMethods的主页

原文地址:https://www.cnblogs.com/zhangronghua/p/PageMethodsUsage.html