57 lines
3.9 KiB
XML
57 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="IHierarchicalEnumerable" FullName="System.Web.UI.IHierarchicalEnumerable">
|
|
<TypeSignature Language="C#" Value="public interface IHierarchicalEnumerable : System.Collections.IEnumerable" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> interface extends the <see cref="T:System.Collections.IEnumerable" /> interface and exposes <see cref="M:System.Web.UI.IHierarchicalEnumerable.GetHierarchyData(System.Object)" />, which is a method used to retrieve an <see cref="T:System.Web.UI.IHierarchyData" /> object from an enumerated item, in addition to the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method.</para>
|
|
<para>Typically, clients that use <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collections retrieve an <see cref="T:System.Collections.IEnumerator" /> object by calling the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method, then iterate through the enumeration and call the <see cref="M:System.Web.UI.IHierarchicalEnumerable.GetHierarchyData(System.Object)" /> on each enumerated item to retrieve an <see cref="T:System.Web.UI.IHierarchyData" /> object.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents a hierarchical collection that can be enumerated with an <see cref="T:System.Collections.IEnumerator" /> interface. Collections that implement the <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> interface are used by ASP.NET site navigation and data source controls.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName="GetHierarchyData">
|
|
<MemberSignature Language="C#" Value="public System.Web.UI.IHierarchyData GetHierarchyData (object enumeratedItem);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.IHierarchyData</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="enumeratedItem" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Typically, clients that use <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collections retrieve an <see cref="T:System.Collections.IEnumerator" /> object by calling the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method, then iterate through the enumeration and call the <see cref="M:System.Web.UI.IHierarchicalEnumerable.GetHierarchyData(System.Object)" /> method on each enumerated item to retrieve an <see cref="T:System.Web.UI.IHierarchyData" /> object.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a hierarchical data item for the specified enumerated item.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Web.UI.IHierarchyData" /> instance that represents the <see cref="T:System.Object" /> passed to the <see cref="M:System.Web.UI.IHierarchicalEnumerable.GetHierarchyData(System.Object)" /> method.</para>
|
|
</returns>
|
|
<param name="enumeratedItem">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> for which to return an <see cref="T:System.Web.UI.IHierarchyData" />. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |