SiteMapDataSource SiteMapDataSource SiteMapDataSource SiteMapDataSource Class

定義

階層構造のサイト マップ データにバインドするために、Web サーバー コントロールおよびその他のコントロールで使用できるデータ ソース コントロールを提供します。Provides a data source control that Web server controls and other controls can use to bind to hierarchical site map data.

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
type SiteMapDataSource = class
    inherit HierarchicalDataSourceControl
    interface IDataSource
    interface IListSource
Public Class SiteMapDataSource
Inherits HierarchicalDataSourceControl
Implements IDataSource, IListSource
継承
属性
実装

次のコード例は、 TreeView SiteMapDataSourceコントロールを使用してコントロールを宣言によってサイトマップにバインドする方法を示しています。The following code example demonstrates how to declaratively bind a TreeView control to a site map using a SiteMapDataSource control. サイトマップデータは、ルートノードレベルから取得されます。The site map data is retrieved beginning at the root node level.

<%@ 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>

注釈

このトピックの内容:In this topic:

はじめにIntroduction

SiteMapDataSourceコントロールは、サイト用に構成されたサイトマッププロバイダーによって保存されるサイトマップデータのデータソースです。The SiteMapDataSource control is a data source to the site map data that is stored by the site map providers that are configured for your site. SiteMapDataSource使用すると、、、およびDropDownListTreeView各コントロールなど、特にMenuサイトナビゲーションコントロールではない Web サーバーコントロールを、階層型のサイトマップデータにバインドできます。The SiteMapDataSource enables Web server controls that are not specifically site navigation controls, such as the TreeView, Menu, and DropDownList controls, to bind to hierarchical site map data. これらの Web サーバーコントロールを使用して、サイトマップを目次として表示したり、サイトを積極的にナビゲートしたりすることができます。You can use these Web server controls to display a site map as a table of contents or to actively navigate a site. また、 SiteMapPathコントロールを使用することもできます。このコントロールは、特にサイトナビゲーションコントロールとして設計されSiteMapDataSourceているため、コントロールのインスタンスは必要ありません。Alternatively, you can use the SiteMapPath control, which is designed specifically as a site navigation control and therefore does not need an instance of the SiteMapDataSource control.

開始ノードの指定Specifying the Starting Node

SiteMapDataSource 、サイトマップデータにバインドし、サイトマップ階層内の指定された開始ノードに基づいてそのビューを表示します。The SiteMapDataSource binds to site map data and presents its view based on a specified starting node in the site map hierarchy. 既定では、階層のルートノードですが、階層内の任意のノードでもかまいません。By default, it is the root node of the hierarchy but it can also be any node within the hierarchy. 開始ノードは、次のようにいくつかSiteMapDataSourceのプロパティの値によって識別されます。The starting node is identified by the values of several SiteMapDataSource properties as follows:

開始ノードStarting Node プロパティ値Property Values
階層のルートノード (既定の設定)。The root node of the hierarchy (the default setting). StartFromCurrentNodefalse です。The StartFromCurrentNode is false.

StartingNodeUrl が設定されていません。The StartingNodeUrl is not set.
現在表示されているページを表すノード。The node that represents the currently viewed page. StartFromCurrentNodetrue です。The StartFromCurrentNode is true.

StartingNodeUrl が設定されていません。The StartingNodeUrl is not set.
階層の特定のノード。A specific node of the hierarchy. StartFromCurrentNodefalse です。The StartFromCurrentNode is false.

StartingNodeUrl設定されています。The StartingNodeUrl is set.

プロパティが0以外の値に設定されている場合は、開始ノードと、 SiteMapDataSourceコントロールによって公開されているサイトマップデータ階層に影響します。 StartingNodeOffsetIf the StartingNodeOffset property is set to a value other than 0, it affects the starting node and with it the site map data hierarchy that is exposed by the SiteMapDataSource control. StartingNodeOffset負または正の整数値は、サブツリーの開始ノードをオフセットするために、プロパティStartFromCurrentNodeおよびStartingNodeUrlプロパティによって識別される開始ノードから、サイトマップ階層の上下のレベル数を識別します。データソースコントロールによって公開されます。The negative or positive integer value of the StartingNodeOffset identifies the number of levels up or down the site map hierarchy from the starting node that is identified by the StartFromCurrentNode and StartingNodeUrl properties to offset the starting node of the subtree that is exposed by data source control.

