XmlDataSource 类

定义

表示数据绑定控件的 XML 数据源。Represents an XML data source to data-bound controls.

public ref class XmlDataSource : System::Web::UI::HierarchicalDataSourceControl, System::ComponentModel::IListSource, System::Web::UI::IDataSource
[System.Drawing.ToolboxBitmap(typeof(System.Web.UI.WebControls.XmlDataSource))]
public class XmlDataSource : System.Web.UI.HierarchicalDataSourceControl, System.ComponentModel.IListSource, System.Web.UI.IDataSource
type XmlDataSource = class
    inherit HierarchicalDataSourceControl
    interface IDataSource
    interface IListSource
Public Class XmlDataSource
Inherits HierarchicalDataSourceControl
Implements IDataSource, IListSource
继承
属性
实现

示例

本部分包含两个代码示例。This section contains two code examples. 第一个代码示例演示如何将XmlDataSource控件TreeView与控件结合使用来显示示例 xml 文件中的 xml 数据。The first code example demonstrates how to use an XmlDataSource control with a TreeView control to display XML data from the sample XML file. 第二个示例演示如何将XmlDataSource控件与模板化Repeater控件结合使用来显示 XML 数据。The second example demonstrates how to use an XmlDataSource control with a templated Repeater control to display XML data.

下面的代码示例演示如何将XmlDataSource控件TreeView与控件结合使用来显示 XML 数据。The following code example demonstrates how to use an XmlDataSource control with a TreeView control to display XML data. 从由属性标识的 xml 文件加载xml数据。XmlDataSource DataFileThe XmlDataSource loads XML data from the XML file identified by the DataFile property.

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:xmldatasource
        id="XmlDataSource1"
        runat="server"
        datafile="books.xml" />

      <!- TreeView uses hierachical data, so the
          XmlDataSource uses an XmlHierarchicalDataSourceView
          when a TreeView is bound to it. -->

      <asp:TreeView
        id="TreeView1"
        runat="server"
        datasourceid="XmlDataSource1">
        <databindings>
          <asp:treenodebinding datamember="book" textfield="title"/>
        </databindings>
      </asp:TreeView>

    </form>
  </body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:xmldatasource
        id="XmlDataSource1"
        runat="server"
        datafile="books.xml" />

      <!- TreeView uses hierachical data, so the
          XmlDataSource uses an XmlHierarchicalDataSourceView
          when a TreeView is bound to it. -->

      <asp:TreeView
        id="TreeView1"
        runat="server"
        datasourceid="XmlDataSource1">
        <databindings>
          <asp:treenodebinding datamember="book" textfield="title"/>
        </databindings>
      </asp:TreeView>

    </form>
  </body>
</html>

此代码示例中的 XML 文件包含以下数据:The XML file in the code example has the following data:

<books>  
   <computerbooks>  
     <book title="Secrets of Silicon Valley" author="Sheryl Hunter"/>  
     <book title="Straight Talk About Computers" author="Dean Straight"/>  
     <book title="You Can Combat Computer Stress!" author="Marjorie Green"/>                  
   </computerbooks>  
   <cookbooks>  
     <book title="Silicon Valley Gastronomic Treats" author="Innes del Castill"/>  
   </cookbooks>  
</books>  

下面的代码示例演示如何将XmlDataSource控件与模板化Repeater控件结合使用来显示 XML 数据。The following code example demonstrates how to use an XmlDataSource control with a templated Repeater control to display XML data. 控件使用 XPath 数据绑定表达式绑定到所XmlDataSource表示的 XML 文档中的数据项。 RepeaterThe Repeater control uses an XPath data-binding expression to bind to data items within the XML document that the XmlDataSource represents. 有关XPathXPathSelect数据绑定语法的详细信息,请参阅类。XPathBinderFor more information about XPath and XPathSelect data-binding syntax, see the XPathBinder class.

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>Order</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:XmlDataSource
        runat="server"
        id="XmlDataSource1"
        XPath="orders/order"
        DataFile="order.xml" />

      <asp:Repeater ID="Repeater1"
        runat="server"
        DataSourceID="XmlDataSource1">
        <ItemTemplate>
            <h2>Order</h2>
            <table>
              <tr>
                <td>Customer</td>
                <td><%#XPath("customer/@id")%></td>
                <td><%#XPath("customername/firstn")%></td>
                <td><%#XPath("customername/lastn")%></td>
              </tr>
              <tr>
                <td>Ship To</td>
                <td><%#XPath("shipaddress/address1")%></font></td>
                <td><%#XPath("shipaddress/city")%></td>
                <td><%#XPath("shipaddress/state")%>,
                    <%#XPath("shipaddress/zip")%></td>
              </tr>
            </table>
            <h3>Order Summary</h3>
            <asp:Repeater ID="Repeater2"
                 DataSource='<%#XPathSelect("summary/item")%>'
                 runat="server">
                <ItemTemplate>
                     <b><%#XPath("@dept")%></b> -
                         <%#XPath(".")%><br />
                </ItemTemplate>
            </asp:Repeater>
            <hr />
        </ItemTemplate>
    </asp:Repeater>

  </form>
  </body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>Order</title>
</head>
<body> 
    <form id="form1" runat="server">
      <asp:XmlDataSource
        runat="server"
        id="XmlDataSource1"
        XPath="orders/order"
        DataFile="order.xml" />

      <asp:Repeater ID="Repeater1"
        runat="server"
        DataSourceID="XmlDataSource1">
        <ItemTemplate>
            <h2>Order</h2>
            <table>
              <tr>
                <td>Customer</td>
                <td><%#XPath("customer/@id")%></td>
                <td><%#XPath("customername/firstn")%></td>
                <td><%#XPath("customername/lastn")%></td>
              </tr>
              <tr>
                <td>Ship To</td>
                <td><%#XPath("shipaddress/address1")%></font></td>
                <td><%#XPath("shipaddress/city")%></td>
                <td><%#XPath("shipaddress/state")%>,
                    <%#XPath("shipaddress/zip")%></td>
              </tr>
            </table>
            <h3>Order Summary</h3>
            <asp:Repeater ID="Repeater2"
                 DataSource='<%#XPathSelect("summary/item")%>'
                 runat="server">
                <ItemTemplate>
                     <b><%#XPath("@dept")%></b> -
                         <%#XPath(".")%><br />
                </ItemTemplate>
            </asp:Repeater>
            <hr />
        </ItemTemplate>
    </asp:Repeater>

  </form>
  </body>
</html>

此代码示例中的 XML 文件包含以下数据:The XML file in the code example has the following data:

<?xml version="1.0" encoding="iso-8859-1"?>  
 <orders>  
   <order>  
     <customer id="12345" />  
     <customername>  
         <firstn>John</firstn>  
         <lastn>Smith</lastn>  
     </customername>  
     <transaction id="12345" />  
     <shipaddress>  
         <address1>1234 Tenth Avenue</address1>  
         <city>Bellevue</city>  
         <state>Washington</state>  
         <zip>98001</zip>  
     </shipaddress>  
     <summary>  
         <item dept="tools">screwdriver</item>  
         <item dept="tools">hammer</item>  
         <item dept="plumbing">fixture</item>  
     </summary>  
   </order>  
</orders>  

注解

本主题内容:In this topic:

介绍Introduction

XmlDataSource控件是向数据绑定控件呈现 XML 数据的数据源控件。The XmlDataSource control is a data source control that presents XML data to data-bound controls. 数据XmlDataSource绑定控件可以使用该控件显示层次结构数据和表格数据。The XmlDataSource control can be used by data-bound controls to display both hierarchical and tabular data. XmlDataSource控件通常用于在只读方案中显示分层的 XML 数据。The XmlDataSource control is typically used to display hierarchical XML data in read-only scenarios. 由于控件扩展了HierarchicalDataSourceControl类, 因此它适用于分层数据。 XmlDataSourceBecause the XmlDataSource control extends the HierarchicalDataSourceControl class, it works with hierarchical data. XmlDataSource控件还实现了IDataSource接口, 并与表格或列表样式的数据一起使用。The XmlDataSource control also implements the IDataSource interface and works with tabular, or list-style, data.

备注

出于安全目的, 不会将XmlDataSource任何控件属性都存储在视图状态中。For security purposes, none of the XmlDataSource control properties are stored in view state. 由于在技术上可能会对客户端上的视图状态的内容进行解码, 因此, 存储有关数据结构或其内容的敏感信息可能会向您显示信息泄露威胁。Since it is technically possible to decode the contents of view state on the client, storing sensitive information about the data structure or its contents could expose you to an information disclosure threat. 请注意, 如果需要将XPath属性等信息存储在视图状态中, 则可以通过在@ Page指令上设置ViewStateEncryptionMode来启用加密来保护内容。Note that if you need to store information such as XPath property in view state, you can enable encryption to protect the contents by setting ViewStateEncryptionMode on the @ Page directive.

页面开发人员使用XmlDataSource控件来显示使用数据绑定控件的 XML 数据。Page developers use the XmlDataSource control to display XML data using data-bound controls.

XML 数据源Sources of XML Data

通常会加载 xml 文件中的 xml 数据, 该文件DataFile由属性指定。 XmlDataSourceThe XmlDataSource typically loads XML data from an XML file, which is specified by the DataFile property. 还可以使用Data属性, 以字符串形式直接将 XML 数据存储在字符串形式中。XML data can also be stored directly by the data source control in string form using the Data property. 如果要在数据绑定控件显示 XML 数据之前对其进行转换, 则可以为转换提供可扩展样式表语言 (XSL) 样式表。If you want to transform the XML data before it is displayed by a data-bound control, you can provide an Extensible Stylesheet Language (XSL) style sheet for the transformation. 对于 XML 数据, 通常从文件加载样式表, 由TransformFile属性指示, 但也可以Transform使用属性直接将它存储在字符串形式中。As with the XML data, you typically load the style sheet from a file, indicated by the TransformFile property, but you can also store it in string form directly using the Transform property.

更新 XML 数据Updating XML Data

XmlDataSource控件通常用于只读数据方案, 其中的数据绑定控件显示 XML 数据。The XmlDataSource control is commonly used in read-only data scenarios where a data-bound control displays XML data. 但是, 也可以使用XmlDataSource控件编辑 XML 数据。However, you can also use the XmlDataSource control to edit XML data. 若要编辑 xml 数据, 请调用GetXmlDocument方法来XmlDataDocument检索对象, 该对象是 XML 数据的内存中表示形式。To edit the XML data, call the GetXmlDocument method to retrieve an XmlDataDocument object that is an in-memory representation of the XML data. 您可以使用由和它所包含的XmlDataDocument对象XmlNode公开的对象模型, 也可以使用 XPath 筛选表达式来操作文档中的数据。You can use the object model exposed by the XmlDataDocument and XmlNode objects it contains or use an XPath filtering expression to manipulate data in the document. 更改 XML 数据的内存中表示形式后, 可以通过调用Save方法将其保存到磁盘。When you have made changes to the in-memory representation of the XML data, you can save it to disk by calling the Save method.

