WebParts常用使用手册

1、webparts把网页隔成了一个一个更小的空间。现在很多网站都使用webparts。vs2005控件图webpartmanagerwebpartmanager控件是 web 部件控件集的核心控件，用于管理所有 web 部件控件、web 部件功能和 web 部件事件。必须向使用 web 部件控件的每个页添加一个（仅仅一个）webpartmanager控件。webpartmanager控件只能由通过身份验证的用户使用。webpartmanger 任务下表列出了由 webpartmanager控件执行的任务。任务 控件功能 管理 web 部件控件管理页上提供 web 部件功能的控件，包括 webpa

2、rt 控件、连接控件、区域控件及其他控件。添加和移除 web 部件控件提供在页上添加、删除和关闭 webpart控件的方法。管理连接添加和移除控件之间的连接。监视连接以查找问题。对控件和页进行个性化设置使用户可以将控件移到页上，并启动用户可以在其中编辑控件的外观、属性和行为的视图。维护每一页上的用户特定的个性化设置。在页面视图之间切换在页面视图之间切换，使用户能够执行任务，例如更改页面布局或编辑控件。引发 web 部件生命周期事件定义并引发 web 部件控件的生命周期事件，例如在添加、移动、连接或删除控件时的事件。启用控件的导入和导出导出包含 webpart控件属性的状态的 xml 流，并允许

3、用户导入文件以便对其他页或站点中的复杂控件进行个性化设置。 将 web 部件控件与 webpartmanager 关联若要将 web 部件控件与 webpartmanager关联，需要将 web 部件控件放入 webpartzone 控件区域，还必须在同一页中放入一个 webpartmanager控件。proxywebpartmanager当在内容页的关联母版页中声明了 webpartmanager 控件时，即可利用 proxywebpartmanager 控件在内容页中声明静态连接。一个使用 web 部件控件的网页必须包含且只能包含一个 webpartmanager控件，该控件用于管理该页上

4、的所有 web 部件控件。当 web 部件应用程序使用母版页时，通常将 webpartmanager控件放在母版页中。如果内容页与母版页在运行时相合并，单个 webpartmanager控件即可管理所有内容页上的 web 部件控件。若要声明静态连接，通常需要将 元素添加为 元素的子元素，而后者本身又必须是 元素的子元素。但是，如果您使用的是母版页，并将 webpartmanager控件放在母版页中，您将无法在内容页中创建 元素；只允许存在一个 webpartmanager控件。此时的解决方案是：在内容页上使用 proxywebpartmanager控件来代替 webpartmanager控件。

5、在运行时，proxywebpartmanager控件中的连接会被添加到 webpartmanager控件的 staticconnections 集合中，并被视为与任何其他连接等同。有关演示如何使用 proxywebpartmanager类的代码示例，请参见 system.web.ui.webcontrols.webparts.proxywebpartmanager的“示例”部分。proxywebpartmanager 控件与 webmanagercontrol 之间需要注意的差异只有在母版页中创建了 webpartmanager控件并要在内容页中声明静态连接时才使用 proxywebpartm

6、anager控件。因此，proxywebpartmanager控件与 webpartmanager控件相比功能要受到更多限制。虽然 proxywebpartmanager控件充当的是旨在包含内容页中 webpartmanager控件的静态连接的代理，但它并不是继承自 webpartmanager控件。它直接继承自 control 类，并且只重写了几个基成员。webpartzonewebpartzone控件用作 web 部件控件集中用于承载网页上的 webpart 控件的主要控件，并为其包含的控件提供公共 ui。webpartzone控件从基类 webzone 中继承用户界面元素，并为其包含的控