プロパティが負の値に設定されている場合、データソースコントロールによって公開されるサブツリーの開始ノードは、識別された開始ノードの上にある先祖ノードn階層レベルになります。 ** StartingNodeOffsetIf the StartingNodeOffset property is set to a negative number -n, the starting node of the subtree that is exposed by the data source control is the ancestor node n hierarchical levels above the identified starting node. nが階層ツリー内の先祖レベルの数より大きい場合、サブツリーの開始ノードはサイトマップ階層のルートノードになります。If the value n is greater than the number of ancestor levels in the hierarchical tree, the starting node of the subtree is the root node of the site map hierarchy.

プロパティが正の数値 +nに設定されている場合、公開されるサブツリーの開始ノードは、識別された開始ノードの下にある子ノード n レベルになります。 ** StartingNodeOffsetIf the StartingNodeOffset property is set to a positive number +n, the starting node of the subtree that is exposed is a child node n levels below the identified starting node. 階層内に子ノードの複数の分岐が存在する可能性があるSiteMapDataSourceため、では、指定された開始ノードと現在要求されているページを表すノードの間のパスで、子ノードを直接解決しようとします (可能な場合)。Because more than one branch of child nodes might exist in the hierarchy, the SiteMapDataSource attempts to resolve a child node directly on the path between the identified starting node and the node that represents the currently requested page, if possible. 現在要求されているページを表すノードが、識別された開始ノードのサブツリーに存在しStartingNodeOffsetない場合、プロパティの値は無視されます。If the node that represents the currently requested page is not in the subtree of the identified starting node, the value of the StartingNodeOffset property is ignored. 現在要求されているページを表すノードが、識別された開始ノードの下位のnレベルより小さい場合、現在要求されているページノードが開始ノードとして使用されます。If the node that represents the currently requested page is less than n levels below the identified starting node, the currently requested page node is used as the starting node.

サイトマップデータの取得Retrieving Site Map Data

サイトマップのデータはSiteMapProvider XmlSiteMapProvider、ASP.NET の既定のサイトマッププロバイダーであるなどのオブジェクトから取得されます。Site map data is retrieved from an SiteMapProvider object, such as XmlSiteMapProvider, which is the default site map provider for ASP.NET. サイトに対してサイトマップデータSiteMapDataSourceを提供するように構成されている任意のプロバイダーを指定できます。また、 SiteMap.Providersコレクションにアクセスして、使用可能なプロバイダーの一覧を取得できます。You can specify any provider that is configured for your site to provide the site map data to the SiteMapDataSource and can obtain the list of available providers by accessing the SiteMap.Providers collection.

すべてのデータソースコントロールと同様に、のSiteMapDataSourceすべてのインスタンスは、データソースビューと呼ばれる単一のヘルパーオブジェクトに関連付けられます。Like all data source controls, every instance of a SiteMapDataSource is associated with a single helper object, known as a data source view. は、データソースのプロパティに従ってサイトマップデータのビューであり、 GetHierarchicalViewメソッドを呼び出すことによって取得されます。 SiteMapDataSourceViewThe SiteMapDataSourceView is a view on the site map data, according to the properties of the data source, and is retrieved by calling the GetHierarchicalView method. SiteMapDataSourceView 、コントロールSiteMapNodeCollectionのバインド先のオブジェクトを保持します。The SiteMapDataSourceView maintains the SiteMapNodeCollection object that the controls bind to.

既定では、開始ノードは階層のルートノードですが、開始ノードを任意のノードに設定できます。By default, the starting node is the root node of the hierarchy, but you can set the starting node to any node. 開始点は、サイトマップ内の現在位置または絶対位置を基準としたノードにすることができます。The starting point can be a node that is relative to the current position in the site map or to an absolute position. 開始ノードを指定するには、 StartingNodeUrlプロパティを設定します。You can specify the starting node by setting the StartingNodeUrl property.

SiteMapDataSource 、ナビゲーションデータに特化しており、並べ替え、フィルター処理、ページング、キャッシュ、更新、挿入、削除などのデータレコード操作などの一般的なデータソース操作をサポートしていません。The SiteMapDataSource is specialized for navigation data, and does not support common data source operations such as sorting, filtering, paging, caching, or data record operations such as updates, insertions or deletions.

宣言型の構文Declarative Syntax

<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() SiteMapDataSource() SiteMapDataSource()

SiteMapDataSource クラスの新しいインスタンスを初期化します。Initializes a new instance of the SiteMapDataSource class.

プロパティ

Adapter Adapter Adapter Adapter

コントロール用のブラウザー固有のアダプターを取得します。Gets the browser-specific adapter for the control.

(Inherited from Control)
AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory

このコントロールが含まれている Page オブジェクトまたは UserControl オブジェクトのアプリケーション相対の仮想ディレクトリを取得または設定します。Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

(Inherited from Control)
BindingContainer BindingContainer BindingContainer BindingContainer

このコントロールのデータ バインディングを格納しているコントロールを取得します。Gets the control that contains this control's data binding.