XmlDataSource控件的编辑功能有一些限制:There are some restrictions to the editing capabilities of the XmlDataSource control:

  • 必须从DataFile属性所指示的 xml 文件 (而不是在Data属性中指定的内联 xml) 加载 xml 数据。The XML data must be loaded from an XML file that is indicated by the DataFile property, not from inline XML specified in the Data property.

  • 不能在TransformTransformFile属性中指定 XSLT 转换。No XSLT transformation can be specified in the Transform or TransformFile properties.

  • Save方法不会按不同的请求处理并发保存操作。The Save method does not handle concurrent save operations by different requests. 如果有多个用户通过XmlDataSource编辑 XML 文件, 则不能保证所有用户都使用相同的数据。If more than one user is editing an XML file through the XmlDataSource, there is no guarantee that all users are operating with the same data. 由于这些并发性问题, Save操作也可能会失败。It is also possible for a Save operation to fail due to these same concurrency issues.

指定 XSL 转换Specifying an XSL Transformation

使用 XML 数据执行的常见操作是将其从一个 XML 数据集转换为另一个。A common operation performed with XML data is transforming it from one XML data set into another. 控件支持具有和Transform TransformFile属性的 XML 转换, 这些属性指定将在将 XML 数据传递到数据绑定控件之前应用于 xml 数据的 XSL 样式表, 以及TransformArgumentList属性, 使你能够XmlDataSource在转换过程中提供 XSL 样式表使用的动态 XSLT 样式表参数。The XmlDataSource control supports XML transformations with the Transform and TransformFile properties, which specify an XSL style sheet to apply to XML data before it is passed to a data-bound control, and the TransformArgumentList property, which enables you to supply dynamic XSLT style sheet arguments to be used by an XSL style sheet during the transformation. 如果使用XPath属性指定 XPath 筛选表达式, 则在进行转换之后应用。If you specify an XPath filtering expression using the XPath property, it is applied after the transformation takes place.

备注

类使用不推荐XslTransform使用的类来执行 XSL 转换。 XmlDataSourceThe XmlDataSource class uses the deprecated XslTransform class to perform XSL transformations. 如果要使用在XslTransform类不推荐使用后引入的样式表功能, 请XslCompiledTransform使用类手动应用转换。If you want to use style sheet features that were introduced after the XslTransform class was deprecated, apply the transforms manually by using the XslCompiledTransform class.

使用 XPath 表达式进行筛选Filtering using an XPath Expression

默认情况下, XmlDataSource控件加载DataFile由属性标识的 xml 文件中的所有 xml 数据, Data或在属性中找到内联, 但你可以使用 XPath 表达式来筛选数据。By default, the XmlDataSource control loads all the XML data in the XML file identified by the DataFile property or found inline in the Data property, but you can filter the data using an XPath expression. XPath属性支持 XPath 语法筛选器, 该筛选器在加载和转换 XML 数据后应用。The XPath property supports an XPath-syntax filter that is applied after XML data is loaded and transformed.

缓存Caching

出于性能方面的考虑, 默认情况下XmlDataSource为控件启用了缓存。For performance purposes, caching is enabled for the XmlDataSource control by default. 每次请求页面时在服务器上打开和读取 XML 文件都可以降低应用程序的性能。Opening and reading an XML file on the server every time a page requested can reduce the performance of your application. 通过缓存, 可以在 Web 服务器上的内存开销内降低服务器上的处理负载;在大多数情况下, 这是一个很好的权衡。Caching lets you reduce the processing load on your server at the expense of memory on the Web server; in most cases this is a good trade-off. 当属性设置为XmlDataSource true时, 将自动缓存数据, 并将属性设置为缓存在缓存失效之前存储数据的秒数。CacheDuration EnableCachingThe XmlDataSource automatically caches data when the EnableCaching property is set to true, and the CacheDuration property is set to the number of seconds that the cache stores data before the cache is invalidated. 您可以使用CacheExpirationPolicy进一步微调数据源控件的缓存行为。You can use the CacheExpirationPolicy to further fine-tune the caching behavior of the data source control.

其他功能Additional Features

下表列出了XmlDataSource控件支持的其他功能。The following table lists additional features that are supported by the XmlDataSource control.

功能Capability 说明Description
排序Sorting XmlDataSource控件不支持。Not supported by the XmlDataSource control.
筛选Filtering XPath属性可用于使用适当的 XPath 表达式筛选 XML 数据。The XPath property can be used to filter the XML data using an appropriate XPath expression.
分页Paging XmlDataSource控件不支持。Not supported by the XmlDataSource control.
UpdatingUpdating 通过XmlDataDocument直接操作, 然后Save调用方法来支持。Supported by manipulating the XmlDataDocument directly and then calling the Save method.
正在删除Deleting 通过XmlDataDocument直接操作, 然后Save调用方法来支持。Supported by manipulating the XmlDataDocument directly and then calling the Save method.
插入Inserting 通过XmlDataDocument直接操作, 然后Save调用方法来支持。Supported by manipulating the XmlDataDocument directly and then calling the Save method.
缓存Caching 默认情况下启用, CacheDuration属性设置为 0 (无限) CacheExpirationPolicy , 属性设置为AbsoluteEnabled by default, with the CacheDuration property set to 0 (infinite) and the CacheExpirationPolicy property set to Absolute.

