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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IHierarchyData" FullName="System.Web.UI.IHierarchyData">
<TypeSignature Language="C#" Value="public interface IHierarchyData" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.IHierarchyData" /> interface is implemented by classes that represent nodes of a hierarchical structure, and track the hierarchical relationships to their parent and child nodes. Classes that implement the <see cref="T:System.Web.UI.IHierarchyData" /> interface can be contained in collections that implement the <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Exposes a node of a hierarchical data structure, including the node object and some properties that describe characteristics of the node. Objects that implement the <see cref="T:System.Web.UI.IHierarchyData" /> interface can be contained in <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collections, and are used by ASP.NET site navigation and data source controls.</para>
</summary>
</Docs>
<Members>
<Member MemberName="GetChildren">
<MemberSignature Language="C#" Value="public System.Web.UI.IHierarchicalEnumerable GetChildren ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.IHierarchicalEnumerable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can use the <see cref="P:System.Web.UI.IHierarchyData.HasChildren" /> property to determine whether the <see cref="T:System.Web.UI.IHierarchyData" /> node has child nodes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets an enumeration object that represents all the child nodes of the current hierarchical node.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collection of child nodes of the current hierarchical node.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetParent">
<MemberSignature Language="C#" Value="public System.Web.UI.IHierarchyData GetParent ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.IHierarchyData</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.IHierarchyData" /> interface does not define a HasParent convenience property, so callers must check the return value of the <see cref="M:System.Web.UI.IHierarchyData.GetParent" /> method for null to determine whether the current <see cref="T:System.Web.UI.IHierarchyData" /> node is the root node of the hierarchical data structure to which the node belongs.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets an <see cref="T:System.Web.UI.IHierarchyData" /> object that represents the parent node of the current hierarchical node.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Web.UI.IHierarchyData" /> object that represents the parent node of the current hierarchical node.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HasChildren">
<MemberSignature Language="C#" Value="public bool HasChildren { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.IHierarchyData.HasChildren" /> property is a convenience property that enables callers to avoid checking the return value of the <see cref="M:System.Web.UI.IHierarchyData.GetChildren" /> method for null. If the <see cref="P:System.Web.UI.IHierarchyData.HasChildren" /> property returns true, call the <see cref="M:System.Web.UI.IHierarchyData.GetChildren" /> method to retrieve an <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collection of child nodes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the hierarchical data node that the <see cref="T:System.Web.UI.IHierarchyData" /> object represents has any child nodes.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public object Item { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>While many classes that represent hierarchical data nodes, such as the <see cref="T:System.Web.SiteMapNode" /> class, implement the <see cref="T:System.Web.UI.IHierarchyData" /> interface directly, other classes only act as a wrapper for a class that does not implement the interface. The <see cref="P:System.Web.UI.IHierarchyData.Item" /> property is provided for these design situations, when business objects are functionally equivalent to an <see cref="T:System.Web.UI.IHierarchyData" /> object but cannot be redesigned easily.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the hierarchical data node that the <see cref="T:System.Web.UI.IHierarchyData" /> object represents.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.IHierarchyData.Path" /> property can be passed to the <see cref="M:System.Web.UI.HierarchicalDataSourceControl.GetHierarchicalView(System.String)" /> method to retrieve the <see cref="T:System.Web.UI.HierarchicalDataSourceView" /> object that corresponds to the node identified by <see cref="P:System.Web.UI.IHierarchyData.Path" />.</para>
<block subset="none" type="note">
<para>The <see cref="P:System.Web.UI.IHierarchyData.Path" /> property should not contain any sensitive information about the host environment, because it might be rendered to the client in a data-bound control.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the hierarchical path of the node.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public string Type { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.IHierarchyData.Type" /> property does not return the <see cref="T:System.Type" /> of the object represented in an <see cref="T:System.Web.UI.IHierarchyData" /> object. It returns a name used by data-bound controls to differentiate between items in a hierarchy that have different bindable properties.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the type of <see cref="T:System.Object" /> contained in the <see cref="P:System.Web.UI.IHierarchyData.Item" /> property.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
|