SiteMapDataSourceView.xml

<Type Name="SiteMapDataSourceView" FullName="System.Web.UI.WebControls.SiteMapDataSourceView">
  <TypeSignature Language="C#" Value="public class SiteMapDataSourceView : System.Web.UI.DataSourceView" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SiteMapDataSourceView extends System.Web.UI.DataSourceView" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.SiteMapDataSourceView" />
  <TypeSignature Language="VB.NET" Value="Public Class SiteMapDataSourceView&#xA;Inherits DataSourceView" />
  <TypeSignature Language="F#" Value="type SiteMapDataSourceView = class&#xA;    inherit DataSourceView" />
  <TypeSignature Language="C++ CLI" Value="public ref class SiteMapDataSourceView : System::Web::UI::DataSourceView" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.UI.DataSourceView</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Provides a strongly typed <see cref="T:System.Web.UI.HierarchicalDataSourceView" /> object for the <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 enables ASP.NET data-bound controls, such as the <xref:System.Web.UI.WebControls.TreeView> and <xref:System.Web.UI.WebControls.Menu> controls, to bind to site map data. The <xref:System.Web.UI.WebControls.SiteMapDataSourceView> class is used by controls developers but it is not used by page developers nor in page code.  
  
 The <xref:System.Web.UI.WebControls.SiteMapDataSource> returns a <xref:System.Web.UI.WebControls.SiteMapDataSourceView> for a specified hierarchical path when the <xref:System.Web.UI.HierarchicalDataSourceView.Select%2A> method is called. Like all hierarchical data source view objects, the <xref:System.Web.UI.WebControls.SiteMapDataSourceView> is not named; rather, its is identified by its unique hierarchical path.  
  
 The <xref:System.Web.UI.WebControls.SiteMapDataSourceView> is a wrapper class on a <xref:System.Web.SiteMapNodeCollection> collection. The <xref:System.Web.SiteMapNodeCollection> class implements the <xref:System.Web.UI.IHierarchicalEnumerable> interface, which the <xref:System.Web.UI.WebControls.SiteMapDataSourceView> class returns from a call to `Select` method. Because the <xref:System.Web.UI.WebControls.SiteMapDataSource> and <xref:System.Web.UI.WebControls.SiteMapDataSourceView> work with <xref:System.Web.SiteMapNode> objects, the view maintains an internal <xref:System.Web.SiteMapNodeCollection> to contain them. The collection is initialized using the view's constructors and accessed with the <xref:System.Web.UI.WebControls.SiteMapDataSourceView.Select%2A> method.  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.UI.HierarchicalDataSourceView" />
    <altmember cref="T:System.Web.UI.WebControls.SiteMapDataSource" />
    <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.SiteMapDataSourceView" /> class.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SiteMapDataSourceView (System.Web.UI.WebControls.SiteMapDataSource owner, string name, System.Web.SiteMapNode node);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Web.UI.WebControls.SiteMapDataSource owner, string name, class System.Web.SiteMapNode node) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapDataSourceView.#ctor(System.Web.UI.WebControls.SiteMapDataSource,System.String,System.Web.SiteMapNode)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (owner As SiteMapDataSource, name As String, node As SiteMapNode)" />
      <MemberSignature Language="F#" Value="new System.Web.UI.WebControls.SiteMapDataSourceView : System.Web.UI.WebControls.SiteMapDataSource * string * System.Web.SiteMapNode -&gt; System.Web.UI.WebControls.SiteMapDataSourceView" Usage="new System.Web.UI.WebControls.SiteMapDataSourceView (owner, name, node)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; SiteMapDataSourceView(System::Web::UI::WebControls::SiteMapDataSource ^ owner, System::String ^ name, 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="owner" Type="System.Web.UI.WebControls.SiteMapDataSource" />
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="node" Type="System.Web.SiteMapNode" />
      </Parameters>
      <Docs>
        <param name="owner">The <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> that the <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> is associated with.</param>
        <param name="name">The name of the view.</param>
        <param name="node">The <see cref="T:System.Web.SiteMapNode" /> to add to the internal <see cref="T:System.Web.SiteMapNodeCollection" />.</param>
        <summary>Initializes a new named instance of the <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> class, adding the single specified node to the internal collection of nodes.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.WebControls.SiteMapDataSourceView> class is a wrapper class on a <xref:System.Web.SiteMapNodeCollection> object. Creating a <xref:System.Web.UI.WebControls.SiteMapDataSourceView> using the <xref:System.Web.UI.WebControls.SiteMapDataSourceView.%23ctor%2A> constructor initializes the internal node collection with a single <xref:System.Web.SiteMapNode> object. The site map structure is navigated using the node as a point of reference.  
  
 ]]></format>
        </remarks>
        <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>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SiteMapDataSourceView (System.Web.UI.WebControls.SiteMapDataSource owner, string name, System.Web.SiteMapNodeCollection collection);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Web.UI.WebControls.SiteMapDataSource owner, string name, class System.Web.SiteMapNodeCollection collection) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapDataSourceView.#ctor(System.Web.UI.WebControls.SiteMapDataSource,System.String,System.Web.SiteMapNodeCollection)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (owner As SiteMapDataSource, name As String, collection As SiteMapNodeCollection)" />
      <MemberSignature Language="F#" Value="new System.Web.UI.WebControls.SiteMapDataSourceView : System.Web.UI.WebControls.SiteMapDataSource * string * System.Web.SiteMapNodeCollection -&gt; System.Web.UI.WebControls.SiteMapDataSourceView" Usage="new System.Web.UI.WebControls.SiteMapDataSourceView (owner, name, collection)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; SiteMapDataSourceView(System::Web::UI::WebControls::SiteMapDataSource ^ owner, System::String ^ name, 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#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="owner" Type="System.Web.UI.WebControls.SiteMapDataSource" />
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="collection" Type="System.Web.SiteMapNodeCollection" />
      </Parameters>
      <Docs>
        <param name="owner">The <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> that the <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> is associated with.</param>
        <param name="name">The name of the view.</param>
        <param name="collection">A <see cref="T:System.Web.SiteMapNodeCollection" /> of nodes that the <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> provides a view of.</param>
        <summary>Initializes a new named instance of the <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> class, setting the internal collection of nodes to the specified node collection.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.WebControls.SiteMapDataSourceView> class is a wrapper class on a <xref:System.Web.SiteMapNodeCollection> object. Creating a <xref:System.Web.UI.WebControls.SiteMapDataSourceView> using the <xref:System.Web.UI.WebControls.SiteMapDataSourceView.%23ctor%2A> constructor initializes the internal node collection with the <xref:System.Web.SiteMapNodeCollection> that is passed to the constructor.  
  
 ]]></format>
        </remarks>
        <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>
    <Member MemberName="ExecuteSelect">
      <MemberSignature Language="C#" Value="protected internal override System.Collections.IEnumerable ExecuteSelect (System.Web.UI.DataSourceSelectArguments arguments);" />
      <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance class System.Collections.IEnumerable ExecuteSelect(class System.Web.UI.DataSourceSelectArguments arguments) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapDataSourceView.ExecuteSelect(System.Web.UI.DataSourceSelectArguments)" />
      <MemberSignature Language="VB.NET" Value="Protected Friend Overrides Function ExecuteSelect (arguments As DataSourceSelectArguments) As IEnumerable" />
      <MemberSignature Language="F#" Value="override this.ExecuteSelect : System.Web.UI.DataSourceSelectArguments -&gt; System.Collections.IEnumerable" Usage="siteMapDataSourceView.ExecuteSelect arguments" />
      <MemberSignature Language="C++ CLI" Value="protected public:&#xA; override System::Collections::IEnumerable ^ ExecuteSelect(System::Web::UI::DataSourceSelectArguments ^ arguments);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.IEnumerable</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="arguments" Type="System.Web.UI.DataSourceSelectArguments" />
      </Parameters>
      <Docs>
        <param name="arguments">A <see cref="T:System.Web.UI.DataSourceSelectArguments" /> that is used to request operations on the data beyond basic data retrieval.</param>
        <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>A <see cref="T:System.Web.SiteMapNodeCollection" /> that represents the site navigation structure for the current user.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.WebControls.SiteMapDataSourceView> class implements the inherited <xref:System.Web.UI.WebControls.SiteMapDataSourceView.ExecuteSelect%2A> method to retrieve a set of nodes that represents the site navigation structure for the current ASP.NET application. Page developers and data-bound control authors do not call the <xref:System.Web.UI.WebControls.SiteMapDataSourceView.ExecuteSelect%2A> method directly; instead, use the publicly exposed <xref:System.Web.UI.WebControls.SiteMapDataSourceView.Select%2A> method.  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.NotSupportedException">The <paramref name="arguments" /> passed to the <see cref="M:System.Web.UI.WebControls.SiteMapDataSourceView.Select(System.Web.UI.DataSourceSelectArguments)" /> specify that the data source should perform some additional work while retrieving data to enable paging or sorting through the retrieved data, but the data source control does not support the requested capability.</exception>
        <altmember cref="M:System.Web.UI.WebControls.SiteMapDataSourceView.Select(System.Web.UI.DataSourceSelectArguments)" />
        <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="OnDataSourceViewChanged">
      <MemberSignature Language="C#" Value="protected override void OnDataSourceViewChanged (EventArgs e);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnDataSourceViewChanged(class System.EventArgs e) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapDataSourceView.OnDataSourceViewChanged(System.EventArgs)" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnDataSourceViewChanged (e As EventArgs)" />
      <MemberSignature Language="F#" Value="override this.OnDataSourceViewChanged : EventArgs -&gt; unit" Usage="siteMapDataSourceView.OnDataSourceViewChanged e" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; override void OnDataSourceViewChanged(EventArgs ^ e);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="e" Type="System.EventArgs" />
      </Parameters>
      <Docs>
        <param name="e">An <see cref="T:System.EventArgs" /> that contains event data.</param>
        <summary>Raises the <see cref="E:System.Web.UI.DataSourceView.DataSourceViewChanged" /> event.</summary>
        <remarks>To be added.</remarks>
        <altmember cref="M:System.Web.UI.DataSourceView.OnDataSourceViewChanged(System.EventArgs)" />
        <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 System.Collections.IEnumerable Select (System.Web.UI.DataSourceSelectArguments arguments);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.IEnumerable Select(class System.Web.UI.DataSourceSelectArguments arguments) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.SiteMapDataSourceView.Select(System.Web.UI.DataSourceSelectArguments)" />
      <MemberSignature Language="VB.NET" Value="Public Function Select (arguments As DataSourceSelectArguments) As IEnumerable" />
      <MemberSignature Language="F#" Value="override this.Select : System.Web.UI.DataSourceSelectArguments -&gt; System.Collections.IEnumerable" Usage="siteMapDataSourceView.Select arguments" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Collections::IEnumerable ^ Select(System::Web::UI::DataSourceSelectArguments ^ arguments);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.IEnumerable</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="arguments" Type="System.Web.UI.DataSourceSelectArguments" />
      </Parameters>
      <Docs>
        <param name="arguments">A <see cref="T:System.Web.UI.DataSourceSelectArguments" /> that is used to request operations on the data beyond basic data retrieval.</param>
        <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>A <see cref="T:System.Web.SiteMapNodeCollection" /> that represents the site navigation structure for the current user.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.WebControls.SiteMapDataSourceView.Select%2A> method calls the <xref:System.Web.UI.WebControls.SiteMapDataSourceView.ExecuteSelect%2A> method, passing the `arguments` parameter. The <xref:System.Web.UI.WebControls.SiteMapDataSourceView.Select%2A> method is used by controls developers but it is not used by page developers nor in page code.  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.NotSupportedException">The <paramref name="arguments" /> passed to the <see cref="M:System.Web.UI.WebControls.SiteMapDataSourceView.Select(System.Web.UI.DataSourceSelectArguments)" /> specify that the data source should perform some additional work while retrieving data to enable paging or sorting through the retrieved data, but the data source control does not support the requested capability.</exception>
        <altmember cref="M:System.Web.UI.WebControls.SiteMapDataSourceView.ExecuteSelect(System.Web.UI.DataSourceSelectArguments)" />
        <altmember cref="T:System.Web.SiteMapNodeCollection" />
        <altmember cref="T:System.Web.UI.IHierarchicalEnumerable" />
        <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>