数据视图对象Data View Object

XmlDataSource由于控件支持显示层次结构数据的数据绑定控件以及显示表格数据的控件, 数据源控件支持其基础 XML 数据的多种类型的数据源视图对象。Because the XmlDataSource control supports data-bound controls that display hierarchical data as well as controls that display tabular data, the data source control supports multiple types of data source view objects on its underlying XML data. 控件XmlDataSource在与显示表格数据XmlDataSourceView的数据绑定控件一起使用时, 将检索单个命名对象。The XmlDataSource control retrieves a single named XmlDataSourceView object when used with a data-bound control that displays tabular data. GetViewNames方法标识此单个命名视图。The GetViewNames method identifies this single named view. 当用于显示分层数据的数据绑定控件时, XmlDataSource控件将XmlHierarchicalDataSourceView为传递给GetHierarchicalView方法的任何唯一分层路径检索。When used with a data-bound control that displays hierarchical data, the XmlDataSource control retrieves an XmlHierarchicalDataSourceView for any unique hierarchical path passed to the GetHierarchicalView method.

声明性语法Declarative Syntax

<asp:XmlDataSource  
    CacheDuration="string|Infinite"  
    CacheExpirationPolicy="Absolute|Sliding"  
    CacheKeyDependency="string"  
    DataFile="string"  
    EnableCaching="True|False"  
    EnableTheming="True|False"  
    EnableViewState="True|False"  
    ID="string"  
    OnDataBinding="DataBinding event handler"  
    OnDisposed="Disposed event handler"  
    OnInit="Init event handler"  
    OnLoad="Load event handler"  
    OnPreRender="PreRender event handler"  
    OnTransforming="Transforming event handler"  
    OnUnload="Unload event handler"  
    runat="server"  
    SkinID="string"  
    TransformArgumentList="string"  
    TransformFile="string"  
    Visible="True|False"  
    XPath="string"  
>  
    <Data>string</Data>  
    <Transform>string</Transform>  
</asp:XmlDataSource>  

构造函数

XmlDataSource()

创建 XmlDataSource 类的新实例。Creates a new instance of the XmlDataSource class.

属性

Adapter

获取控件的浏览器特定适配器。Gets the browser-specific adapter for the control.

(继承自 Control)
AppRelativeTemplateSourceDirectory

获取或设置包含该控件的 PageUserControl 对象的应用程序相对虚拟目录。Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

(继承自 Control)
BindingContainer

获取包含该控件的数据绑定的控件。Gets the control that contains this control's data binding.

(继承自 Control)
CacheDuration

获取或设置数据源控件检索到的数据的缓存时间长度(以秒为单位)。Gets or sets the length of time, in seconds, that the data source control caches data it has retrieved.

CacheExpirationPolicy

获取或设置缓存过期策略,当它与缓存持续时间组合使用时,可以描述数据源控件所使用的缓存的缓存行为。Gets or sets the cache expiration policy that is combined with the cache duration to describe the caching behavior of the cache that the data source control uses.

CacheKeyContext

从视图状态获取或设置数据源控件的缓存键的值,或向视图状态添加缓存键。Gets or sets the value of the cache key for the data source control from view state, or adds the cache key to view state.

CacheKeyDependency

获取或设置用户定义的键依赖项,该依赖项链接到数据源控件创建的所有数据缓存对象。Gets or sets a user-defined key dependency that is linked to all data cache objects created by the data source control. 密钥过期后,所有的缓存对象都会显式过期。All cache objects explicitly expire when the key expires.

ChildControlsCreated

获取一个值,该值指示是否已创建服务器控件的子控件。Gets a value that indicates whether the server control's child controls have been created.

(继承自 Control)
ClientID

获取由 ASP.NET 生成的服务器控件标识符。Gets the server control identifier generated by ASP.NET.

(继承自 HierarchicalDataSourceControl)
ClientIDMode

此属性不用于数据源控件。This property is not used for data source controls.

(继承自 HierarchicalDataSourceControl)
ClientIDSeparator

获取一个字符值,该值表示 ClientID 属性中使用的分隔符字符。Gets a character value representing the separator character used in the ClientID property.

(继承自 Control)
Context

为当前 Web 请求获取与服务器控件关联的 HttpContext 对象。Gets the HttpContext object associated with the server control for the current Web request.

(继承自 Control)
Controls

获取 ControlCollection 对象,该对象表示 UI 层次结构中的指定服务器控件的子控件。Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

(继承自 HierarchicalDataSourceControl)
Data

获取或设置数据源控件绑定到的 XML 数据块。Gets or sets a block of XML data that the data source control binds to.

DataFile

指定绑定数据源的 XML 文件的文件名。Specifies the file name of an XML file that the data source binds to.

DataItemContainer

如果命名容器实现 IDataItemContainer,则获取对命名容器的引用。Gets a reference to the naming container if the naming container implements IDataItemContainer.

(继承自 Control)
DataKeysContainer

