ASPxSiteMapDataSource Members
Represents a data source control that can be used to bind web server controls to the hierarchical site map data.Constructors
| Name | Description |
|---|---|
| ASPxSiteMapDataSource() | Initializes a new instance of the ASPxSiteMapDataSource class. |
Properties
| Name | Description |
|---|---|
| Adapter protected | 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 | Gets the control that contains this control’s data binding. Inherited from Control. |
| ChildControlsCreated protected | 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. |
| ClientIDMode | This property is not used for data source controls. Inherited from HierarchicalDataSourceControl. |
| ClientIDSeparator protected | 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. Inherited from SiteMapDataSource. |
| Context protected | 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. |
| DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control. |
| DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control. |
| DesignMode protected | Gets a value indicating whether a control is being used on a design surface. Inherited from Control. |
| EnableRoles | Gets or sets a value indicating whether the ASP.NET role management feature is enabled. |
| 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 protected | Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control. |
| HasChildViewState protected | 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 protected | Gets the character used to separate control identifiers. Inherited from Control. |
| IsChildControlStateCleared protected | Gets a value indicating whether controls contained within this control have control state. Inherited from Control. |
| IsTrackingViewState protected | Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control. |
| IsViewStateEnabled protected | Gets a value indicating whether view state is enabled for this control. Inherited from Control. |
| LoadViewStateByID protected | 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 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 site map provider object associated with the data source control. |
| RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from 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. |
| SiteMapFileName | Gets or sets the path to the file that contains the site map data. |
| 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. Inherited from SiteMapDataSource. |
| 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. Inherited from SiteMapDataSource. |
| 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. |
| IListSource.ContainsListCollection | Gets a value that indicates whether the collection is a collection of IList objects. Inherited from SiteMapDataSource. |
| IControlBuilderAccessor.ControlBuilder | For a description of this member, see ControlBuilder. Inherited from Control. |
| IControlDesignerAccessor.UserData | For a description of this member, see UserData. Inherited from Control. |
| IDataBindingsAccessor.DataBindings | For a description of this member, see DataBindings. Inherited from Control. |
| IDataBindingsAccessor.HasDataBindings | For a description of this member, see HasDataBindings. Inherited from Control. |
| IExpressionsAccessor.Expressions | For a description of this member, see Expressions. Inherited from Control. |
| IExpressionsAccessor.HasExpressions | For a description of this member, see HasExpressions. Inherited from Control. |
| 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. |
| 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 protected | 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 protected | Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control. |
| ViewStateMode | Gets or sets the view-state mode of this control. Inherited from Control. |
| Visible | Gets or sets a value indicating whether the control is visually displayed. Inherited from HierarchicalDataSourceControl. |
Methods
| Name | Description |
|---|---|
| AddedControl(Control, Int32) protected | Called after a child control is added to the Controls collection of the Control object. Inherited from Control. |
| AddParsedSubObject(Object) protected | 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) | Applies the style properties that are defined in the page style sheet to the control. Inherited from HierarchicalDataSourceControl. |
| BeginRenderTracing(TextWriter, Object) protected | Begins design-time tracing of rendering data. Inherited from Control. |
| BuildProfileTree(String, Boolean) protected | 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() protected |
Sets the cached ClientID value to null.
Inherited from Control. |
| ClearChildControlState() protected | Deletes the control-state information for the server control’s child controls. Inherited from Control. |
| ClearChildState() protected | Deletes the view-state and control-state information for all the server control’s child controls. Inherited from Control. |
| ClearChildViewState() protected | Deletes the view-state information for all the server control’s child controls. Inherited from Control. |
| ClearEffectiveClientIDMode() protected | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control. |
| CreateChildControls() protected | 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() protected | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from HierarchicalDataSourceControl. |
| DataBind() | Binds a data source to the invoked server control and all its child controls. Inherited from Control. |
| DataBind(Boolean) protected | 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() protected | 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. |
| EndRenderTracing(TextWriter, Object) protected | Ends design-time tracing of rendering data. Inherited from Control. |
| EnsureChildControls() protected | Determines whether the server control contains child controls. If it does not, it creates child controls. Inherited from Control. |
| EnsureID() protected | Creates an identifier for controls that do not have an identifier assigned. Inherited from Control. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FindControl(String, Int32) protected |
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. You should not override this version of the FindControl method.
Inherited from Control. |
| FindControl(String) |
Searches the current naming container for a server control with the specified id parameter.
Inherited from HierarchicalDataSourceControl. |
| Focus() | Sets input focus to the control. Inherited from HierarchicalDataSourceControl. |
| GetDesignModeState() protected | Gets design-time data for a control. Inherited from Control. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetList() | Retrieves a list of data source controls that can be used as sources of lists of data. Inherited from SiteMapDataSource. |
| GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. Inherited from Control. |
| GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control. |
| GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control. |
| GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. Inherited from Control. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GetUniqueIDRelativeTo(Control) | Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control. |
| GetView(String) | Returns a data list specified by name. For internal use only. |
| GetViewNames() | Retrieves a collection of named views for the data source control. Inherited from SiteMapDataSource. |
| HasControls() | Determines if the server control contains any child controls. Inherited from HierarchicalDataSourceControl. |
| HasEvents() protected | Returns a value indicating whether events are registered for the control or any child controls. Inherited from Control. |
| IsLiteralContent() protected | Determines if the server control holds only literal content. Inherited from Control. |
| LoadControlState(Object) protected | Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control. |
| LoadFromFile(String) | Loads the site map data from the specified file into the current data source. |
| LoadViewState(Object) protected | Restores view-state information from a previous page request that was saved by the SaveViewState() method. Inherited from Control. |
| MapPathSecure(String) protected | Retrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| OnBubbleEvent(Object, EventArgs) protected | Determines whether the event for the server control is passed up the page’s UI server control hierarchy. Inherited from Control. |
| OnDataBinding(EventArgs) protected | Raises the DataBinding event. Inherited from Control. |
| OnInit(EventArgs) protected | Raises the Init event. Inherited from Control. |
| OnLoad(EventArgs) protected | Raises the Load event. Inherited from Control. |
| OnPreRender(EventArgs) protected | Raises the PreRender event. Inherited from Control. |
| OnUnload(EventArgs) protected | Raises the Unload event. Inherited from Control. |
| OpenFile(String) protected | Gets a Stream used to read a file. Inherited from Control. |
| RaiseBubbleEvent(Object, EventArgs) protected | Assigns any sources of the event and its information to the control’s parent. Inherited from Control. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RemovedControl(Control) protected | Called after a child control is removed from the Controls collection of the Control object. Inherited from Control. |
| Render(HtmlTextWriter) protected | Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control. |
| RenderChildren(HtmlTextWriter) protected | 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, ControlAdapter) protected | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control. |
| RenderControl(HtmlTextWriter) | Delivers the content of the control to a specified HtmlTextWriter object. This method is intended for internal use. |
| ResolveAdapter() protected | Gets the control adapter responsible for rendering the specified control. Inherited from Control. |
| ResolveClientUrl(String) | Gets a URL that can be used by the browser. Inherited from Control. |
| ResolveUrl(String) | Converts a URL into one that is usable on the requesting client. Inherited from Control. |
| SaveControlState() protected | Saves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control. |
| SaveViewState() protected | 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) protected | Sets design-time data for a control. Inherited from Control. |
| 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, 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. |
| 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. |
| IListSource.GetList() | For a description of this member, see GetList(). Inherited from SiteMapDataSource. |
| IControlDesignerAccessor.GetDesignModeState() | For a description of this member, see GetDesignModeState(). Inherited from Control. |
| IControlDesignerAccessor.SetDesignModeState(IDictionary) | For a description of this member, see SetDesignModeState(IDictionary). Inherited from Control. |
| IControlDesignerAccessor.SetOwnerControl(Control) | For a description of this member, see SetOwnerControl(Control). Inherited from Control. |
| IDataSource.GetView(String) | For a description of this member, see GetView(String). Inherited from SiteMapDataSource. |
| IDataSource.GetViewNames() | For a description of this member, see GetViewNames(). Inherited from SiteMapDataSource. |
| IHierarchicalDataSource.GetHierarchicalView(String) | Gets the view helper object for the IHierarchicalDataSource interface for the specified path. Inherited from HierarchicalDataSourceControl. |
| IParserAccessor.AddParsedSubObject(Object) | For a description of this member, see AddParsedSubObject(Object). Inherited from Control. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
| TrackViewState() protected | 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 ViewState property. Inherited from Control. |
Events
| 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. |
| IDataSource.DataSourceChanged | Occurs when a data source control has changed in some way that affects data-bound controls. Inherited from SiteMapDataSource. |
| IHierarchicalDataSource.DataSourceChanged | Occurs when the HierarchicalDataSourceControl has changed in some way that affects data-bound controls. Inherited from HierarchicalDataSourceControl. |
| Unload | Occurs when the server control is unloaded from memory. Inherited from Control. |
See Also