This documentation is archived and is not being maintained.
SiteMapDataSource Members
Visual Studio 2008
Provides a data source control that Web server controls and other controls can use to bind to hierarchical site map data.
The SiteMapDataSource type exposes the following members.
| Name | Description | |
|---|---|---|
|
AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
|
AddParsedSubObject | 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 | Applies the style properties that are defined in the page style sheet to the control. (Inherited from HierarchicalDataSourceControl.) |
|
BuildProfileTree | Infrastructure. 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.) |
|
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
|
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
|
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
|
CreateChildControls | 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 | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from HierarchicalDataSourceControl.) |
|
DataBind | Overloaded. Binds a data source to the invoked server control and all its child controls. |
|
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
|
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
|
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
|
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
FindControl | Overloaded. Searches the current naming container for the specified server control. |
|
Focus | Sets input focus to the control. (Inherited from HierarchicalDataSourceControl.) |
|
GetDesignModeState | Infrastructure. Gets design-time data for a control. (Inherited from Control.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetHierarchicalView | 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. (Overrides HierarchicalDataSourceControl::GetHierarchicalView(String).) |
|
GetList | Retrieves a list of data source controls that can be used as sources of lists of data. |
|
GetType | Gets the type of the current instance. (Inherited from Object.) |
|
GetView | 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 | Retrieves a collection of named views for the data source control. |
|
HasControls | Determines if the server control contains any child controls. (Inherited from HierarchicalDataSourceControl.) |
|
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
|
IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
|
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) |
|
LoadViewState | Restores view-state information from a previous page request that was saved by the SaveViewState method. (Inherited from Control.) |
|
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) |
|
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) |
|
OnDataSourceChanged | Raises the DataSourceChanged event. (Inherited from HierarchicalDataSourceControl.) |
|
OnInit | Raises the Init event. (Inherited from Control.) |
|
OnLoad | Raises the Load event. (Inherited from Control.) |
|
OnPreRender | Raises the PreRender event. (Inherited from Control.) |
|
OnUnload | Raises the Unload event. (Inherited from Control.) |
|
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
|
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
|
RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
|
Render | Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) |
|
RenderChildren | 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 | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. |
|
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
|
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
|
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
|
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 | 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 | Sets design-time data for a control. (Inherited from Control.) |
|
SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TrackViewState | Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the Control::ViewState property. (Inherited from Control.) |
| Name | Description | |
|---|---|---|
|
FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
|
FindFieldTemplate | Returns the field template for the specified column within the specified control's naming container. (Defined by DynamicDataExtensions.) |
|
FindMetaTable | Returns the MetaTable object for the containing data control. (Defined by DynamicDataExtensions.) |
| Name | Description | |
|---|---|---|
|
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
|
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
|
BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
|
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
|
ClientID | Gets the server control identifier generated by ASP.NET. (Inherited from HierarchicalDataSourceControl.) |
|
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
|
ContainsListCollection | Gets a value indicating whether the data source control contains a collection of data source view objects. |
|
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
|
Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from HierarchicalDataSourceControl.) |
|
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
|
EnableTheming | Gets a value indicating whether this control supports themes. (Inherited from HierarchicalDataSourceControl.) |
|
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 | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
|
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
|
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
|
IdSeparator | Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.) |
|
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
|
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
|
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
|
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
|
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control::ID property value. (Inherited from Control.) |
|
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
|
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
|
Provider | Gets or sets a SiteMapProvider object that is associated with the data source control. |
|
ShowStartingNode | Gets or sets a value indicating whether the starting node is retrieved and displayed. |
|
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
|
SiteMapProvider | Gets or sets the name of the site map provider that the data source binds to. |
|
SkinID | Gets or sets the skin to apply to the HierarchicalDataSourceControl control. (Inherited from HierarchicalDataSourceControl.) |
|
StartFromCurrentNode | Gets or sets a value indicating whether the site map node tree is retrieved using the node that represents the current page. |
|
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 | 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 | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
|
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
|
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
|
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 | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
|
Visible | Gets or sets a value indicating whether the control is visually displayed. (Inherited from HierarchicalDataSourceControl.) |
| Name | Description | |
|---|---|---|
|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
|
Disposed | 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.) |
|
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
|
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
|
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
|
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
| Name | Description | |
|---|---|---|
|
IParserAccessor::AddParsedSubObject | For a description of this member, see IParserAccessor::AddParsedSubObject. (Inherited from Control.) |
|
IListSource::ContainsListCollection | Infrastructure. Gets a value that indicates whether the collection is a collection of IList objects. |
|
IControlBuilderAccessor::ControlBuilder | For a description of this member, see IControlBuilderAccessor::ControlBuilder. (Inherited from Control.) |
|
IDataBindingsAccessor::DataBindings | For a description of this member, see IDataBindingsAccessor::DataBindings. (Inherited from Control.) |
|
IHierarchicalDataSource::DataSourceChanged | Infrastructure. Occurs when the HierarchicalDataSourceControl has changed in some way that affects data-bound controls. (Inherited from HierarchicalDataSourceControl.) |
|
IDataSource::DataSourceChanged | Infrastructure. Occurs when a data source control has changed in some way that affects data-bound controls. |
|
IExpressionsAccessor::Expressions | For a description of this member, see IExpressionsAccessor::Expressions. (Inherited from Control.) |
|
IControlDesignerAccessor::GetDesignModeState | For a description of this member, see IControlDesignerAccessor::GetDesignModeState. (Inherited from Control.) |
|
IHierarchicalDataSource::GetHierarchicalView | Infrastructure. Gets the view helper object for the IHierarchicalDataSource interface for the specified path. (Inherited from HierarchicalDataSourceControl.) |
|
IListSource::GetList | Infrastructure. For a description of this member, see GetList. |
|
IDataSource::GetView | Infrastructure. For a description of this member, see GetView. |
|
IDataSource::GetViewNames | Infrastructure. For a description of this member, see GetViewNames. |
|
IDataBindingsAccessor::HasDataBindings | For a description of this member, see IDataBindingsAccessor::HasDataBindings. (Inherited from Control.) |
|
IExpressionsAccessor::HasExpressions | For a description of this member, see IExpressionsAccessor::HasExpressions. (Inherited from Control.) |
|
IControlDesignerAccessor::SetDesignModeState | For a description of this member, see IControlDesignerAccessor::SetDesignModeState. (Inherited from Control.) |
|
IControlDesignerAccessor::SetOwnerControl | Infrastructure. For a description of this member, see IControlDesignerAccessor::SetOwnerControl. (Inherited from Control.) |
|
IControlDesignerAccessor::UserData | For a description of this member, see IControlDesignerAccessor::UserData. (Inherited from Control.) |
Show: