Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
147 lines (135 sloc) 11.8 KB
<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&#xA;Inherits HierarchicalDataSourceView" />
<TypeSignature Language="C++ CLI" Value="public ref class SiteMapHierarchicalDataSourceView : System::Web::UI::HierarchicalDataSourceView" />
<TypeSignature Language="F#" Value="type SiteMapHierarchicalDataSourceView = class&#xA; inherit 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://msdn.microsoft.com/library/de8fa2ed-b3c1-4855-bb61-f6287060c4b9">SiteMapPath Web Server Control Overview</related>
<related type="Article" href="https://msdn.microsoft.com/library/1686b4cd-435a-42dc-b22d-713d7763f97d">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="C++ CLI" Value="public:&#xA; SiteMapHierarchicalDataSourceView(System::Web::SiteMapNode ^ node);" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView : System.Web.SiteMapNode -&gt; System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" Usage="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView 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://msdn.microsoft.com/library/de8fa2ed-b3c1-4855-bb61-f6287060c4b9">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="C++ CLI" Value="public:&#xA; SiteMapHierarchicalDataSourceView(System::Web::SiteMapNodeCollection ^ collection);" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView : System.Web.SiteMapNodeCollection -&gt; System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView" Usage="new System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView 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>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://msdn.microsoft.com/library/de8fa2ed-b3c1-4855-bb61-f6287060c4b9">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="C++ CLI" Value="public:&#xA; override System::Web::UI::IHierarchicalEnumerable ^ Select();" />
<MemberSignature Language="F#" Value="override this.Select : unit -&gt; System.Web.UI.IHierarchicalEnumerable" Usage="siteMapHierarchicalDataSourceView.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://msdn.microsoft.com/library/de8fa2ed-b3c1-4855-bb61-f6287060c4b9">SiteMapPath Web Server Control Overview</related>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.