7、件提供公共 ui。这些公共 ui 元素统称为镶边，由所有控件上的外围 ui 元素组成，这些元素包括：边框、标题、页眉和页脚、样式特性以及谓词（即用户可以在控件上执行的 ui 操作，如关闭或最小化）等。catalogzoneweb 部件控件（例如 catalogzone 控件）的一项主要功能是可以让最终用户个性化网页并保存其个性化设置。catalogzone控件允许最终用户在运行时向 web 部件页添加 webpart 控件或其他服务器控件。catalogzone控件用作 web 部件控件集内的主控件，用于在网页中承载 catalogpart 控件。 仅当用户将网页切换至目录显示模式 (cata

8、logdisplaymode) 时，catalogzone控件才变为可见。有关演示如何使用 catalogzone控件的代码示例.catalogzone web 服务器控件附带的 catalogpart 控件由 catalogzone控件创建的区域可以包含多种 catalogpart控件。每个 catalogpart控件都是一种容器，其中包含用户可添加至页面的服务器控件。catalogpart控件因其包含的服务器控件的来源而不同。declarativecatalogpartdeclarativecatalogpart控件使您能够将 webpart 或其他服务器控件的目录添加到网页中，同时也使用

9、户能够在运行时更改页面上的控件集和功能。目录是 webpart或其他服务器控件的列表，当页面处于目录显示模式时，该列表是可见的。在设计时，您可以将控件添加到 declarativecatalogpart控件中；在运行时，用户可以选择要在页面中查看的控件，方法是从目录列表中进行选择。有关更多信息，请参见 asp.net web 部件页。注意 当用户在运行时从控件目录中选择控件时，declarativecatalogpart控件会将控件的新实例添加到网页中。用户可以将目录中同一控件的多个实例添加到网页中。启用 declarativecatalogpart web 服务器控件必须将 declarat

10、ivecatalogpart放在 catalogzonebase 区域中，如 catalogzone 区域。仅当网页处于目录显示模式时 declarativecatalogpart控件才变为可见。有关演示如何使用 catalogzone控件的代码示例，请参见 catalogzone web 服务器控件声明性语法和 catalogzone中的“示例”一节。创建控件的应用程序范围的目录declarativecatalogpart 使您能够设置可在整个站点中使用的控件目录。您可以将 webpartslistusercontrolpath 属性设置为用户控件（包含目录中的服务器控件列表）的路径，而不是

11、在 declarativecatalogpart控件中声明单独的服务器控件。在运行时，用户控件中引用的服务器控件在目录中加载。此策略使多个页面或站点能够引用相同的用户控件来创建目录。当用户控件中的服务器控件列表更新时，将更新基于该用户控件的所有目录。pagecatalogpartpagecatalogpart类充当页目录来维护以前添加到某个用户已关闭的页的所有控件，以便该用户能够将这些控件重新添加到该页。仅当网页处于目录显示模式（一种特殊视图，使用户能够添加和移除页上的控件）时，此控件才可见。只有已关闭的控件才添加到页目录。如果希望向用户提供关闭和重新打开控件的灵活性，请将一个 pagecat

12、alogpart控件添加到页。注意 如果页面不允许用户关闭控件，则无需向该页添加 pagecatalogpart控件。 有关更多信息，请参见 asp.net web 部件页。关于已关闭的控件用户可以关闭 web 部件页上的控件。已关闭的控件具有下面的特性： 页上不可见。 不在页上呈现。 不参与页生命周期的各阶段。 关闭控件与删除控件不同，删除是将控件从页上永久移除。用户可以从页目录重新打开已关闭的控件实例，如果用户删除控件，则永远无法恢复该控件的实例。importcatalogpartimportcatalogpart web 服务器控件为一个 webpart 控件（或用作 webpart控件

13、的其他 asp.net 服务器控件）导入说明文件，以便可以按预先指定的设置由用户在运行时将该控件添加到网页中。该说明文件使用户可以共享 webpart控件的设置。说明文件与控件本身不同。它是以 .webpart 扩展名结尾的 xml 文件，并包含名称/值对（描述控件的状态）。说明文件使用特定的 xml 格式，如主题 web 部件控件说明文件中所述。除了描述控件的状态以外，说明文件还引用该控件名和包含该控件的程序集（或文件）。用户导入说明文件之后，在该文件中引用的 webpart控件出现在 importcatalogpart控件中，并且用户可以将该控件添加到页面上。将 web 部件控件与 imp

