Back to Devexpress

ASPxSiteMapDataSource Methods

aspnet-devexpress-dot-web-dot-aspxsitemapdatasource-dot-underscore-methods.md

latest29.8 KB
Original Source

ASPxSiteMapDataSource Methods

Represents a data source control that can be used to bind web server controls to the hierarchical site map data.

NameDescription
AddedControl(Control, Int32) protectedCalled after a child control is added to the Controls collection of the Control object. Inherited from Control.
AddParsedSubObject(Object) protectedNotifies 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) protectedBegins design-time tracing of rendering data. Inherited from Control.
BuildProfileTree(String, Boolean) protectedGathers 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() protectedSets the cached ClientID value to null. Inherited from Control.
ClearChildControlState() protectedDeletes the control-state information for the server control’s child controls. Inherited from Control.
ClearChildState() protectedDeletes the view-state and control-state information for all the server control’s child controls. Inherited from Control.
ClearChildViewState() protectedDeletes the view-state information for all the server control’s child controls. Inherited from Control.
ClearEffectiveClientIDMode() protectedSets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control.
CreateChildControls() protectedCalled 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() protectedCreates 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) protectedBinds 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() protectedBinds 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) protectedEnds design-time tracing of rendering data. Inherited from Control.
EnsureChildControls() protectedDetermines whether the server control contains child controls. If it does not, it creates child controls. Inherited from Control.
EnsureID() protectedCreates an identifier for controls that do not have an identifier assigned. Inherited from Control.
Equals(Object, Object) staticDetermines 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) protectedSearches 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() protectedGets 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() protectedReturns a value indicating whether events are registered for the control or any child controls. Inherited from Control.
IsLiteralContent() protectedDetermines if the server control holds only literal content. Inherited from Control.
LoadControlState(Object) protectedRestores 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) protectedRestores view-state information from a previous page request that was saved by the SaveViewState() method. Inherited from Control.
MapPathSecure(String) protectedRetrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
OnBubbleEvent(Object, EventArgs) protectedDetermines whether the event for the server control is passed up the page’s UI server control hierarchy. Inherited from Control.
OnDataBinding(EventArgs) protectedRaises the DataBinding event. Inherited from Control.
OnInit(EventArgs) protectedRaises the Init event. Inherited from Control.
OnLoad(EventArgs) protectedRaises the Load event. Inherited from Control.
OnPreRender(EventArgs) protectedRaises the PreRender event. Inherited from Control.
OnUnload(EventArgs) protectedRaises the Unload event. Inherited from Control.
OpenFile(String) protectedGets a Stream used to read a file. Inherited from Control.
RaiseBubbleEvent(Object, EventArgs) protectedAssigns any sources of the event and its information to the control’s parent. Inherited from Control.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RemovedControl(Control) protectedCalled after a child control is removed from the Controls collection of the Control object. Inherited from Control.
Render(HtmlTextWriter) protectedSends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control.
RenderChildren(HtmlTextWriter) protectedOutputs 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) protectedOutputs 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() protectedGets 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() protectedSaves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control.
SaveViewState() protectedSaves 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) protectedSets 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() protectedCauses 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.

See Also

ASPxSiteMapDataSource Class

ASPxSiteMapDataSource Members

DevExpress.Web Namespace