(Inherited from Control)
ChildControlsCreated ChildControlsCreated ChildControlsCreated ChildControlsCreated

サーバー コントロールの子コントロールが作成されたかどうかを示す値を取得します。Gets a value that indicates whether the server control's child controls have been created.

(Inherited from Control)
ClientID ClientID ClientID ClientID

ASP.NET によって生成されたサーバー コントロール ID を取得します。Gets the server control identifier generated by ASP.NET.

(Inherited from HierarchicalDataSourceControl)
ClientIDMode ClientIDMode ClientIDMode ClientIDMode

このプロパティは、データ ソース コントロールでは使用されません。This property is not used for data source controls.

(Inherited from HierarchicalDataSourceControl)
ClientIDSeparator ClientIDSeparator ClientIDSeparator ClientIDSeparator

ClientID プロパティで使用される区切り記号を表す文字値を取得します。Gets a character value representing the separator character used in the ClientID property.

(Inherited from Control)
ContainsListCollection ContainsListCollection ContainsListCollection ContainsListCollection

データ ソース コントロールがデータ ソース ビュー オブジェクトのコレクションを格納しているかどうかを示す値を取得します。Gets a value indicating whether the data source control contains a collection of data source view objects.

Context Context Context Context

現在の Web 要求に対するサーバー コントロールに関連付けられている HttpContext オブジェクトを取得します。Gets the HttpContext object associated with the server control for the current Web request.

(Inherited from Control)
Controls Controls Controls Controls

UI 階層内の指定されたサーバー コントロールの子コントロールを表す ControlCollection オブジェクトを取得します。Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

(Inherited from HierarchicalDataSourceControl)
DataItemContainer DataItemContainer DataItemContainer DataItemContainer

名前付けコンテナーが IDataItemContainer を実装している場合、名前付けコンテナーへの参照を取得します。Gets a reference to the naming container if the naming container implements IDataItemContainer.

(Inherited from Control)
DataKeysContainer DataKeysContainer DataKeysContainer DataKeysContainer

名前付けコンテナーが IDataKeysControl を実装している場合、名前付けコンテナーへの参照を取得します。Gets a reference to the naming container if the naming container implements IDataKeysControl.

(Inherited from Control)
DesignMode DesignMode DesignMode DesignMode

コントロールがデザイン サーフェイスで使用されているかどうかを示す値を取得します。Gets a value indicating whether a control is being used on a design surface.

(Inherited from Control)
EnableTheming EnableTheming EnableTheming EnableTheming

このコントロールがテーマをサポートしているかどうかを示す値を取得します。Gets a value indicating whether this control supports themes.

(Inherited from HierarchicalDataSourceControl)
EnableViewState EnableViewState EnableViewState EnableViewState

要求元クライアントに対して、サーバー コントロールがそのビュー状態と、そこに含まれる任意の子のコントロールのビュー状態を保持するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.

(Inherited from Control)
Events Events Events Events

コントロールのイベント ハンドラー デリゲートのリストを取得します。Gets a list of event handler delegates for the control. このプロパティは読み取り専用です。This property is read-only.

(Inherited from Control)
HasChildViewState HasChildViewState HasChildViewState HasChildViewState

現在のサーバー コントロールの子コントロールが、保存されたビューステートの設定を持っているかどうかを示す値を取得します。Gets a value indicating whether the current server control's child controls have any saved view-state settings.

(Inherited from Control)
IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder

このメンバーの詳細については、「ControlBuilder」をご覧ください。For a description of this member, see ControlBuilder.

(Inherited from Control)
IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData

このメンバーの詳細については、「UserData」をご覧ください。For a description of this member, see UserData.

(Inherited from Control)
ID ID ID ID

サーバー コントロールに割り当てられたプログラム ID を取得または設定します。Gets or sets the programmatic identifier assigned to the server control.

(Inherited from Control)
IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings

このメンバーの詳細については、「DataBindings」をご覧ください。For a description of this member, see DataBindings.

(Inherited from Control)
IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings

このメンバーの詳細については、「HasDataBindings」をご覧ください。For a description of this member, see HasDataBindings.

(Inherited from Control)
IdSeparator IdSeparator IdSeparator IdSeparator

コントロール ID を区別するために使用する文字を取得します。Gets the character used to separate control identifiers.

(Inherited from Control)
IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions

このメンバーの詳細については、「Expressions」をご覧ください。For a description of this member, see Expressions.

(Inherited from Control)
IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions

このメンバーの詳細については、「HasExpressions」をご覧ください。For a description of this member, see HasExpressions.

(Inherited from Control)
IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared

このコントロールに含まれているコントロールに、コントロールの状態が設定されているかどうかを示す値を取得します。Gets a value indicating whether controls contained within this control have control state.

(Inherited from Control)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

サーバー コントロールがビューステートの変更を保存しているかどうかを示す値を取得します。Gets a value that indicates whether the server control is saving changes to its view state.

(Inherited from Control)
IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled

このコントロールでビューステートが有効かどうかを示す値を取得します。Gets a value indicating whether view state is enabled for this control.

(Inherited from Control)
LoadViewStateByID LoadViewStateByID LoadViewStateByID LoadViewStateByID

コントロールがインデックスではなく ID によりビューステートの読み込みを行うかどうかを示す値を取得します。Gets a value indicating whether the control participates in loading its view state by ID instead of index.

(Inherited from Control)
NamingContainer NamingContainer NamingContainer NamingContainer

同じ ID プロパティ値を持つ複数のサーバー コントロールを区別するための一意の名前空間を作成する、サーバー コントロールの名前付けコンテナーへの参照を取得します。Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.

(Inherited from Control)
Page Page Page Page

サーバー コントロールを含んでいる Page インスタンスへの参照を取得します。Gets a reference to the Page instance that contains the server control.

(Inherited from Control)
Parent Parent Parent Parent

ページ コントロールの階層構造における、サーバー コントロールの親コントロールへの参照を取得します。Gets a reference to the server control's parent control in the page control hierarchy.

(Inherited from Control)
Provider Provider Provider Provider

データ ソース コントロールに関連付けられている SiteMapProvider オブジェクトを取得または設定します。Gets or sets a SiteMapProvider object that is associated with the data source control.

RenderingCompatibility RenderingCompatibility RenderingCompatibility RenderingCompatibility

レンダリングされる HTML と互換性がある ASP.NET のバージョンを表す値を取得します。Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

(Inherited from Control)
ShowStartingNode ShowStartingNode ShowStartingNode ShowStartingNode

開始ノードが取得されて表示されるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the starting node is retrieved and displayed.

Site Site Site Site

デザイン サーフェイスに現在のコントロールを表示するときに、このコントロールをホストするコンテナーに関する情報を取得します。Gets information about the container that hosts the current control when rendered on a design surface.

(Inherited from Control)
SiteMapProvider SiteMapProvider SiteMapProvider SiteMapProvider

データ ソースのバインド先のサイト マップ プロバイダーの名前を取得または設定します。Gets or sets the name of the site map provider that the data source binds to.

SkinID SkinID SkinID SkinID

HierarchicalDataSourceControl コントロールに適用するスキンを取得または設定します。Gets or sets the skin to apply to the HierarchicalDataSourceControl control.

(Inherited from HierarchicalDataSourceControl)
StartFromCurrentNode StartFromCurrentNode StartFromCurrentNode StartFromCurrentNode

サイト マップのノード ツリーが現在のページを表すノードを使用して取得されるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the site map node tree is retrieved using the node that represents the current page.

StartingNodeOffset StartingNodeOffset StartingNodeOffset StartingNodeOffset

データ ソース コントロールによって公開されるルート階層を決定する、開始ノードからの正または負の整数のオフセットを取得または設定します。Gets or sets a positive or negative integer offset from the starting node that determines the root hierarchy that is exposed by the data source control.

StartingNodeUrl StartingNodeUrl StartingNodeUrl StartingNodeUrl

データ ソースが階層サイト マップからノードを取得するための参照ポイントとして使用する、サイト マップ内のノードを取得または設定します。Gets or sets a node in the site map that the data source then uses as a reference point to retrieve nodes from a hierarchical site map.

TemplateControl TemplateControl TemplateControl TemplateControl

このコントロールを格納しているテンプレートへの参照を取得または設定します。Gets or sets a reference to the template that contains this control.

(Inherited from Control)
TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory

現在のサーバー コントロールを格納している Page または UserControl の仮想ディレクトリを取得します。Gets the virtual directory of the Page or UserControl that contains the current server control.

(Inherited from Control)
UniqueID UniqueID UniqueID UniqueID

階層構造で修飾されたサーバー コントロールの一意の ID を取得します。Gets the unique, hierarchically qualified identifier for the server control.

(Inherited from Control)
ValidateRequestMode ValidateRequestMode ValidateRequestMode ValidateRequestMode

ブラウザーからのクライアント入力の安全性をコントロールで調べるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.

(Inherited from Control)
ViewState ViewState ViewState ViewState

同一のページに対する複数の要求にわたって、サーバー コントロールのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

(Inherited from Control)
ViewStateIgnoresCase ViewStateIgnoresCase ViewStateIgnoresCase ViewStateIgnoresCase

