SiteMapDataSource クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
階層構造のサイト マップ データにバインドするために、Web サーバー コントロールおよびその他のコントロールで使用できるデータ ソース コントロールを提供します。
public ref class SiteMapDataSource : System::Web::UI::HierarchicalDataSourceControl, System::ComponentModel::IListSource, System::Web::UI::IDataSource
[System.Drawing.ToolboxBitmap(typeof(System.Web.UI.WebControls.SiteMapDataSource))]
public class SiteMapDataSource : System.Web.UI.HierarchicalDataSourceControl, System.ComponentModel.IListSource, System.Web.UI.IDataSource
[<System.Drawing.ToolboxBitmap(typeof(System.Web.UI.WebControls.SiteMapDataSource))>]
type SiteMapDataSource = class
inherit HierarchicalDataSourceControl
interface IDataSource
interface IListSource
Public Class SiteMapDataSource
Inherits HierarchicalDataSourceControl
Implements IDataSource, IListSource
- 継承
- 属性
- 実装
例
次のコード例では、コントロールを使用してコントロールを TreeView サイト マップに宣言的にバインドする方法を SiteMapDataSource 示します。 サイト マップ データは、ルート ノード レベルから取得されます。
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:SiteMapDataSource
id="SiteMapDataSource1"
runat="server" />
<asp:TreeView
id="TreeView1"
runat="server"
DataSourceID="SiteMapDataSource1">
</asp:TreeView>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:SiteMapDataSource
id="SiteMapDataSource1"
runat="server" />
<asp:TreeView
id="TreeView1"
runat="server"
DataSourceID="SiteMapDataSource1">
</asp:TreeView>
</form>
</body>
</html>
注釈
このトピックの内容:
はじめに
SiteMapDataSourceコントロールは、サイト用に構成されたサイト マップ プロバイダーによって格納されるサイト マップ データへのデータ ソースです。 SiteMapDataSourceでは、 コントロールなどのTreeViewMenuDropDownListサイト ナビゲーション コントロール以外の Web サーバー コントロールを階層型サイト マップ データにバインドできます。 これらの Web サーバー コントロールを使用すると、サイト マップを目次として表示したり、サイト内をアクティブに移動したりできます。 または、 コントロールを SiteMapPath 使用することもできます。これは、サイト ナビゲーション コントロールとして特別に設計されているため、コントロールの SiteMapDataSource インスタンスは必要ありません。
開始ノードの指定
は SiteMapDataSource サイト マップ データにバインドされ、サイト マップ階層内の指定した開始ノードに基づいてビューが表示されます。 既定では、階層のルート ノードですが、階層内の任意のノードにすることもできます。 開始ノードは、次のようにいくつかの SiteMapDataSource プロパティの値によって識別されます。
開始ノード | プロパティ値 |
---|---|
階層のルート ノード (既定の設定)。 |
StartFromCurrentNode が false です。StartingNodeUrl が設定されていません。 |
現在表示されているページを表すノード。 |
StartFromCurrentNode が true です。StartingNodeUrl が設定されていません。 |
階層の特定のノード。 |
StartFromCurrentNode が false です。StartingNodeUrlが設定されています。 |
プロパティが StartingNodeOffset 0 以外の値に設定されている場合は、開始ノードと、コントロールによって公開されるサイト マップ データ階層に影響します SiteMapDataSource 。 の負または正のStartingNodeOffset整数値は、 プロパティによって識別される開始ノードからサイト マップ階層のレベルの数を識別し、データ ソース コントロールによってStartFromCurrentNodeStartingNodeUrl公開されるサブツリーの開始ノードをオフセットします。
プロパティが負の StartingNodeOffset 数 -n に設定されている場合、データ ソース 管理によって公開されるサブツリーの開始ノードは、識別された開始ノードの上位にある先祖ノード n 階層レベルです。 値 n が階層ツリー内の先祖レベルの数より大きい場合、サブツリーの開始ノードはサイト マップ階層のルート ノードです。
プロパティが正の StartingNodeOffset 数 +n に設定されている場合、公開されるサブツリーの開始ノードは、識別された開始ノードより下の子ノード n レベルです。 階層内には複数の子ノードの分岐が存在する可能性があるため、可能であれば、 SiteMapDataSource 識別された開始ノードと現在要求されているページを表すノードの間のパスで子ノードを直接解決しようとします。 現在要求されているページを表すノードが、識別された開始ノードのサブツリーにない場合、 プロパティの StartingNodeOffset 値は無視されます。 現在要求されているページを表すノードが、識別された開始 ノードより n レベル未満の場合、現在要求されているページ ノードが開始ノードとして使用されます。
サイト マップ データの取得
サイト マップ データは、 などのXmlSiteMapProviderオブジェクトからSiteMapProvider取得されます。これは、ASP.NET の既定のサイト マップ プロバイダーです。 サイト マップ データを に提供するようにサイト用に構成されている任意のプロバイダーを指定し、コレクションに SiteMapDataSource アクセスして使用可能なプロバイダーの一覧を SiteMap.Providers 取得できます。
すべてのデータ ソース コントロールと同様に、 のすべての SiteMapDataSource インスタンスは、データ ソース ビューと呼ばれる 1 つのヘルパー オブジェクトに関連付けられます。 SiteMapDataSourceViewは、データ ソースのプロパティに従ってサイト マップ データのビューであり、 メソッドをGetHierarchicalView呼び出すことによって取得されます。 は SiteMapDataSourceView 、コントロールが SiteMapNodeCollection バインドするオブジェクトを保持します。
既定では、開始ノードは階層のルート ノードですが、開始ノードは任意のノードに設定できます。 開始点には、サイト マップ内の現在の位置または絶対位置を基準とするノードを指定できます。 開始ノードを指定するには、 プロパティを StartingNodeUrl 設定します。
SiteMapDataSourceはナビゲーション データに特化しており、並べ替え、フィルター処理、ページング、キャッシュ、更新、挿入、削除などのデータ レコード操作などの一般的なデータ ソース操作はサポートされていません。
宣言構文
<asp:SiteMapDataSource
EnableTheming="True|False"
EnableViewState="True|False"
ID="string"
OnDataBinding="DataBinding event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
runat="server"
ShowStartingNode="True|False"
SiteMapProvider="string"
SkinID="string"
StartFromCurrentNode="True|False"
StartingNodeOffset="integer"
StartingNodeUrl="uri"
Visible="True|False"
/>
コンストラクター
SiteMapDataSource() |
SiteMapDataSource クラスの新しいインスタンスを初期化します。 |
プロパティ
Adapter |
コントロール用のブラウザー固有のアダプターを取得します。 (継承元 Control) |
AppRelativeTemplateSourceDirectory |
このコントロールが含まれている Page オブジェクトまたは UserControl オブジェクトのアプリケーション相対の仮想ディレクトリを取得または設定します。 (継承元 Control) |
BindingContainer |
このコントロールのデータ バインディングを格納しているコントロールを取得します。 (継承元 Control) |
ChildControlsCreated |
サーバー コントロールの子コントロールが作成されたかどうかを示す値を取得します。 (継承元 Control) |
ClientID |
ASP.NET によって生成されたサーバー コントロール ID を取得します。 (継承元 HierarchicalDataSourceControl) |
ClientIDMode |
このプロパティは、データ ソース コントロールでは使用されません。 (継承元 HierarchicalDataSourceControl) |
ClientIDSeparator |
ClientID プロパティで使用される区切り記号を表す文字値を取得します。 (継承元 Control) |
ContainsListCollection |
データ ソース コントロールがデータ ソース ビュー オブジェクトのコレクションを格納しているかどうかを示す値を取得します。 |
Context |
現在の Web 要求に対するサーバー コントロールに関連付けられている HttpContext オブジェクトを取得します。 (継承元 Control) |
Controls |
UI 階層内の指定されたサーバー コントロールの子コントロールを表す ControlCollection オブジェクトを取得します。 (継承元 HierarchicalDataSourceControl) |
DataItemContainer |
名前付けコンテナーが IDataItemContainer を実装している場合、名前付けコンテナーへの参照を取得します。 (継承元 Control) |
DataKeysContainer |
名前付けコンテナーが IDataKeysControl を実装している場合、名前付けコンテナーへの参照を取得します。 (継承元 Control) |
DesignMode |
コントロールがデザイン サーフェイスで使用されているかどうかを示す値を取得します。 (継承元 Control) |
EnableTheming |
このコントロールがテーマをサポートしているかどうかを示す値を取得します。 (継承元 HierarchicalDataSourceControl) |
EnableViewState |
要求元クライアントに対して、サーバー コントロールがそのビュー状態と、そこに含まれる任意の子のコントロールのビュー状態を保持するかどうかを示す値を取得または設定します。 (継承元 Control) |
Events |
コントロールのイベント ハンドラー デリゲートのリストを取得します。 このプロパティは読み取り専用です。 (継承元 Control) |
HasChildViewState |
現在のサーバー コントロールの子コントロールが、保存されたビューステートの設定を持っているかどうかを示す値を取得します。 (継承元 Control) |
ID |
サーバー コントロールに割り当てられたプログラム ID を取得または設定します。 (継承元 Control) |
IdSeparator |
コントロール ID を区別するために使用する文字を取得します。 (継承元 Control) |
IsChildControlStateCleared |
このコントロールに含まれているコントロールに、コントロールの状態が設定されているかどうかを示す値を取得します。 (継承元 Control) |
IsTrackingViewState |
サーバー コントロールがビューステートの変更を保存しているかどうかを示す値を取得します。 (継承元 Control) |
IsViewStateEnabled |
このコントロールでビューステートが有効かどうかを示す値を取得します。 (継承元 Control) |
LoadViewStateByID |
コントロールがインデックスではなく ID によりビューステートの読み込みを行うかどうかを示す値を取得します。 (継承元 Control) |
NamingContainer |
同じ ID プロパティ値を持つ複数のサーバー コントロールを区別するための一意の名前空間を作成する、サーバー コントロールの名前付けコンテナーへの参照を取得します。 (継承元 Control) |
Page |
サーバー コントロールを含んでいる Page インスタンスへの参照を取得します。 (継承元 Control) |
Parent |
ページ コントロールの階層構造における、サーバー コントロールの親コントロールへの参照を取得します。 (継承元 Control) |
Provider |
データ ソース コントロールに関連付けられている SiteMapProvider オブジェクトを取得または設定します。 |
RenderingCompatibility |
レンダリングされる HTML と互換性がある ASP.NET のバージョンを表す値を取得します。 (継承元 Control) |
ShowStartingNode |
開始ノードが取得されて表示されるかどうかを示す値を取得または設定します。 |
Site |
デザイン サーフェイスに現在のコントロールを表示するときに、このコントロールをホストするコンテナーに関する情報を取得します。 (継承元 Control) |
SiteMapProvider |
データ ソースのバインド先のサイト マップ プロバイダーの名前を取得または設定します。 |
SkinID |
HierarchicalDataSourceControl コントロールに適用するスキンを取得または設定します。 (継承元 HierarchicalDataSourceControl) |
StartFromCurrentNode |
サイト マップのノード ツリーが現在のページを表すノードを使用して取得されるかどうかを示す値を取得または設定します。 |
StartingNodeOffset |
データ ソース コントロールによって公開されるルート階層を決定する、開始ノードからの正または負の整数のオフセットを取得または設定します。 |
StartingNodeUrl |
データ ソースが階層サイト マップからノードを取得するための参照ポイントとして使用する、サイト マップ内のノードを取得または設定します。 |
TemplateControl |
このコントロールを格納しているテンプレートへの参照を取得または設定します。 (継承元 Control) |
TemplateSourceDirectory |
現在のサーバー コントロールを格納している Page または UserControl の仮想ディレクトリを取得します。 (継承元 Control) |
UniqueID |
階層構造で修飾されたサーバー コントロールの一意の ID を取得します。 (継承元 Control) |
ValidateRequestMode |
ブラウザーからのクライアント入力の安全性をコントロールで調べるかどうかを示す値を取得または設定します。 (継承元 Control) |
ViewState |
同一のページに対する複数の要求にわたって、サーバー コントロールのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。 (継承元 Control) |
ViewStateIgnoresCase |
StateBag オブジェクトが大文字小文字を区別しないかどうかを示す値を取得します。 (継承元 Control) |
ViewStateMode |
このコントロールのビューステート モードを取得または設定します。 (継承元 Control) |
Visible |
コントロールが視覚的に表示されているかどうかを示す値を取得または設定します。 (継承元 HierarchicalDataSourceControl) |
メソッド
AddedControl(Control, Int32) |
子コントロールが Control オブジェクトの Controls コレクションに追加された後に呼び出されます。 (継承元 Control) |
AddParsedSubObject(Object) |
XML または HTML のいずれかの要素が解析されたことをサーバー コントロールに通知し、サーバー コントロールの ControlCollection オブジェクトに要素を追加します。 (継承元 Control) |
ApplyStyleSheetSkin(Page) |
ページのスタイル シートに定義されたスタイル プロパティをコントロールに適用します。 (継承元 HierarchicalDataSourceControl) |
BeginRenderTracing(TextWriter, Object) |
レンダリング データのデザイン時のトレースを開始します。 (継承元 Control) |
BuildProfileTree(String, Boolean) |
ページのトレースが有効な場合、サーバー コントロールに関する情報を収集し、これを表示するために Trace プロパティに渡します。 (継承元 Control) |
ClearCachedClientID() |
キャッシュされた ClientID 値を |
ClearChildControlState() |
サーバー コントロールのすべての子コントロールについて、コントロールの状態情報を削除します。 (継承元 Control) |
ClearChildState() |
サーバー コントロールのすべての子コントロールのビューステート情報およびコントロールの状態情報を削除します。 (継承元 Control) |
ClearChildViewState() |
サーバー コントロールのすべての子コントロールのビューステート情報を削除します。 (継承元 Control) |
ClearEffectiveClientIDMode() |
現在のコントロール インスタンスおよびすべての子コントロールの ClientIDMode プロパティを Inherit に設定します。 (継承元 Control) |
CreateChildControls() |
ASP.NET ページ フレームワークによって呼び出され、ポストバックまたはレンダリングの準備として、合成ベースの実装を使うサーバー コントロールに対し、それらのコントロールに含まれる子コントロールを作成するように通知します。 (継承元 Control) |
CreateControlCollection() |
サーバー コントロールの子コントロール (リテラルとサーバーの両方) を保持する新しい ControlCollection オブジェクトを作成します。 (継承元 HierarchicalDataSourceControl) |
DataBind() |
呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。 (継承元 Control) |
DataBind(Boolean) |
DataBinding イベントを発生させるオプションを指定して、呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。 (継承元 Control) |
DataBindChildren() |
データ ソースをサーバー コントロールの子コントロールにバインドします。 (継承元 Control) |
Dispose() |
サーバー コントロールが、メモリから解放される前に最終的なクリーンアップを実行できるようにします。 (継承元 Control) |
EndRenderTracing(TextWriter, Object) |
レンダリング データのデザイン時のトレースを終了します。 (継承元 Control) |
EnsureChildControls() |
サーバー コントロールに子コントロールが含まれているかどうかを確認します。 含まれていない場合、子コントロールを作成します。 (継承元 Control) |
EnsureID() |
ID が割り当てられていないコントロールの ID を作成します。 (継承元 Control) |
Equals(Object) |
指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
FindControl(String) |
指定した |
FindControl(String, Int32) |
指定した |
Focus() |
コントロールに入力フォーカスを設定します。 (継承元 HierarchicalDataSourceControl) |
GetDesignModeState() |
コントロールのデザイン時データを取得します。 (継承元 Control) |
GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
GetHierarchicalView(String) |
データ ソースの開始ノードおよびその他のプロパティに従って、SiteMapProvider オブジェクトのサイト マップ データの単一ビューを取得します。 |
GetList() |
データのリストのソースとして使用できるデータ ソース コントロールのリストを取得します。 |
GetRouteUrl(Object) |
ルート パラメーターのセットに対応する URL を取得します。 (継承元 Control) |
GetRouteUrl(RouteValueDictionary) |
ルート パラメーターのセットに対応する URL を取得します。 (継承元 Control) |
GetRouteUrl(String, Object) |
ルート パラメーターのセットおよびルート名に対応する URL を取得します。 (継承元 Control) |
GetRouteUrl(String, RouteValueDictionary) |
ルート パラメーターのセットおよびルート名に対応する URL を取得します。 (継承元 Control) |
GetType() |
現在のインスタンスの Type を取得します。 (継承元 Object) |
GetUniqueIDRelativeTo(Control) |
指定されたコントロールの UniqueID プロパティのプレフィックス部分を返します。 (継承元 Control) |
GetView(String) |
データ ソースの開始ノードおよびその他のプロパティに従って、サイト マップ プロバイダーのサイト マップ データの名前付きビューを取得します。 |
GetViewNames() |
データ ソース コントロールの名前付きビューのコレクションを取得します。 |
HasControls() |
サーバー コントロールに子コントロールが含まれているかどうかを確認します。 (継承元 HierarchicalDataSourceControl) |
HasEvents() |
コントロールまたは子コントロールに対してイベントが登録されているかどうかを示す値を返します。 (継承元 Control) |
IsLiteralContent() |
サーバー コントロールがリテラルな内容だけを保持しているかどうかを決定します。 (継承元 Control) |
LoadControlState(Object) |
SaveControlState() メソッドによって保存された前回のページ要求からコントロールの状態情報を復元します。 (継承元 Control) |
LoadViewState(Object) |
SaveViewState() メソッドによって保存された前回のページ要求からビューステート情報を復元します。 (継承元 Control) |
MapPathSecure(String) |
仮想パス (絶対パスまたは相対パス) の割り当て先の物理パスを取得します。 (継承元 Control) |
MemberwiseClone() |
現在の Object の簡易コピーを作成します。 (継承元 Object) |
OnBubbleEvent(Object, EventArgs) |
サーバー コントロールのイベントをページの UI サーバー コントロールの階層構造に渡すかどうかを決定します。 (継承元 Control) |
OnDataBinding(EventArgs) |
DataBinding イベントを発生させます。 (継承元 Control) |
OnDataSourceChanged(EventArgs) |
DataSourceChanged イベントを発生させます。 (継承元 HierarchicalDataSourceControl) |
OnInit(EventArgs) |
Init イベントを発生させます。 (継承元 Control) |
OnLoad(EventArgs) |
Load イベントを発生させます。 (継承元 Control) |
OnPreRender(EventArgs) |
PreRender イベントを発生させます。 (継承元 Control) |
OnUnload(EventArgs) |
Unload イベントを発生させます。 (継承元 Control) |
OpenFile(String) |
ファイルの読み込みで使用される Stream を取得します。 (継承元 Control) |
RaiseBubbleEvent(Object, EventArgs) |
イベントのソースおよびその情報をコントロールの親に割り当てます。 (継承元 Control) |
RemovedControl(Control) |
Control オブジェクトの Controls コレクションから子コントロールが削除された後に呼び出されます。 (継承元 Control) |
Render(HtmlTextWriter) |
提供されたクライアントに表示される内容を書き込む HtmlTextWriter オブジェクトに、サーバー コントロールの内容を送信します。 (継承元 Control) |
RenderChildren(HtmlTextWriter) |
提供された HtmlTextWriter オブジェクトに対してサーバー コントロールの子のコンテンツを出力すると、クライアントで表示されるコンテンツが記述されます。 (継承元 Control) |
RenderControl(HtmlTextWriter) |
指定の HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力し、トレースが有効である場合はコントロールに関するトレース情報を保存します。 (継承元 HierarchicalDataSourceControl) |
RenderControl(HtmlTextWriter, ControlAdapter) |
指定した ControlAdapter オブジェクトを使用して、指定した HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力します。 (継承元 Control) |
ResolveAdapter() |
指定したコントロールを表示するコントロール アダプターを取得します。 (継承元 Control) |
ResolveClientUrl(String) |
ブラウザーで使用できる URL を取得します。 (継承元 Control) |
ResolveUrl(String) |
要求側クライアントで使用できる URL に変換します。 (継承元 Control) |
SaveControlState() |
ページがサーバーにポスト バックされた時間以降に発生したすべてのサーバー コントロール状態の変化を保存します。 (継承元 Control) |
SaveViewState() |
ページがサーバーにポスト バックされた時間以降に発生した、サーバー コントロールのビューステートの変更を保存します。 (継承元 Control) |
SetDesignModeState(IDictionary) |
コントロールのデザイン時データを設定します。 (継承元 Control) |
SetRenderMethodDelegate(RenderMethod) |
サーバー コントロールとその内容を親コントロールに表示するイベント ハンドラー デリゲートを割り当てます。 (継承元 Control) |
SetTraceData(Object, Object) |
トレース データ キーとトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。 (継承元 Control) |
SetTraceData(Object, Object, Object) |
トレースされたオブジェクト、トレース データ キー、およびトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。 (継承元 Control) |
ToString() |
現在のオブジェクトを表す文字列を返します。 (継承元 Object) |
TrackViewState() |
サーバー コントロールにビューステートの変更を追跡させ、サーバー コントロールの StateBag オブジェクトに変更を格納できるようにします。 このオブジェクトは、ViewState プロパティによってアクセスできます。 (継承元 Control) |
イベント
DataBinding |
サーバー コントロールがデータ ソースに連結すると発生します。 (継承元 Control) |
Disposed |
サーバー コントロールがメモリから解放されると発生します。これは、ASP.NET ページが要求されている場合のサーバー コントロールの有効期間における最終段階です。 (継承元 Control) |
Init |
サーバー コントロールが初期化されると発生します。これは、サーバー コントロールの有効期間における最初の手順です。 (継承元 Control) |
Load |
サーバー コントロールが Page オブジェクトに読み込まれると発生します。 (継承元 Control) |
PreRender |
Control オブジェクトの読み込み後、表示を開始する前に発生します。 (継承元 Control) |
Unload |
サーバー コントロールがメモリからアンロードされると発生します。 (継承元 Control) |
明示的なインターフェイスの実装
拡張メソッド
FindDataSourceControl(Control) |
指定されたコントロールのデータ コントロールに関連付けられているデータ ソースを返します。 |
FindFieldTemplate(Control, String) |
指定されたコントロールの名前付けコンテナー内にある、指定された列のフィールド テンプレートを返します。 |
FindMetaTable(Control) |
格納しているデータ コントロールのメタテーブル オブジェクトを返します。 |
GetDefaultValues(IDataSource) |
指定されたデータ ソースの既定値のコレクションを取得します。 |
GetMetaTable(IDataSource) |
指定したデータ ソース オブジェクト内のテーブルのメタデータを取得します。 |
TryGetMetaTable(IDataSource, MetaTable) |
テーブル メタデータが使用できるかどうかを判断します。 |
適用対象
こちらもご覧ください
.NET