如果命名容器实现 IDataKeysControl,则获取对命名容器的引用。Gets a reference to the naming container if the naming container implements IDataKeysControl.

(继承自 Control)
DesignMode

获取一个值,该值指示是否正在使用设计图面上的一个控件。Gets a value indicating whether a control is being used on a design surface.

(继承自 Control)
EnableCaching

获取或设置一个值,该值指示 XmlDataSource 控件是否启用数据缓存。Gets or sets a value indicating whether the XmlDataSource control has data caching enabled.

EnableTheming

获取一个值,该值指示此控件是否支持主题。Gets a value indicating whether this control supports themes.

(继承自 HierarchicalDataSourceControl)
EnableViewState

获取或设置一个值,该值指示服务器控件是否向发出请求的客户端保持自己的视图状态以及它所包含的任何子控件的视图状态。Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.

(继承自 Control)
Events

获取控件的事件处理程序委托列表。Gets a list of event handler delegates for the control. 此属性为只读。This property is read-only.

(继承自 Control)
HasChildViewState

获取一个值,该值指示当前服务器控件的子控件是否具有任何已保存的视图状态设置。Gets a value indicating whether the current server control's child controls have any saved view-state settings.

(继承自 Control)
ID

获取或设置分配给服务器控件的编程标识符。Gets or sets the programmatic identifier assigned to the server control.

(继承自 Control)
IdSeparator

获取用于分隔控件标识符的字符。Gets the character used to separate control identifiers.

(继承自 Control)
IsChildControlStateCleared

获取一个值,该值指示该控件中包含的控件是否具有控件状态。Gets a value indicating whether controls contained within this control have control state.

(继承自 Control)
IsTrackingViewState

获取一个值,用于指示服务器控件是否会将更改保存到其视图状态中。Gets a value that indicates whether the server control is saving changes to its view state.

(继承自 Control)
IsViewStateEnabled

获取一个值,该值指示是否为该控件启用了视图状态。Gets a value indicating whether view state is enabled for this control.

(继承自 Control)
LoadViewStateByID

获取一个值,该值指示控件是否通过 ID 而不是索引参与加载其视图状态。Gets a value indicating whether the control participates in loading its view state by ID instead of index.

(继承自 Control)
NamingContainer

获取对服务器控件的命名容器的引用,此引用创建唯一的命名空间,以区分具有相同 ID 属性值的服务器控件。Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.

(继承自 Control)
Page

获取对包含服务器控件的 Page 实例的引用。Gets a reference to the Page instance that contains the server control.

(继承自 Control)
Parent

获取对页 UI 层次结构中服务器控件的父控件的引用。Gets a reference to the server control's parent control in the page control hierarchy.

(继承自 Control)
RenderingCompatibility

获取一个值,该值指定呈现的 HTML 将与之兼容的 ASP.NET 版本。Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

(继承自 Control)
Site

获取容器信息,该容器在呈现于设计图面上时承载当前控件。Gets information about the container that hosts the current control when rendered on a design surface.

(继承自 Control)
SkinID

获取或设置应用于 HierarchicalDataSourceControl 控件的外观。Gets or sets the skin to apply to the HierarchicalDataSourceControl control.

(继承自 HierarchicalDataSourceControl)
TemplateControl

获取或设置对包含该控件的模板的引用。Gets or sets a reference to the template that contains this control.

(继承自 Control)
TemplateSourceDirectory

获取包含当前服务器控件的 PageUserControl 的虚拟目录。Gets the virtual directory of the Page or UserControl that contains the current server control.

(继承自 Control)
Transform

获取或设置可扩展样式表语言 (XSL) 数据块,该数据块定义要对 XmlDataSource 控件管理的 XML 数据执行的 XSLT 转换。Gets or sets a block of Extensible Stylesheet Language (XSL) data that defines an XSLT transformation to be performed on the XML data managed by the XmlDataSource control.

TransformArgumentList

提供在 TransformTransformFile 属性定义的样式表中使用(用来对 XML 数据执行转换)的 XSLT 参数的列表。Provides a list of XSLT arguments that are used with the style sheet defined by the Transform or TransformFile properties to perform a transformation on the XML data.

TransformFile

指定可扩展样式表语言 (XSL) 文件 (.xsl) 的文件名,该文件定义要对 XmlDataSource 控件管理的 XML 数据执行的 XSLT 转换。Specifies the file name of an Extensible Stylesheet Language (XSL) file (.xsl) that defines an XSLT transformation to be performed on the XML data managed by the XmlDataSource control.

UniqueID

获取服务器控件的唯一的、以分层形式限定的标识符。Gets the unique, hierarchically qualified identifier for the server control.

(继承自 Control)
ValidateRequestMode

获取或设置指示控件是否检查来自浏览器的客户端输入是否具有潜在危险值的值。Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.

(继承自 Control)
ViewState

获取状态信息的字典,这些信息使您可以在同一页的多个请求间保存和还原服务器控件的视图状态。Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

(继承自 Control)
ViewStateIgnoresCase

获取一个值,该值指示 StateBag 对象是否不区分大小写。Gets a value that indicates whether the StateBag object is case-insensitive.

(继承自 Control)
ViewStateMode

获取或设置此控件的视图状态模式。Gets or sets the view-state mode of this control.

(继承自 Control)
Visible

获取或设置一个值,该值指示是否以可视化方式显示控件。Gets or sets a value indicating whether the control is visually displayed.