14、ortcatalogpart web 服务器控件关联与 importcatalogpart控件关联的 web 部件控件可以编译成程序集，也可以是一个用户控件（.ascx 文件）。在任一情况下，导入的说明文件中引用的控件都必须存在于包含宿主网页的 web 服务器上。用户使用 importcatalogpart控件将说明文件（及其关联的服务器控件）导入网页，您必须已经将此控件添加到页面中。当用户将页面切换到目录显示模式后，将出现 importcatalogpart控件，用户可以浏览到此控件的 .webpart 说明文件，然后导入此控件。控件的外观和属性在导入的说明文件中指定。在导入 webpart

15、控件的说明文件之前，用户必须首先基于现有的 webpart控件创建（导出）该文件。满足以下条件时，可以为一个控件导出说明文件： 该控件具有用 personalizable属性 (attribute) 标记的属性 (property)。 web.config 文件将 元素的 enableexport属性值设置为 true。 您已经将控件的 exportmode 属性值设置为默认值 none（该值禁止导出）以外的值。 启用 importcatalogpart web 服务器控件当 web 部件页处于编辑模式以及用户选择某一关联的 webpart控件进行编辑时，在运行时将显示 importcatal

16、ogpart web 服务器控件。有关更多信息，请参见演练：更改 web 部件页上的显示模式。editorzoneweb 部件的一项主要功能是使最终用户能够个性化网页并保存其个性化设置。修改 web 部件页的一个方面包括编辑可见 webpart 控件的外观、布局、行为和其他属性。web 部件控件集中有多个控件可提供编辑功能，其中包括 editorzone 控件，此控件是 web 部件控件集中用于承载网页上的 editorpart 控件的主控件。下表提供了可由 editorzone承载的 editorpart控件以及每个受承载控件的说明的列表。editorpart 控件 说明 appearanc

17、eeditorpart提供一个接口，通过此接口，用户可以在运行时自定义 webpart控件的视觉属性，例如宽度、高度和标题。有关更多信息，请参见 appearanceeditorpart web 服务器控件。behavioreditorpart提供一个接口，通过此接口，用户可以在运行时自定义 webpart控件的行为属性，例如显示最小化、关闭和编辑按钮。有关更多信息，请参见 behavioreditorpart web 服务器控件。layouteditorpart提供一个接口，通过此接口，用户可以在运行时自定义 webpart控件的布局属性，例如在最小化和正常状态之间进行选择，或设置控件出现在

18、目标区域中时所处的索引。有关更多信息，请参见 layouteditorpart web 服务器控件。propertygrideditorpart提供一个接口，通过此接口，用户可以在运行时编辑已声明为 webpart控件的一部分的自定义属性。有关更多信息，请参见 propertygrideditorpart web 服务器控件当用户将 web 部件页置于编辑模式时，editorzone控件将变为可见的。有关显示模式的详细信息，请参见演练：更改 web 部件页上的显示模式。editorzone web 服务器控件是一个区域控件。有关区域及如何在 web 部件应用程序中使用区域的更多信息，请参见演练

19、：创建 web 部件页、webzone 基类的参考文档以及 web 部件控件集概述。appearanceeditorpartappearanceeditorpart控件使最终用户能够编辑 webpart 控件的几个用户界面属性。下表列出了用户可自定义的功能，以及可使用 appearanceeditorpart控件编辑的对应的 webpart控件属性值。用户可自定义的功能 webpart 控件属性 为标题设置文本。title选择标题和边框选项类型。chrometype选择内容在页上的流动方向。direction设置高度和单位。height设置宽度和单位。width隐藏或显示控件已隐藏。hidde

20、n若要编辑 webpart控件的其他属性和行为，可使用 web 部件控件集所提供的其他 editorpart 控件。这些控件包括 behavioreditorpart、layouteditorpart 和 propertygrideditorpart 控件。内置 editorpart控件提供了 webpart控件的常用编辑功能。不过，您也可以通过从 editorpart类继承来创建自定义编辑器控件。有关代码示例，请参见 system.web.ui.webcontrols.webparts.editorpart。启用 appearanceeditorpart 控件appearanceeditor

