-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SiteMapHierarchicalDataSourceView.xml
147 lines (136 loc) · 12 KB
/
SiteMapHierarchicalDataSourceView.xml
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
<Type Name="SiteMapHierarchicalDataSourceView" FullName="System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView">
<TypeSignature Language="C#" Value="public class SiteMapHierarchicalDataSourceView : System.Web.UI.HierarchicalDataSourceView" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SiteMapHierarchicalDataSourceView extends System.Web.UI.HierarchicalDataSourceView" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" />
<TypeSignature Language="VB.NET" Value="Public Class SiteMapHierarchicalDataSourceView
Inherits HierarchicalDataSourceView" />
<TypeSignature Language="F#" Value="type SiteMapHierarchicalDataSourceView = class
 inherit HierarchicalDataSourceView" />
<TypeSignature Language="C++ CLI" Value="public ref class SiteMapHierarchicalDataSourceView : System::Web::UI::HierarchicalDataSourceView" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.HierarchicalDataSourceView</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a data view on a site map node or collection of nodes for a <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.SiteMapDataSource> control can present its underlying data in both tabular and hierarchical format to Web server controls that bind to it. The <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView> is used by controls developers, but not page developers or in page code.
Controls such as <xref:System.Web.UI.WebControls.Menu> or <xref:System.Web.UI.WebControls.DropDownList> use the <xref:System.Web.UI.WebControls.SiteMapDataSource> to bind to site map data and present it in list form, while controls that derive from the <xref:System.Web.UI.WebControls.HierarchicalDataBoundControl> class, such as <xref:System.Web.UI.WebControls.TreeView>, bind to sitemap data and present it in hierarchical form.
If a data-bound control calls the <xref:System.Web.UI.IDataSource.GetView%2A> method of the <xref:System.Web.UI.WebControls.SiteMapDataSource>, a <xref:System.Web.UI.WebControls.SiteMapDataSourceView> is created by the data source. If a control calls the <xref:System.Web.UI.WebControls.HierarchicalDataBoundControl><xref:System.Web.UI.HierarchicalDataSourceControl.GetHierarchicalView%2A> method, a <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView> is created. The <xref:System.Web.UI.WebControls.SiteMapDataSourceView> class is provided for Web server controls that derive from <xref:System.Web.UI.WebControls.DataBoundControl> and bind to lists and tabular data, while the <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView> is provided for Web server controls that derive from <xref:System.Web.UI.WebControls.HierarchicalDataBoundControl> and bind to hierarchical data.
Like all <xref:System.Web.UI.HierarchicalDataSourceView> helper objects, the <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView> defines the operations that the data source can perform with the underlying data. Because the <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView> class only overrides the <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.Select%2A> method, the associated <xref:System.Web.UI.WebControls.SiteMapDataSource> control does not support sort expressions or insert, delete, or update operations.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/x20z8c51(v=vs.100)">SiteMapPath Web Server Control Overview</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/ms227425(v=vs.100)">Securing ASP.NET Site Navigation</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SiteMapHierarchicalDataSourceView (System.Web.SiteMapNode node);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Web.SiteMapNode node) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.#ctor(System.Web.SiteMapNode)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (node As SiteMapNode)" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView : System.Web.SiteMapNode -> System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" Usage="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView node" />
<MemberSignature Language="C++ CLI" Value="public:
 SiteMapHierarchicalDataSourceView(System::Web::SiteMapNode ^ node);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="node" Type="System.Web.SiteMapNode" />
</Parameters>
<Docs>
<param name="node">A <see cref="T:System.Web.SiteMapNode" /> that the data source view represents.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" /> class, adding the specified node to the <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collection that the data source view maintains.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView> class maintains an internal <xref:System.Web.SiteMapNodeCollection> collection of nodes. When the <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.%23ctor%2A> constructor is used, the specified node is added to the collection. A call to the <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.Select%2A> method will return this collection of one element.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/x20z8c51(v=vs.100)">SiteMapPath Web Server Control Overview</related>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SiteMapHierarchicalDataSourceView (System.Web.SiteMapNodeCollection collection);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Web.SiteMapNodeCollection collection) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.#ctor(System.Web.SiteMapNodeCollection)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (collection As SiteMapNodeCollection)" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView : System.Web.SiteMapNodeCollection -> System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" Usage="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView collection" />
<MemberSignature Language="C++ CLI" Value="public:
 SiteMapHierarchicalDataSourceView(System::Web::SiteMapNodeCollection ^ collection);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="collection" Type="System.Web.SiteMapNodeCollection" />
</Parameters>
<Docs>
<param name="collection">A <see cref="T:System.Web.SiteMapNodeCollection" /> that the data source view represents.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" /> class, setting the specified collection to the <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collection that the data source view maintains.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView> class maintains an internal <xref:System.Web.SiteMapNodeCollection> collection of nodes. When the <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.%23ctor%2A> constructor is used, the specified collection becomes the one the data source view maintains.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/x20z8c51(v=vs.100)">SiteMapPath Web Server Control Overview</related>
</Docs>
</Member>
<Member MemberName="Select">
<MemberSignature Language="C#" Value="public override System.Web.UI.IHierarchicalEnumerable Select ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Web.UI.IHierarchicalEnumerable Select() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.Select" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Select () As IHierarchicalEnumerable" />
<MemberSignature Language="F#" Value="override this.Select : unit -> System.Web.UI.IHierarchicalEnumerable" Usage="siteMapHierarchicalDataSourceView.Select " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Web::UI::IHierarchicalEnumerable ^ Select();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.IHierarchicalEnumerable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the collection of the <see cref="T:System.Web.SiteMapNode" /> objects that represents the site navigation structure for the current user.</summary>
<returns>An <see cref="T:System.Web.UI.IHierarchicalEnumerable" /> collection of site map nodes.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView.Select%2A> method returns an <xref:System.Web.UI.IHierarchicalEnumerable> collection of nodes. You can call the <xref:System.String.System%23Collections%23IEnumerable%23GetEnumerator%2A> method to get an <xref:System.Collections.IEnumerator> object and iterate through this collection.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" />
<altmember cref="T:System.Web.SiteMapNode" />
<altmember cref="T:System.Web.SiteMapNodeCollection" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/x20z8c51(v=vs.100)">SiteMapPath Web Server Control Overview</related>
</Docs>
</Member>
</Members>
</Type>