(继承自 HierarchicalDataSourceControl)
XPath

指定 XPath 表达式,该表达式将应用于 Data 属性所包含的 XML 数据或 DataFile 属性指示的 XML 文件所包含的 XML 数据。Specifies an XPath expression to be applied to the XML data contained by the Data property or by the XML file indicated by the DataFile property.

方法

AddedControl(Control, Int32)

在子控件添加到 Controls 对象的 Control 集合后调用。Called after a child control is added to the Controls collection of the Control object.

(继承自 Control)
AddParsedSubObject(Object)

通知服务器控件,分析了一个元素(XML 或 HTML),并将该元素添加到服务器控件的 ControlCollection 对象中。Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

(继承自 Control)
ApplyStyleSheetSkin(Page)

将页样式表中定义的样式属性应用于控件。Applies the style properties that are defined in the page style sheet to the control.

(继承自 HierarchicalDataSourceControl)
BeginRenderTracing(TextWriter, Object)

开始输出数据的设计时追踪。Begins design-time tracing of rendering data.

(继承自 Control)
BuildProfileTree(String, Boolean)

收集有关服务器控件的信息并将该信息发送到 Trace 属性,在启用页的跟踪功能时将显示该属性。Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.

(继承自 Control)
ClearCachedClientID()

将缓存的 ClientID 值设置为 nullSets the cached ClientID value to null.

(继承自 Control)
ClearChildControlState()

删除服务器控件的子控件的控件状态信息。Deletes the control-state information for the server control's child controls.

(继承自 Control)
ClearChildState()

删除服务器控件的所有子控件的视图状态和控件状态信息。Deletes the view-state and control-state information for all the server control's child controls.

(继承自 Control)
ClearChildViewState()

删除服务器控件的所有子控件的视图状态信息。Deletes the view-state information for all the server control's child controls.

(继承自 Control)
ClearEffectiveClientIDMode()

将当前控件实例和任何子控件的 ClientIDMode 属性设置为 InheritSets the ClientIDMode property of the current control instance and of any child controls to Inherit.

(继承自 Control)
CreateChildControls()

由 ASP.NET 页框架调用,以通知服务器控件在准备回发或呈现时使用基于撰写的实现来创建其所包含任何子控件。Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.

(继承自 Control)
CreateControlCollection()

创建一个新 ControlCollection 对象来保存服务器控件的子控件(包括文本控件和服务器控件)。Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

(继承自 HierarchicalDataSourceControl)
DataBind()

将数据源绑定到调用的服务器控件及其所有子控件。Binds a data source to the invoked server control and all its child controls.

(继承自 Control)
DataBind(Boolean)

将数据源绑定到调用的服务器控件及其所有子控件,同时可以选择引发 DataBinding 事件。Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.

(继承自 Control)
DataBindChildren()

将数据源绑定到服务器控件的子控件。Binds a data source to the server control's child controls.

(继承自 Control)
Dispose()

使服务器控件得以在从内存中释放之前执行最后的清理操作。Enables a server control to perform final clean up before it is released from memory.

(继承自 Control)
EndRenderTracing(TextWriter, Object)

结束输出数据的设计时追踪。Ends design-time tracing of rendering data.

(继承自 Control)
EnsureChildControls()

确定服务器控件是否包含子控件。Determines whether the server control contains child controls. 如果不包含,则创建子控件。If it does not, it creates child controls.

(继承自 Control)
EnsureID()

为尚未分配标识符的控件创建标识符。Creates an identifier for controls that do not have an identifier assigned.

(继承自 Control)
Equals(Object)

确定指定对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(继承自 Object)
FindControl(String)

在当前的命名容器中搜索带指定 id 参数的服务器控件。Searches the current naming container for a server control with the specified id parameter.

(继承自 HierarchicalDataSourceControl)
FindControl(String, Int32)

使用指定的 idpathOffset 参数(该参数有助于搜索)中指定的整数在当前命名容器中搜索服务器控件。Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. 不应重写此版本的 FindControl 方法。You should not override this version of the FindControl method.

(继承自 Control)
Focus()

为控件设置输入焦点。Sets input focus to the control.

(继承自 HierarchicalDataSourceControl)
GetDesignModeState()

获取控件的设计时数据。Gets design-time data for a control.

(继承自 Control)
GetHashCode()

用作默认哈希函数。Serves as the default hash function.

(继承自 Object)
GetHierarchicalView(String)

获取 XmlDataSource 控件的数据源视图对象。Gets the data source view object for the XmlDataSource control. viewPath 参数可以是 XPath 表达式。The viewPath parameter can be an XPath expression.

GetRouteUrl(Object)

获取与一组路由参数对应的 URL。Gets the URL that corresponds to a set of route parameters.

(继承自 Control)
GetRouteUrl(RouteValueDictionary)

获取与一组路由参数对应的 URL。Gets the URL that corresponds to a set of route parameters.

(继承自 Control)
GetRouteUrl(String, Object)

获取与一组路由参数以及某个路由名称对应的 URL。Gets the URL that corresponds to a set of route parameters and a route name.

(继承自 Control)
GetRouteUrl(String, RouteValueDictionary)

获取与一组路由参数以及某个路由名称对应的 URL。Gets the URL that corresponds to a set of route parameters and a route name.

(继承自 Control)
GetType()

获取当前实例的 TypeGets the Type of the current instance.

