ToolZone 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
用作一组仅在某些相关页面显示模式中出现的帮助器区域的基类。
public ref class ToolZone abstract : System::Web::UI::WebControls::WebParts::WebZone, System::Web::UI::IPostBackEventHandler
public abstract class ToolZone : System.Web.UI.WebControls.WebParts.WebZone, System.Web.UI.IPostBackEventHandler
type ToolZone = class
inherit WebZone
interface IPostBackEventHandler
Public MustInherit Class ToolZone
Inherits WebZone
Implements IPostBackEventHandler
- 继承
- 派生
- 实现
注解
在 Web 部件控件集中,区域是网页上包含服务器控件的区域,并为包含的控件提供一致的用户界面 (UI) 的模块化布局。
有两种派生自基 WebZone 类的常规类型的区域控件: WebPartZoneBase 区域和 ToolZone 区域。 区域 WebPartZoneBase 包含服务器控件 (这些控件可以是自定义 WebPart 控件,也可以是其他服务器控件,包括 ASP.NET 控件和用户控件) 。 这些控件构成了网页的主 UI,并且在所有可能的显示模式下都可见,除非它们以编程方式或由用户隐藏。
区域 ToolZone 是特殊帮助程序区域,仅在页面处于与该区域关联的某些显示模式时显示,这些区域还包含特殊的服务器控件,使用户能够从浏览器内修改网页的布局、外观、属性和内容。 开发人员可以从基 ToolZone 类或任何派生 ToolZone 区域继承,以创建自定义区域。
Web 部件控件集包含三种类型的 ToolZone 区域,如下表所述。
工具区域类型 | 说明 |
---|---|
EditorZone | 包含用于编辑 WebPart 页面上的控件和服务器控件属性。 |
CatalogZone | 包含 CatalogPart 控件,而控件又包含 WebPart 用户可以添加到页面的控件。 |
ConnectionsZone | 不包含声明性标记元素;此区域是自包含的。 在运行时,它会呈现一个特殊的 UI,使用户能够管理控件之间的连接 WebPart 。 |
基 ToolZone 类提供对派生区域有用的方法和属性。 它包含 RenderHeader 和 RenderFooter 方法,这些方法替代 类中的基方法 WebZone ,以及区域页眉和页脚的呈现按钮和其他 UI 属性。 此外,还有几个用于处理谓词的成员,这些谓词是用户可以在各个区域中执行的常见 UI 操作。 与处理谓词相关的成员包括: RenderVerb、 RenderVerbs和 HeaderCloseVerb。
ToolZone包含两个重载的方法,这些方法将 对象添加到WebPartDisplayMode集合中AssociatedDisplayModes。 此关联的显示模式集合确定哪些显示模式与特定类型的区域 (相关,换言之,它确定区域) 可见的显示模式。 给定网页上所有区域的所有 ToolZone 关联显示模式的并集决定了除了正常浏览模式之外 (哪些显示模式) 在页面上可能或受支持。 页面支持的显示模式集合包含在 属性中 SupportedDisplayModes 。
注意
在任何给定时间,一个页面上只能有一种显示模式处于活动状态。 在 属性中引用当前处于活动状态的 DisplayMode 显示模式。
类 ToolZone 还包含许多样式属性,这些属性包含区域的各种 UI 元素的样式属性。 某些 ToolZone 样式属性包括 EditUIStyle、 HeaderVerbStyle、 InstructionTextStyle和 LabelStyle。
实施者说明
Web 部件控件集包含上面“备注”部分中列出的专用区域,通常可以从其中一个区域派生,以便向区域添加自定义行为。 但是,若要对区域呈现进行更编程的控制,应直接从 ToolZone 类继承。 例如,你可能希望为专用任务(如搜索区域)创建自定义区域。
若要创建自定义区域,可以重写任何虚拟 ToolZone 成员以完全自定义呈现,也可以仅替代特定成员。 (可选)还可以通过从 WebPartDisplayMode 类继承来为区域创建自定义显示模式,但这不是必需的。 在区域的构造函数中,应添加希望向 对象显示 WebPartDisplayModeCollection 区域的各种显示模式,以便在页面处于这些显示模式时,区域可见。
构造函数
ToolZone(ICollection) |
将 WebPartDisplayMode 对象的集合与特定的 ToolZone 区域关联,以使该区域在合适的页显示模式下能够显示出来。 |
ToolZone(WebPartDisplayMode) |
将单个 WebPartDisplayMode 对象与特定的 ToolZone 区域关联,以使该区域在合适的页显示模式下能够显示出来。 |
属性
AccessKey |
获取或设置使您得以快速导航到 Web 服务器控件的访问键。 (继承自 WebControl) |
Adapter |
获取控件的浏览器特定适配器。 (继承自 Control) |
AppRelativeTemplateSourceDirectory |
获取或设置包含该控件的 Page 或 UserControl 对象的应用程序相对虚拟目录。 (继承自 Control) |
AssociatedDisplayModes |
获取与特定 WebPartDisplayMode 区域关联的 ToolZone 对象的集合。 |
Attributes |
获取与控件的特性不对应的任意特性(只用于呈现)的集合。 (继承自 WebControl) |
BackColor |
获取或设置 Web 服务器控件的背景色。 (继承自 WebControl) |
BackImageUrl |
获取或设置指向区域的背景图像的 URL。 (继承自 WebZone) |
BindingContainer |
获取包含该控件的数据绑定的控件。 (继承自 Control) |
BorderColor |
获取或设置 Web 控件的边框颜色。 (继承自 WebControl) |
BorderStyle |
获取或设置 Web 服务器控件的边框样式。 (继承自 WebControl) |
BorderWidth |
获取或设置 Web 服务器控件的边框宽度。 (继承自 WebControl) |
ChildControlsCreated |
获取一个值,该值指示是否已创建服务器控件的子控件。 (继承自 Control) |
ClientID |
获取由 ASP.NET 生成的 HTML 标记的控件 ID。 (继承自 Control) |
ClientIDMode |
获取或设置用于生成 ClientID 属性值的算法。 (继承自 Control) |
ClientIDSeparator |
获取一个字符值,该值表示 ClientID 属性中使用的分隔符字符。 (继承自 Control) |
Context |
为当前 Web 请求获取与服务器控件关联的 HttpContext 对象。 (继承自 Control) |
Controls |
获取表示 ControlCollection 中的子控件的 CompositeControl 对象。 (继承自 CompositeControl) |
ControlStyle |
获取 Web 服务器控件的样式。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
ControlStyleCreated |
获取一个值,该值指示是否已为 Style 属性创建了 ControlStyle 对象。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
CssClass |
获取或设置由 Web 服务器控件在客户端呈现的级联样式表 (CSS) 类。 (继承自 WebControl) |
DataItemContainer |
如果命名容器实现 IDataItemContainer,则获取对命名容器的引用。 (继承自 Control) |
DataKeysContainer |
如果命名容器实现 IDataKeysControl,则获取对命名容器的引用。 (继承自 Control) |
DesignMode |
获取一个值,该值指示是否正在使用设计图面上的一个控件。 (继承自 Control) |
Display |
获取一个值,该值指示 ToolZone 控件当前是否正在显示。 |
EditUIStyle |
获取 ToolZone 控件中包含的可编辑控件的样式特性。 |
EmptyZoneText |
获取或设置当区域不包含任何控件时显示的消息。 (继承自 WebZone) |
EmptyZoneTextStyle |
获取空区域中的占位符文本的样式特性。 (继承自 WebZone) |
Enabled |
获取或设置一个值,该值指示是否启用 Web 服务器控件。 (继承自 WebControl) |
EnableTheming |
获取或设置一个值,该值指示主题是否应用于该控件。 (继承自 WebControl) |
EnableViewState |
获取或设置一个值,该值指示服务器控件是否向发出请求的客户端保持自己的视图状态以及它所包含的任何子控件的视图状态。 (继承自 Control) |
ErrorStyle |
获取用于呈现在无法加载或创建 WebPart 控件时显示的错误消息的样式特性。 (继承自 WebZone) |
Events |
获取控件的事件处理程序委托列表。 此属性为只读。 (继承自 Control) |
Font |
获取与 Web 服务器控件关联的字体属性。 (继承自 WebControl) |
FooterStyle |
获取区域的页脚区域内容的样式特性。 (继承自 WebZone) |
ForeColor |
获取或设置 Web 服务器控件的前景色(通常是文本颜色)。 (继承自 WebControl) |
HasAttributes |
获取一个值,该值指示控件是否具有特性集。 (继承自 WebControl) |
HasChildViewState |
获取一个值,该值指示当前服务器控件的子控件是否具有任何已保存的视图状态设置。 (继承自 Control) |
HasFooter |
获取一个值,该值指示区域中是否具有页脚区域。 (继承自 WebZone) |
HasHeader |
获取一个值,该值指示区域是否具有页眉区域。 (继承自 WebZone) |
HeaderCloseVerb |
获取对位于 WebPartVerb 控件的页眉中,用于关闭该控件的 ToolZone 对象的引用。 |
HeaderStyle |
获取区域的页眉区域内容的样式特性。 (继承自 WebZone) |
HeaderText |
获取或设置区域的页眉区的文本。 (继承自 WebZone) |
HeaderVerbStyle |
获取在 ToolZone 控件中显示的所有页眉谓词的样式特性。 |
Height |
获取或设置 Web 服务器控件的高度。 (继承自 WebControl) |
ID |
获取或设置分配给服务器控件的编程标识符。 (继承自 Control) |
IdSeparator |
获取用于分隔控件标识符的字符。 (继承自 Control) |
InstructionText |
获取或设置 ToolZone 控件中为最终用户提供说明的文本。 |
InstructionTextStyle |
获取在 ToolZone 控件的顶部显示的说明文本的样式特性。 |
IsChildControlStateCleared |
获取一个值,该值指示该控件中包含的控件是否具有控件状态。 (继承自 Control) |
IsEnabled |
获取一个值,该值指示是否启用控件。 (继承自 WebControl) |
IsTrackingViewState |
获取一个值,用于指示服务器控件是否会将更改保存到其视图状态中。 (继承自 Control) |
IsViewStateEnabled |
获取一个值,该值指示是否为该控件启用了视图状态。 (继承自 Control) |
LabelStyle |
获取在 ToolZone 控件中的编辑控件旁显示的标签内容的样式特性。 派生的 ToolZone 控件(如 CatalogZone 和 EditorZone)将这些样式应用于标签。 |
LoadViewStateByID |
获取一个值,该值指示控件是否通过 ID 而不是索引参与加载其视图状态。 (继承自 Control) |
NamingContainer |
获取对服务器控件的命名容器的引用,此引用创建唯一的命名空间,以区分具有相同 ID 属性值的服务器控件。 (继承自 Control) |
Padding |
获取或设置区域中包含 WebPart 控件的表的单元格填充特性。 (继承自 WebZone) |
Page |
获取对包含服务器控件的 Page 实例的引用。 (继承自 Control) |
Parent |
获取对页 UI 层次结构中服务器控件的父控件的引用。 (继承自 Control) |
PartChromePadding |
获取或设置 WebPart 控件的内容和此控件的边框之间的距离。 (继承自 WebZone) |
PartChromeStyle |
获取适用于区域所包含的 Web 部件控件的边框的样式属性。 (继承自 WebZone) |
PartChromeType |
获取或设置构成区域所包含的 Web 部件控件的框架的边框类型。 (继承自 WebZone) |
PartStyle |
获取适用于区域所包含的每个 Web 部件控件的边框和内容的样式属性。 (继承自 WebZone) |
PartTitleStyle |
获取区域所包含的每个 Web 部件控件的标题栏内容的样式特性。 (继承自 WebZone) |
RenderClientScript |
获取一个值,该值指示是否在 Web 部件页上呈现客户端脚本。 (继承自 WebZone) |
RenderingCompatibility |
获取一个值,该值指定呈现的 HTML 将与之兼容的 ASP.NET 版本。 (继承自 Control) |
Site |
获取容器信息,该容器在呈现于设计图面上时承载当前控件。 (继承自 Control) |
SkinID |
获取或设置要应用于控件的外观。 (继承自 WebControl) |
Style |
获取将在 Web 服务器控件的外部标记上呈现为样式特性的文本特性的集合。 (继承自 WebControl) |
SupportsDisabledAttribute |
获取一个值,该值指示在控件的 |
TabIndex |
获取或设置 Web 服务器控件的选项卡索引。 (继承自 WebControl) |
TagKey |
获取对应于此 Web 服务器控件的 HtmlTextWriterTag 值。 此属性主要由控件开发人员使用。 (继承自 WebZone) |
TagName |
获取控件标记的名称。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
TemplateControl |
获取或设置对包含该控件的模板的引用。 (继承自 Control) |
TemplateSourceDirectory |
获取包含当前服务器控件的 Page 或 UserControl 的虚拟目录。 (继承自 Control) |
ToolTip |
获取或设置当鼠标指针悬停在 Web 服务器控件上时显示的文本。 (继承自 WebControl) |
UniqueID |
获取服务器控件的唯一的、以分层形式限定的标识符。 (继承自 Control) |
ValidateRequestMode |
获取或设置指示控件是否检查来自浏览器的客户端输入是否具有潜在危险值的值。 (继承自 Control) |
VerbButtonType |
获取或设置区域中用于表示谓词的按钮的种类。 (继承自 WebZone) |
VerbStyle |
获取与区域中的 Web 部件控件关联的用户界面 (UI) 谓词的样式特性。 (继承自 WebZone) |
ViewState |
获取状态信息的字典,这些信息使您可以在同一页的多个请求间保存和还原服务器控件的视图状态。 (继承自 Control) |
ViewStateIgnoresCase |
获取一个值,该值指示 StateBag 对象是否不区分大小写。 (继承自 Control) |
ViewStateMode |
获取或设置此控件的视图状态模式。 (继承自 Control) |
Visible |
获取或设置一个值,该值指示服务器控件是否作为用户界面 (UI) 元素呈现在页上。 |
WebPartManager |
获取对与 Web 部件页上的 WebPartManager 控件实例关联的 WebZone 控件的引用。 (继承自 WebZone) |
Width |
获取或设置 Web 服务器控件的宽度。 (继承自 WebControl) |
方法
事件
DataBinding |
当服务器控件绑定到数据源时发生。 (继承自 Control) |
Disposed |
当从内存释放服务器控件时发生,这是请求 ASP.NET 页时服务器控件生存期的最后阶段。 (继承自 Control) |
Init |
当服务器控件初始化时发生;初始化是控件生存期的第一步。 (继承自 Control) |
Load |
当服务器控件加载到 Page 对象中时发生。 (继承自 Control) |
PreRender |
在加载 Control 对象之后、呈现之前发生。 (继承自 Control) |
Unload |
当服务器控件从内存中卸载时发生。 (继承自 Control) |
显式接口实现
扩展方法
FindDataSourceControl(Control) |
返回与指定控件的数据控件关联的数据源。 |
FindFieldTemplate(Control, String) |
返回指定控件的命名容器中指定列的字段模板。 |
FindMetaTable(Control) |
返回包含数据控件的元表对象。 |
GetDefaultValues(INamingContainer) |
为指定数据控件获取默认值的集合。 |
GetMetaTable(INamingContainer) |
为指定数据控件获取表元数据。 |
SetMetaTable(INamingContainer, MetaTable) |
为指定数据控件设置表元数据。 |
SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) |
为指定数据控件设置表元数据和默认值映射。 |
SetMetaTable(INamingContainer, MetaTable, Object) |
为指定数据控件设置表元数据和默认值映射。 |
TryGetMetaTable(INamingContainer, MetaTable) |
确定表元数据是否可用。 |
EnableDynamicData(INamingContainer, Type) |
为指定数据控件启用动态数据行为。 |
EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) |
为指定数据控件启用动态数据行为。 |
EnableDynamicData(INamingContainer, Type, Object) |
为指定数据控件启用动态数据行为。 |