StateBag オブジェクトが大文字小文字を区別しないかどうかを示す値を取得します。Gets a value that indicates whether the StateBag object is case-insensitive.

(Inherited from Control)
ViewStateMode ViewStateMode ViewStateMode ViewStateMode

このコントロールのビューステート モードを取得または設定します。Gets or sets the view-state mode of this control.

(Inherited from Control)
Visible Visible Visible Visible

コントロールが視覚的に表示されているかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the control is visually displayed.

(Inherited from HierarchicalDataSourceControl)

メソッド

AddedControl(Control, Int32) AddedControl(Control, Int32) AddedControl(Control, Int32) AddedControl(Control, Int32)

子コントロールが Control オブジェクトの Controls コレクションに追加された後に呼び出されます。Called after a child control is added to the Controls collection of the Control object.

(Inherited from Control)
AddParsedSubObject(Object) AddParsedSubObject(Object) AddParsedSubObject(Object) AddParsedSubObject(Object)

XML または HTML のいずれかの要素が解析されたことをサーバー コントロールに通知し、サーバー コントロールの ControlCollection オブジェクトに要素を追加します。Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

(Inherited from Control)
ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page)

ページのスタイル シートに定義されたスタイル プロパティをコントロールに適用します。Applies the style properties that are defined in the page style sheet to the control.

(Inherited from HierarchicalDataSourceControl)
BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object)

レンダリング データのデザイン時のトレースを開始します。Begins design-time tracing of rendering data.

(Inherited from Control)
BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean)

ページのトレースが有効な場合、サーバー コントロールに関する情報を収集し、これを表示するために Trace プロパティに渡します。Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.

(Inherited from Control)
ClearCachedClientID() ClearCachedClientID() ClearCachedClientID() ClearCachedClientID()

キャッシュされた ClientID 値を null に設定します。Sets the cached ClientID value to null.

(Inherited from Control)
ClearChildControlState() ClearChildControlState() ClearChildControlState() ClearChildControlState()

サーバー コントロールのすべての子コントロールについて、コントロールの状態情報を削除します。Deletes the control-state information for the server control's child controls.

(Inherited from Control)
ClearChildState() ClearChildState() ClearChildState() ClearChildState()

サーバー コントロールのすべての子コントロールのビューステート情報およびコントロールの状態情報を削除します。Deletes the view-state and control-state information for all the server control's child controls.

(Inherited from Control)
ClearChildViewState() ClearChildViewState() ClearChildViewState() ClearChildViewState()

サーバー コントロールのすべての子コントロールのビューステート情報を削除します。Deletes the view-state information for all the server control's child controls.

(Inherited from Control)
ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode()

現在のコントロール インスタンスおよびすべての子コントロールの ClientIDMode プロパティを Inherit に設定します。Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

(Inherited from Control)
CreateChildControls() CreateChildControls() CreateChildControls() CreateChildControls()

ASP.NET ページ フレームワークによって呼び出され、ポストバックまたはレンダリングの準備として、合成ベースの実装を使うサーバー コントロールに対し、それらのコントロールに含まれる子コントロールを作成するように通知します。Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.

(Inherited from Control)
CreateControlCollection() CreateControlCollection() CreateControlCollection() CreateControlCollection()

サーバー コントロールの子コントロール (リテラルとサーバーの両方) を保持する新しい ControlCollection オブジェクトを作成します。Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

(Inherited from HierarchicalDataSourceControl)
DataBind() DataBind() DataBind() DataBind()

呼び出されたサーバー コントロールと、そのすべての子コントロールにデータ ソースをバインドします。Binds a data source to the invoked server control and all its child controls.

(Inherited from Control)
DataBind(Boolean) DataBind(Boolean) DataBind(Boolean) DataBind(Boolean)

DataBinding イベントを発生させるオプションを指定して、呼び出されたサーバー コントロールとそのすべての子コントロールにデータ ソースをバインドします。Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.

(Inherited from Control)
DataBindChildren() DataBindChildren() DataBindChildren() DataBindChildren()

データ ソースをサーバー コントロールの子コントロールにバインドします。Binds a data source to the server control's child controls.

(Inherited from Control)
Dispose() Dispose() Dispose() Dispose()

サーバー コントロールが、メモリから解放される前に最終的なクリーンアップを実行できるようにします。Enables a server control to perform final clean up before it is released from memory.

(Inherited from Control)
EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object)

レンダリング データのデザイン時のトレースを終了します。Ends design-time tracing of rendering data.

(Inherited from Control)
EnsureChildControls() EnsureChildControls() EnsureChildControls() EnsureChildControls()

サーバー コントロールに子コントロールが含まれているかどうかを確認します。Determines whether the server control contains child controls. 含まれていない場合、子コントロールを作成します。If it does not, it creates child controls.