(继承自 Object)
GetUniqueIDRelativeTo(Control)

返回指定控件的 UniqueID 属性的前缀部分。Returns the prefixed portion of the UniqueID property of the specified control.

(继承自 Control)
GetXmlDocument()

直接从基础数据存储区中或从缓存中将 XML 数据加载到内存中,然后以 XmlDataDocument 对象的形式将其返回。Loads the XML data into memory, either directly from the underlying data storage or from the cache, and returns it in the form of an XmlDataDocument object.

HasControls()

确定服务器控件是否包含任何子控件。Determines if the server control contains any child controls.

(继承自 HierarchicalDataSourceControl)
HasEvents()

返回一个值,该值指示是否为控件或任何子控件注册事件。Returns a value indicating whether events are registered for the control or any child controls.

(继承自 Control)
IsLiteralContent()

确定服务器控件是否只包含文字内容。Determines if the server control holds only literal content.

(继承自 Control)
LoadControlState(Object)

SaveControlState() 方法保存的上一个页请求还原控件状态信息。Restores control-state information from a previous page request that was saved by the SaveControlState() method.

(继承自 Control)
LoadViewState(Object)

从用 SaveViewState() 方法保存的上一个页面请求还原视图状态信息。Restores view-state information from a previous page request that was saved by the SaveViewState() method.

(继承自 Control)
MapPathSecure(String)

检索虚拟路径(绝对的或相对的)映射到的物理路径。Retrieves the physical path that a virtual path, either absolute or relative, maps to.

(继承自 Control)
MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(继承自 Object)
OnBubbleEvent(Object, EventArgs)

确定服务器控件的事件是否沿页的 UI 服务器控件层次结构向上传递。Determines whether the event for the server control is passed up the page's UI server control hierarchy.

(继承自 Control)
OnDataBinding(EventArgs)

引发 DataBinding 事件。Raises the DataBinding event.

(继承自 Control)
OnDataSourceChanged(EventArgs)

引发 DataSourceChanged 事件。Raises the DataSourceChanged event.

(继承自 HierarchicalDataSourceControl)
OnInit(EventArgs)

引发 Init 事件。Raises the Init event.

(继承自 Control)
OnLoad(EventArgs)

引发 Load 事件。Raises the Load event.

(继承自 Control)
OnPreRender(EventArgs)

引发 PreRender 事件。Raises the PreRender event.

(继承自 Control)
OnTransforming(EventArgs)

引发 Transforming 事件后,XmlDataSource 控件将对 XML 数据执行 XSLT 转换。Raises the Transforming event before the XmlDataSource control performs an XSLT transformation on its XML data.

OnUnload(EventArgs)

引发 Unload 事件。Raises the Unload event.

(继承自 Control)
OpenFile(String)

获取用于读取文件的 StreamGets a Stream used to read a file.

(继承自 Control)
RaiseBubbleEvent(Object, EventArgs)

将所有事件源及其信息分配给控件的父级。Assigns any sources of the event and its information to the control's parent.

(继承自 Control)
RemovedControl(Control)

Controls 对象的 Control 集合移除子控件后调用。Called after a child control is removed from the Controls collection of the Control object.

(继承自 Control)
Render(HtmlTextWriter)

将服务器控件内容发送到给定的 HtmlTextWriter 对象,该对象可编写将在客户端呈现的内容。Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(继承自 Control)
RenderChildren(HtmlTextWriter)

将服务器控件子级的内容输出到提供的 HtmlTextWriter 对象,该对象可写入要在客户端上呈现的内容。Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(继承自 Control)
RenderControl(HtmlTextWriter)

将服务器控件内容输出到所提供的 HtmlTextWriter 对象,如果启用了跟踪,则还将存储有关该控件的跟踪信息。Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

(继承自 HierarchicalDataSourceControl)
RenderControl(HtmlTextWriter, ControlAdapter)

使用提供的 HtmlTextWriter 对象将服务器控件内容输出到提供的 ControlAdapter 对象。Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

(继承自 Control)
ResolveAdapter()

获取负责呈现指定控件的控件适配器。Gets the control adapter responsible for rendering the specified control.

(继承自 Control)
ResolveClientUrl(String)

获取浏览器可以使用的 URL。Gets a URL that can be used by the browser.

(继承自 Control)
ResolveUrl(String)

将 URL 转换为在请求客户端可用的 URL。Converts a URL into one that is usable on the requesting client.

(继承自 Control)
Save()

如果设置了 XmlDataSource 属性,则使用 DataFile 控件将当前保留在内存中的 XML 数据保存到磁盘中。Saves the XML data currently held in memory by the XmlDataSource control to disk if the DataFile property is set.

SaveControlState()

保存将页面回发到服务器之后发生的所有服务器控件状态更改。Saves any server control state changes that have occurred since the time the page was posted back to the server.

(继承自 Control)
SaveViewState()

保存将页面回发到服务器之后发生的所有服务器控件视图状态更改。Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

(继承自 Control)
SetDesignModeState(IDictionary)

为控件设置设计时数据。Sets design-time data for a control.

(继承自 Control)
SetRenderMethodDelegate(RenderMethod)

分配事件处理程序委托,以将服务器控件及其内容呈现到父控件中。Assigns an event handler delegate to render the server control and its content into its parent control.

(继承自 Control)
SetTraceData(Object, Object)