21、part 控件仅在 web 部件页处于编辑模式且用户已选择关联的 webpart控件进行编辑时显示。behavioreditorpartbehavioreditorpart web 服务器控件是一个编辑器部件控件，最终用户可以使用该控件在运行时编辑关联的 webpart 控件上的数个用户界面 (ui) 属性。下表列出了用户可自定义的功能及可使用 behavioreditorpart控件编辑的对应 webpart控件属性值。用户可自定义的功能 webpart 控件属性 设置 web 部件的说明文本。 description设置标题链接。 titleurl设置标题图标图像链接。 titleicon

22、imageurl设置目录图标图像链接。 catalogiconimageurl设置帮助链接。 helpurl指定控件是否已隐藏。hidden指定帮助模式。 helpmode选择导出模式。 exportmode设置授权筛选器。 authorizationfilter指定是否可从页移除 web 部件。 allowclose指定 web 部件的属性是否可编辑。 allowedit指定 web 部件是否可隐藏。 allowhide指定 web 部件是否可最小化。 allowminimize指定 web 部件是可以在区域间移动的，还是只可以在其自己的区域中移动。 allowzonechange 启用 b

23、ehavioreditorpart web 服务器控件如果 web 部件页处于编辑模式且用户已选择关联的 webpart控件进行编辑，behavioreditorpart控件会在运行时显示。behavioreditorpart控件驻留在 editorzone 控件中。注意 editorzone区域只能包含 editorpart 控件。editorpart控件不能放在任何其他类型的区域中。 在以下情况下，behavioreditorpart控件不会在页上显示： 被编辑的 webpart控件的 isshared 属性值为 true. 页在用户个性化设置范围中（默认）。 对于要显示的 behavio

24、reditorpart控件，必须执行以下操作： 向 web.config 文件中添加一项，该项为授权用户提供了编辑共享的个性化设置范围内的网页的权限，这意味着用户所做的更改对所有其他用户都可见。有关启用 web 部件页的共享的个性化设置的更多信息，请参见如何：启用 web 部件页的共享个性化设置。 在运行时，以编程方式将页从用户级更改为共享级个性化设置范围。例如，可以通过调用 togglescope 方法来设置范围。 layouteditorpartlayouteditorpart控件使用户可以编辑相关联的 webpart 控件上的数个面向布局的用户界面 (ui) 属性。layoutedito

25、rpart 提供的编辑器用户界面下表列出了用户可自定义的功能，以及可使用 appearanceeditorpart 控件编辑的对应的 webpart控件属性值。用户可自定义的功能 webpart 控件属性 在 webpart控件的最小化状态和正常状态之间切换。chromestate设置当前包含 webpart控件的 webpartzonebase 区域。zone设置 webpart控件在其区域内的索引位置。zoneindex若要编辑 webpart控件的其他属性和行为，可使用 web 部件控件集所提供的其他 editorpart 控件。这些控件包括 behavioreditorpart、lay

26、outeditorpart和 propertygrideditorpart。内置 editorpart控件提供了编辑 webpart控件时最常用的功能。不过，您也可以通过从 editorpart类继承来创建自定义编辑器控件。有关代码示例，请参见 system.web.ui.webcontrols.webparts.editorpart。启用 layouteditorpart 控件layouteditorpart 控件仅在 web 部件页处于编辑模式且用户已选择了用于编辑的关联 webpart控件时显示。propertygrideditorpartpropertygrideditorpart提供

27、一个泛型用户界面 (ui)，用户可以通过该界面编辑 webpartzonebase 区域中的 webpart 控件和服务器控件上的自定义属性。propertygrideditorpart控件的使用户能够编辑自定义属性的功能使其不同于其他 editorpart 控件，例如 appearanceeditorpart 和 behavioreditorpart 控件，这些控件只能编辑 webpart类中现有的面向 ui 的属性。有关更多信息，请参见 asp.net web 部件页。通过 propertygrideditorpart 控件声明属性可自定义propertygrideditorpart 使用

28、户能够编辑源代码中用 webbrowsableattribute 进行标记的属性。当使用 webbrowsable属性 (attribute) 标记某一属性 (property) 时，propertygrideditorpart控件会基于该属性 (property) 的类型创建编辑 ui，并根据需要使用 propertydescriptor 对象以将每个编辑控件中的值转换为该属性 (property) 的类型。有关使用 webbrowsable属性 (attribute) 标记属性 (property) 的示例，请参见 propertygrideditorpart的示例部分。有关演示如何使用