(Inherited from Control)
EnsureID() EnsureID() EnsureID() EnsureID()

ID が割り当てられていないコントロールの ID を作成します。Creates an identifier for controls that do not have an identifier assigned.

(Inherited from Control)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindControl(String) FindControl(String) FindControl(String) FindControl(String)

指定した id パラメーターを使用して、サーバー コントロールの現在の名前付けコンテナーを検索します。Searches the current naming container for a server control with the specified id parameter.

(Inherited from HierarchicalDataSourceControl)
FindControl(String, Int32) FindControl(String, Int32) FindControl(String, Int32) FindControl(String, Int32)

指定した id および検索に役立つ pathOffset パラメーターに指定された整数を使用して、サーバー コントロールの現在の名前付けコンテナーを検索します。Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. この形式の FindControl メソッドはオーバーライドしないでください。You should not override this version of the FindControl method.

(Inherited from Control)
Focus() Focus() Focus() Focus()

コントロールに入力フォーカスを設定します。Sets input focus to the control.

(Inherited from HierarchicalDataSourceControl)
GetDesignModeState() GetDesignModeState() GetDesignModeState() GetDesignModeState()

コントロールのデザイン時データを取得します。Gets design-time data for a control.

(Inherited from Control)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetHierarchicalView(String) GetHierarchicalView(String) GetHierarchicalView(String) GetHierarchicalView(String)

データ ソースの開始ノードおよびその他のプロパティに従って、SiteMapProvider オブジェクトのサイト マップ データの単一ビューを取得します。Retrieves a single view on the site map data for the SiteMapProvider object according to the starting node and other properties of the data source.

GetList() GetList() GetList() GetList()

データのリストのソースとして使用できるデータ ソース コントロールのリストを取得します。Retrieves a list of data source controls that can be used as sources of lists of data.

GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object)

ルート パラメーターのセットに対応する URL を取得します。Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary)

ルート パラメーターのセットに対応する URL を取得します。Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object)

ルート パラメーターのセットおよびルート名に対応する URL を取得します。Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary)

ルート パラメーターのセットおよびルート名に対応する URL を取得します。Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control)

指定されたコントロールの UniqueID プロパティのプレフィックス部分を返します。Returns the prefixed portion of the UniqueID property of the specified control.

(Inherited from Control)
GetView(String) GetView(String) GetView(String) GetView(String)

データ ソースの開始ノードおよびその他のプロパティに従って、サイト マップ プロバイダーのサイト マップ データの名前付きビューを取得します。Retrieves a named view on the site map data of the site map provider according to the starting node and other properties of the data source.

GetViewNames() GetViewNames() GetViewNames() GetViewNames()

データ ソース コントロールの名前付きビューのコレクションを取得します。Retrieves a collection of named views for the data source control.

HasControls() HasControls() HasControls() HasControls()

サーバー コントロールに子コントロールが含まれているかどうかを確認します。Determines if the server control contains any child controls.

(Inherited from HierarchicalDataSourceControl)
HasEvents() HasEvents() HasEvents() HasEvents()

コントロールまたは子コントロールに対してイベントが登録されているかどうかを示す値を返します。Returns a value indicating whether events are registered for the control or any child controls.

(Inherited from Control)
IsLiteralContent() IsLiteralContent() IsLiteralContent() IsLiteralContent()

サーバー コントロールがリテラルな内容だけを保持しているかどうかを決定します。Determines if the server control holds only literal content.

(Inherited from Control)
LoadControlState(Object) LoadControlState(Object) LoadControlState(Object) LoadControlState(Object)

SaveControlState() メソッドによって保存された前回のページ要求からコントロールの状態情報を復元します。Restores control-state information from a previous page request that was saved by the SaveControlState() method.

(Inherited from Control)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

SaveViewState() メソッドによって保存された前回のページ要求からビューステート情報を復元します。Restores view-state information from a previous page request that was saved by the SaveViewState() method.

(Inherited from Control)
MapPathSecure(String) MapPathSecure(String) MapPathSecure(String) MapPathSecure(String)

仮想パス (絶対パスまたは相対パス) の割り当て先の物理パスを取得します。Retrieves the physical path that a virtual path, either absolute or relative, maps to.

(Inherited from Control)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs)

サーバー コントロールのイベントをページの UI サーバー コントロールの階層構造に渡すかどうかを決定します。Determines whether the event for the server control is passed up the page's UI server control hierarchy.

(Inherited from Control)
OnDataBinding(EventArgs) OnDataBinding(EventArgs) OnDataBinding(EventArgs) OnDataBinding(EventArgs)

DataBinding イベントを発生させます。Raises the DataBinding event.