使用跟踪数据键和跟踪数据值,为呈现数据的设计时追踪设置跟踪数据。Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.

(继承自 Control)
SetTraceData(Object, Object, Object)

使用跟踪对象、跟踪数据键和跟踪数据值,为呈现数据的设计时追踪设置跟踪数据。Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.

(继承自 Control)
ToString()

返回表示当前对象的字符串。Returns a string that represents the current object.

(继承自 Object)
TrackViewState()

导致跟踪服务器控件的视图状态的更改,以便这些更改可以存储到服务器控件的 StateBag 对象中。Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. 通过 ViewState 属性可访问此对象。This object is accessible through the ViewState property.

(继承自 Control)

事件

DataBinding

当服务器控件绑定到数据源时发生。Occurs when the server control binds to a data source.

(继承自 Control)
Disposed

当从内存释放服务器控件时发生,这是请求 ASP.NET 页时服务器控件生存期的最后阶段。Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

(继承自 Control)
Init

当服务器控件初始化时发生;初始化是控件生存期的第一步。Occurs when the server control is initialized, which is the first step in its lifecycle.

(继承自 Control)
Load

当服务器控件加载到 Page 对象中时发生。Occurs when the server control is loaded into the Page object.

(继承自 Control)
PreRender

在加载 Control 对象之后、呈现之前发生。Occurs after the Control object is loaded but prior to rendering.

(继承自 Control)
Transforming

将由 Transform 属性定义或由 TransformFile 属性标识的样式表应用到 XML 数据前发生。Occurs before the style sheet that is defined by the Transform property or identified by the TransformFile property is applied to XML data.

Unload

当服务器控件从内存中卸载时发生。Occurs when the server control is unloaded from memory.

(继承自 Control)

显式接口实现

IControlBuilderAccessor.ControlBuilder

有关此成员的说明,请参阅 ControlBuilderFor a description of this member, see ControlBuilder.

(继承自 Control)
IControlDesignerAccessor.GetDesignModeState()

有关此成员的说明,请参阅 GetDesignModeState()For a description of this member, see GetDesignModeState().

(继承自 Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)

有关此成员的说明,请参阅 SetDesignModeState(IDictionary)For a description of this member, see SetDesignModeState(IDictionary).

(继承自 Control)
IControlDesignerAccessor.SetOwnerControl(Control)

有关此成员的说明,请参阅 SetOwnerControl(Control)For a description of this member, see SetOwnerControl(Control).

(继承自 Control)
IControlDesignerAccessor.UserData

有关此成员的说明,请参阅 UserDataFor a description of this member, see UserData.

(继承自 Control)
IDataBindingsAccessor.DataBindings

有关此成员的说明,请参阅 DataBindingsFor a description of this member, see DataBindings.

(继承自 Control)
IDataBindingsAccessor.HasDataBindings

有关此成员的说明,请参阅 HasDataBindingsFor a description of this member, see HasDataBindings.

(继承自 Control)
IDataSource.DataSourceChanged

有关此成员的说明,请参见 DataSourceChangedFor a description of this member, see DataSourceChanged.

IDataSource.GetView(String)

获取与数据源控件关联的指定数据源视图。Gets the named data source view associated with the data source control.

IDataSource.GetViewNames()

有关此成员的说明,请参见 GetViewNames()For a description of this member, see GetViewNames().

IExpressionsAccessor.Expressions

有关此成员的说明,请参阅 ExpressionsFor a description of this member, see Expressions.

(继承自 Control)
IExpressionsAccessor.HasExpressions

有关此成员的说明,请参阅 HasExpressionsFor a description of this member, see HasExpressions.

(继承自 Control)
IHierarchicalDataSource.DataSourceChanged

更改 HierarchicalDataSourceControl 的方式对数据绑定控件产生一定影响时发生。Occurs when the HierarchicalDataSourceControl has changed in some way that affects data-bound controls.

(继承自 HierarchicalDataSourceControl)
IHierarchicalDataSource.GetHierarchicalView(String)

获取指定路径的 IHierarchicalDataSource 接口的视图帮助器对象。Gets the view helper object for the IHierarchicalDataSource interface for the specified path.

(继承自 HierarchicalDataSourceControl)
IListSource.ContainsListCollection

有关此成员的说明,请参见 ContainsListCollectionFor a description of this member, see ContainsListCollection.

IListSource.GetList()

有关此成员的说明,请参见 GetList()For a description of this member, see GetList().

IParserAccessor.AddParsedSubObject(Object)

有关此成员的说明,请参阅 AddParsedSubObject(Object)For a description of this member, see AddParsedSubObject(Object).

(继承自 Control)

扩展方法

FindDataSourceControl(Control)

返回与指定控件的数据控件关联的数据源。Returns the data source that is associated with the data control for the specified control.

FindFieldTemplate(Control, String)

返回指定控件的命名容器中指定列的字段模板。Returns the field template for the specified column in the specified control's naming container.

FindMetaTable(Control)

返回包含数据控件的元表对象。Returns the metatable object for the containing data control.

GetDefaultValues(IDataSource)

为指定数据源获取默认值的集合。Gets the collection of the default values for the specified data source.

GetMetaTable(IDataSource)

获取指定数据源对象中表的元数据。Gets the metadata for a table in the specified data source object.

TryGetMetaTable(IDataSource, MetaTable)

确定表元数据是否可用。Determines whether table metadata is available.

适用于

另请参阅