29、propertygrideditorpart控件的示例，请参见 propertygrideditorpart web 服务器控件声明性语法和 system.web.ui.webcontrols.webparts.propertygrideditorpart。协助 propertygrideditorpart 控件编辑 ui 的属性在创建可自定义的属性 (property) 时，可以添加有助于 propertygrideditorpart控件显示编辑 ui 的属性 (attribute)。对 webdisplaynameattribute 进行设置，以便为每个控件指定在编辑 ui 中显示的文本。

30、将 webdescriptionattribute 设置为一个字符串，使该字符串在编辑 ui 中显示为每个控件的工具提示。connectionszone使用 web 部件控件，可以让用户创建两个服务器控件之间的运行时连接，以建立连接并共享数据，其中一个控件充当数据的提供者，另一个充当使用者。这两个控件可以是 webpart 控件或任何其他类型的服务器控件，条件是它们能够处理连接且位于 webpartzonebase 区域中。若要了解有关 web 部件连接的更多信息，请参见 webpartconnection 和 connectionpoint 类概述以及 web 部件连接概述。即使存在用于建立

31、 web 部件连接的控件和条件，仍需要连接控件。连接控件的方法有： 在网页中声明连接。 用代码创建连接。 将 connectionszone 控件添加到该页中，以便用户可以按需连接控件。 connectionszone控件生成 ui，以便用户能够连接任何合格控件或断开此类连接。该控件为可选控件，并非建立连接所必需，但您如果想赋予用户对连接哪些服务器控件或断开哪些服务器控件的连接的控制权，该控件就十分有用。通过 connectionszone 控件控制的 web 部件控件属性connectionszone 控件提供的用户界面能让用户设置与指定使用者控件和指定提供者控件相关的 connection

32、point对象。有关演示如何使用 connectionszone控件的代码示例，请参见 connectionszone类概述的“示例”部分。启用 connectionszone 控件作为工具区域，connectionszone控件仅在网页处于连接模式（页面上的 webpartmanager 控件的 displaymode 属性值设置为 connectdisplaymode）时可见。用户将页切换到连接模式后，必须单击其中一个服务器控件的连接谓词才能显示连接 ui。我们发现webparts有几个特点：1.网页上webpartzone块可以移动;2.网页上webpartzone块可以最小化或是隐藏;

33、3.网页上webpartzone块可以编辑.webparts的生命周期1.首先每个webpartzone都要向webpartmanager注册2.webpartmanager加载静态的webpart3. webpartmanager预订这些webpart的生命周期4. webpartmanager为每个webpart调用trackviewstate5. webpartmanager加载所有动态的webpart内容并且加载webpartconnection6. webpartmanager调用webpartpersonalization方法7. webpartmanager保存webpart的信

34、息实例：1. 首先必须先拖一个webpartmanager到页面2. 拖一个表格进来二行二列 3. 加一个webpartzone（id=“webpartzone1”）到表的左上单元格，自动套用格式“简单”，并在webpartzone中加一个panel。 4. 加一个webpartzone（id=“webpartzone3”）到表的右上单元格，自动套用格式“彩色”，并在webpartzone中加一个calendar。 注意一点，控件自动附加了一个属性title。原来的panel和calendar都没有title属性。如果没有装sql server 2005 express的同学有难了。webpa

35、rt是可以保存状态的，即如果你这个时候的布局是某个值（x），那么下次打开访问这个网站你的布局还是值（x）。没有装sql server 2005 express运行会有sql不能连接的问题，出错提示：在建立与服务器的连接时出错。在连接到 sql server 2005 时，在默认的设置下 sql server 不允许进行远程连接可能会导致此失败webpart的信息正是存储在app_data文件夹中，所以sql server 2005 express是必须的。app_data文件夹下有如下两个文件，看看自己的代码里有没有。5. 好了，这个时候可以运行了。不过虽然可以最大化，最小化，但这并不是我们要的结果。我们需要加上和 pagecatalogpart用来显示本页中被关闭的webpart部件或是自定义的webpart部件。6. 现在虽然不可以的使用pagecatalogpart，因为要让pagecatalogpart正常工