(Inherited from Control)
OnDataSourceChanged(EventArgs) OnDataSourceChanged(EventArgs) OnDataSourceChanged(EventArgs) OnDataSourceChanged(EventArgs)

DataSourceChanged イベントを発生させます。Raises the DataSourceChanged event.

(Inherited from HierarchicalDataSourceControl)
OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs)

Init イベントを発生させます。Raises the Init event.

(Inherited from Control)
OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs)

Load イベントを発生させます。Raises the Load event.

(Inherited from Control)
OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs)

PreRender イベントを発生させます。Raises the PreRender event.

(Inherited from Control)
OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs)

Unload イベントを発生させます。Raises the Unload event.

(Inherited from Control)
OpenFile(String) OpenFile(String) OpenFile(String) OpenFile(String)

ファイルの読み込みで使用される Stream を取得します。Gets a Stream used to read a file.

(Inherited from Control)
RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs)

イベントのソースおよびその情報をコントロールの親に割り当てます。Assigns any sources of the event and its information to the control's parent.

(Inherited from Control)
RemovedControl(Control) RemovedControl(Control) RemovedControl(Control) RemovedControl(Control)

Control オブジェクトの Controls コレクションから子コントロールが削除された後に呼び出されます。Called after a child control is removed from the Controls collection of the Control object.

(Inherited from Control)
Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter)

提供されたクライアントに表示される内容を書き込む HtmlTextWriter オブジェクトに、サーバー コントロールの内容を送信します。Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(Inherited from Control)
RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter)

クライアントに表示される内容の書き込みを行う、指定された HtmlTextWriter オブジェクトに、サーバー コントロールの子を出力します。Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(Inherited from Control)
RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter)

指定の HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力し、トレースが有効である場合はコントロールに関するトレース情報を保存します。Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

(Inherited from HierarchicalDataSourceControl)
RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter)

指定した ControlAdapter オブジェクトを使用して、指定した HtmlTextWriter オブジェクトにサーバー コントロールの内容を出力します。Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

(Inherited from Control)
ResolveAdapter() ResolveAdapter() ResolveAdapter() ResolveAdapter()

指定したコントロールを表示するコントロール アダプターを取得します。Gets the control adapter responsible for rendering the specified control.

(Inherited from Control)
ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String)

ブラウザーで使用できる URL を取得します。Gets a URL that can be used by the browser.

(Inherited from Control)
ResolveUrl(String) ResolveUrl(String) ResolveUrl(String) ResolveUrl(String)

要求側クライアントで使用できる URL に変換します。Converts a URL into one that is usable on the requesting client.

(Inherited from Control)
SaveControlState() SaveControlState() SaveControlState() SaveControlState()

ページがサーバーにポスト バックされた時間以降に発生したすべてのサーバー コントロール状態の変化を保存します。Saves any server control state changes that have occurred since the time the page was posted back to the server.

(Inherited from Control)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

ページがサーバーにポスト バックされた時間以降に発生した、サーバー コントロールのビューステートの変更を保存します。Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

(Inherited from Control)
SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary)

コントロールのデザイン時データを設定します。Sets design-time data for a control.

(Inherited from Control)
SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod)

サーバー コントロールとその内容を親コントロールに表示するイベント ハンドラー デリゲートを割り当てます。Assigns an event handler delegate to render the server control and its content into its parent control.

(Inherited from Control)
SetTraceData(Object, Object) SetTraceData(Object, Object) SetTraceData(Object, Object) SetTraceData(Object, Object)

トレース データ キーとトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.

(Inherited from Control)
SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object)

トレースされたオブジェクト、トレース データ キー、およびトレース データ値を使用して、レンダリング データのデザイン時トレースのトレース データを設定します。Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.

(Inherited from Control)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

サーバー コントロールにビューステートの変更を追跡させ、サーバー コントロールの StateBag オブジェクトに変更を格納できるようにします。Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. このオブジェクトは、ViewState プロパティによってアクセスできます。This object is accessible through the ViewState property.

(Inherited from Control)

明示的なインターフェイスの実装

IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState()

このメンバーの詳細については、「GetDesignModeState()」をご覧ください。For a description of this member, see GetDesignModeState().

(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary)

このメンバーの説明については、SetDesignModeState(IDictionary) のトピックを参照してください。For a description of this member, see SetDesignModeState(IDictionary).

(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control)

このメンバーの説明については、SetOwnerControl(Control) のトピックを参照してください。For a description of this member, see SetOwnerControl(Control).

(Inherited from Control)
IDataSource.DataSourceChanged IDataSource.DataSourceChanged IDataSource.DataSourceChanged IDataSource.DataSourceChanged

