File: IHierarchicalEnumerable.xml

package info (click to toggle)
mono-reference-assemblies 3.12.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 604,240 kB
  • ctags: 625,505
  • sloc: cs: 3,967,741; xml: 2,793,081; ansic: 418,042; java: 60,435; sh: 14,833; makefile: 11,576; sql: 7,956; perl: 1,467; cpp: 1,446; yacc: 1,203; python: 598; asm: 422; sed: 16; php: 1
file content (57 lines) | stat: -rw-r--r-- 4,028 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<?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>