SiteMapDataSource クラス
アセンブリ: System.Web (system.web.dll 内)
構文Public Class SiteMapDataSource Inherits HierarchicalDataSourceControl Implements IDataSource, IListSource
解説SiteMapDataSource コントロールは、サイト用に構成されているサイト マップ プロバイダによって格納されるサイト マップ データのデータ ソースです。SiteMapDataSource は、TreeView、Menu、および DropDownList の各コントロールなどの、厳密にはサイト ナビゲーション コントロールではない Web サーバー コントロールを、階層構造のサイト マップ データにバインドできるようにします。これらの Web サーバー コントロールを使用して、サイト マップを目次として表示したり、サイトをアクティブに移動したりできます。または、SiteMapPath コントロールを使用することもできます。これは、特にサイト ナビゲーション コントロールとして設計されているため、SiteMapDataSource コントロールのインスタンスが不要です。
SiteMapDataSource はサイト マップ データにバインドし、サイト マップ階層の中で指定された開始ノードに基づいてビューを表示します。既定では、開始ノードは階層のルート ノードですが、階層内のあらゆるノードを開始ノードにできます。開始ノードは、次に示す複数の SiteMapDataSource プロパティの値で識別されます。
| StartFromCurrentNode が false です。 StartingNodeUrl が設定されていません。 | |
| StartFromCurrentNode が true です。 StartingNodeUrl が設定されていません。 | |
| StartFromCurrentNode が false です。 |
StartingNodeOffset プロパティに 0 以外の値が設定されている場合は、その設定は開始ノードおよび SiteMapDataSource コントロールによって公開されるサイト マップ データの階層に影響します。StartingNodeOffset の負の整数値または正の整数値は、StartFromCurrentNode プロパティと StartingNodeUrl プロパティで識別される開始ノードからデータ ソース コントロールによって公開されるサブツリーの開始ノードへ、サイト マップ階層を上方向または下方向へオフセットするレベル数を示します。
StartingNodeOffset プロパティに負の数値 -n が設定されている場合、データ ソース コントロールによって公開されるサブツリーの開始ノードは、識別される開始ノードより n レベル上の階層の先祖ノードになります。値 n が階層ツリーにある先祖レベルの数より大きい場合は、サブツリーの開始ノードがサイト マップ階層のルート ノードになります。
StartingNodeOffset プロパティに正の数値 +n が設定されている場合、公開されるサブツリーの開始ノードは、識別される開始ノードより n レベル下の子ノードになります。階層内で子ノードが複数に分岐している可能性があるため、現在要求されているページがある場合は、SiteMapDataSource は、識別される開始ノードと現在要求されているページを表すノード間のパス上で子ノードを直接解決します。現在要求されているページを表すノードが識別される開始ノードのサブツリー内にない場合は、StartingNodeOffset プロパティの値は無視されます。識別される開始ノードから現在要求されているページを表すノードへの下方向のレベルの数が n より小さい場合は、現在要求されているページのノードが開始ノードとして使用されます。
サイト マップ データは、ASP.NET の既定のサイト マップ プロバイダである SiteMapProvider オブジェクト (XmlSiteMapProvider など) から取得されます。サイト用に構成された任意のプロバイダを指定して、サイト マップ データを SiteMapDataSource に提供できます。また、SiteMap.Providers コレクションにアクセスして、使用できるプロバイダの一覧を取得できます。
あらゆるデータ ソース コントロールと同様に、SiteMapDataSource のすべてのインスタンスは、データ ソース ビューという単一のヘルパー オブジェクトに関連付けられます。SiteMapDataSourceView は、データ ソースのプロパティに基づいたサイト マップ データのビューで、GetHierarchicalView メソッドを呼び出して取得されます。SiteMapDataSourceView は、コントロールのバインド先の SiteMapNodeCollection オブジェクトを保持します。
既定では、開始ノードは階層のルート ノードですが、任意のノードを開始ノードに設定できます。サイト マップ内の現在の位置に相対するノード、または絶対位置に相対するノードを開始点にできます。開始ノードは StartingNodeUrl プロパティを設定して指定できます。
SiteMapDataSource はナビゲーション データ専用であるため、並べ替え、フィルタ処理、ページング、キャッシングなどの一般的なデータ ソース操作や、更新、挿入、削除などのデータ レコード操作はサポートしません。
使用例SiteMapDataSource コントロールを使用して、TreeView コントロールをサイト マップに宣言によってバインドする方法のコード例を次に示します。サイト マップ データはルート ノード レベルの開始位置から取得されます。
<%@ Page Language="VB" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <HTML> <BODY> <FORM runat="server"> <asp:SiteMapDataSource id="SiteMapDataSource1" runat="server" /> <asp:TreeView id="TreeView1" runat="server" DataSourceID="SiteMapDataSource1"> </asp:TreeView> </FORM> </BODY> </HTML>
<%@ Page Language="C#" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <HTML> <BODY> <FORM runat="server"> <asp:SiteMapDataSource id="SiteMapDataSource1" runat="server" /> <asp:TreeView id="TreeView1" runat="server" DataSourceID="SiteMapDataSource1"> </asp:TreeView> </FORM> </BODY> </HTML>
<%@ Page Language="VJ#" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <HTML> <BODY> <FORM runat="server"> <asp:SiteMapDataSource id="SiteMapDataSource1" runat="server"> </asp:SiteMapDataSource> <asp:TreeView id="TreeView1" runat="server" DataSourceID="SiteMapDataSource1"> </asp:TreeView> </FORM> </BODY> </HTML>
.NET Framework のセキュリティ継承階層System.Web.UI.Control
System.Web.UI.HierarchicalDataSourceControl
System.Web.UI.WebControls.SiteMapDataSource
スレッド セーフプラットフォームWindows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照SiteMapDataSource メンバ
System.Web.UI.WebControls 名前空間
SiteMap
SiteMapProvider
TreeView
SiteMapPath
その他の技術情報
ASP.NET サイト ナビゲーション
SiteMapPath Web サーバー コントロールの概要
ASP.NET のサイト ナビゲーションの保護
Weblioに収録されているすべての辞書からSiteMapDataSource クラスを検索する場合は、下記のリンクをクリックしてください。
全ての辞書からSiteMapDataSource クラス
を検索
- SiteMapDataSource クラスのページへのリンク