データ バインド コントロールに影響を与える変更がデータ ソース コントロールに加えられたときに発生します。Occurs when a data source control has changed in some way that affects data-bound controls.

IDataSource.GetView(String) IDataSource.GetView(String) IDataSource.GetView(String) IDataSource.GetView(String)

このメンバーの詳細については、「GetView(String)」をご覧ください。For a description of this member, see GetView(String).

IDataSource.GetViewNames() IDataSource.GetViewNames() IDataSource.GetViewNames() IDataSource.GetViewNames()

このメンバーの詳細については、「GetViewNames()」をご覧ください。For a description of this member, see GetViewNames().

IHierarchicalDataSource.GetHierarchicalView(String) IHierarchicalDataSource.GetHierarchicalView(String) IHierarchicalDataSource.GetHierarchicalView(String) IHierarchicalDataSource.GetHierarchicalView(String)

IHierarchicalDataSource インターフェイスに対する、指定されたパスのビュー ヘルパー オブジェクトを取得します。Gets the view helper object for the IHierarchicalDataSource interface for the specified path.

(Inherited from HierarchicalDataSourceControl)
IListSource.ContainsListCollection IListSource.ContainsListCollection IListSource.ContainsListCollection IListSource.ContainsListCollection

コレクションが IList オブジェクトのコレクションかどうかを示す値を取得します。Gets a value that indicates whether the collection is a collection of IList objects.

IListSource.GetList() IListSource.GetList() IListSource.GetList() IListSource.GetList()

このメンバーの説明については、GetList() のトピックを参照してください。For a description of this member, see GetList().

IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object)

このメンバーの詳細については、「AddParsedSubObject(Object)」をご覧ください。For a description of this member, see AddParsedSubObject(Object).

(Inherited from Control)

イベント

DataBinding DataBinding DataBinding DataBinding

サーバー コントロールがデータ ソースに連結すると発生します。Occurs when the server control binds to a data source.

(Inherited from Control)
Disposed Disposed Disposed Disposed

サーバー コントロールがメモリから解放されると発生します。これは、ASP.NET ページが要求されている場合のサーバー コントロールの有効期間における最終段階です。Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

(Inherited from Control)
IHierarchicalDataSource.DataSourceChanged IHierarchicalDataSource.DataSourceChanged IHierarchicalDataSource.DataSourceChanged IHierarchicalDataSource.DataSourceChanged

データ バインド コントロールに影響を与える変更が HierarchicalDataSourceControl に加えられたときに発生します。Occurs when the HierarchicalDataSourceControl has changed in some way that affects data-bound controls.

(Inherited from HierarchicalDataSourceControl)
Init Init Init Init

サーバー コントロールが初期化されると発生します。これは、サーバー コントロールの有効期間における最初の手順です。Occurs when the server control is initialized, which is the first step in its lifecycle.

(Inherited from Control)
Load Load Load Load

サーバー コントロールが Page オブジェクトに読み込まれると発生します。Occurs when the server control is loaded into the Page object.

(Inherited from Control)
PreRender PreRender PreRender PreRender

Control オブジェクトの読み込み後、表示を開始する前に発生します。Occurs after the Control object is loaded but prior to rendering.

(Inherited from Control)
Unload Unload Unload Unload

サーバー コントロールがメモリからアンロードされると発生します。Occurs when the server control is unloaded from memory.

(Inherited from Control)

拡張メソッド

FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control)

指定されたコントロールのデータ コントロールに関連付けられているデータ ソースを返します。Returns the data source that is associated with the data control for the specified control.

FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String)

指定されたコントロールの名前付けコンテナー内にある、指定された列のフィールド テンプレートを返します。Returns the field template for the specified column in the specified control's naming container.

FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control)

格納しているデータ コントロールのメタテーブル オブジェクトを返します。Returns the metatable object for the containing data control.

GetDefaultValues(IDataSource) GetDefaultValues(IDataSource) GetDefaultValues(IDataSource) GetDefaultValues(IDataSource)

指定されたデータ ソースの既定値のコレクションを取得します。Gets the collection of the default values for the specified data source.

GetMetaTable(IDataSource) GetMetaTable(IDataSource) GetMetaTable(IDataSource) GetMetaTable(IDataSource)

指定したデータ ソース オブジェクト内のテーブルのメタデータを取得します。Gets the metadata for a table in the specified data source object.

TryGetMetaTable(IDataSource, MetaTable) TryGetMetaTable(IDataSource, MetaTable) TryGetMetaTable(IDataSource, MetaTable) TryGetMetaTable(IDataSource, MetaTable)

テーブル メタデータが使用できるかどうかを判断します。Determines whether table metadata is available.

適用対象

こちらもご覧ください