Skip to main content
Tab

ASPxSiteMapControl Members

Represents a site map control.

Constructors

Name Description
ASPxSiteMapControl() Initializes a new instance of the ASPxSiteMapControl class.

Properties

Name Description
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
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.
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
BackColor Gets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImage Gets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility static Provides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
Border Gets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottom Gets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeft Gets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRight Gets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTop Gets the settings of the web control’s top border. Inherited from ASPxWebControl.
Bound Gets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
Categorized Gets or sets a value that specifies whether the site map data is displayed categorized based on the top level nodes. Inherited from ASPxSiteMapControlBase.
ChildControlsCreated protected Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientID Gets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protected Gets a character value representing the separator character used in the ClientID property. Inherited from Control.
ColumnCount Gets or sets the number of columns displayed within the site map control. Inherited from ASPxSiteMapControlBase.
Columns Gets the collection of columns in the site map control. Inherited from ASPxSiteMapControlBase.
ColumnSeparatorStyle Gets an object responsible for the style settings of column separators. Inherited from ASPxSiteMapControlBase.
ColumnSeparatorTemplate Gets or sets a template used for displaying the content of all column separators within the site map control. Inherited from ASPxSiteMapControlBase.
ColumnStyle Gets the style settings for all columns within the site map control. Inherited from ASPxSiteMapControlBase.
Context protected Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
Controls Gets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl.
CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePath Gets or sets the path to a CSS file that defines the web control’s appearance. Inherited from ASPxWebControl.
CssPostfix Gets or sets a CSS class name postfix that identifies style settings to be applied to the control. Inherited from ASPxWebControl.
Cursor Gets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
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.
DataSource Specifies the object from which the data-bound control retrieves its data items. Inherited from ASPxDataWebControlBase.
DataSourceID Gets or sets the ID of the control from which the data-bound control retrieves its list of data items. Inherited from ASPxHierarchicalDataWebControl.
DefaultLevelProperties Gets an object that contains common appearance settings for all hierarchy levels within the current site map control.
DisabledCssClass static Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyle Gets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl.
EmptyImage static Obsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
Enabled Gets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearance Obsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableTheming Gets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
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.
EncodeHtml Gets or sets whether to encode editor value and content. Inherited from ASPxWebControl.
Events protected Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FlowLayoutItemSeparator Gets or sets the item separator displayed between nodes which are rendered using a flow layout.
FlowLayoutLevel Gets or sets a value that specifies the hierarchy level whose nodes are displayed in a flow layout. Inherited from ASPxSiteMapControlBase.
FlowLayoutMaximumDisplayItems Gets or sets the maximum number of items displayed within a linear flow.
FlowLayoutTextLineHeight Gets or sets the height of lines which contain the nodes rendered using a flow layout. Inherited from ASPxSiteMapControlBase.
Font Gets the font properties associated with the Web server control. Inherited from WebControl.
ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
GlobalAccessibilityCompliant static Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts static Gets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries static Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft static Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme static Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme static Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor static Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont static Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
HasAttributes Gets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protected Gets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
Height Gets or sets the height of the web server control. Inherited from ASPxWebControl.
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.
Initialized Gets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallback Gets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
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.
LevelProperties Gets a collection of objects that contain appearance settings for individual nesting levels of nodes displayed by the current site map control.
LinkStyle Gets an object that contains style settings to be applied to links in the site map control. Inherited from ASPxSiteMapControlBase.
Loaded Indicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protected Gets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
MaximumDisplayLevels Gets or sets the number of nesting levels to render within the site map 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.
NodeTemplate Gets or sets a template used for displaying the content of all the site map nodes (at all hierarchy levels). Inherited from ASPxSiteMapControlBase.
NodeTextTemplate Gets or sets a template used for displaying the text content of all the site map nodes (at all hierarchy levels). Inherited from ASPxSiteMapControlBase.
Paddings Gets the padding settings of the site map control. Inherited from ASPxSiteMapControlBase.
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.
ParentImages This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStyles This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RepeatDirection Gets or sets the direction in which nodes are displayed within the site map control. Inherited from ASPxSiteMapControlBase.
RightToLeft Specifies whether to apply right-to-left representation to the control.
RootNodes Gets a collection of objects that represent the top-level nodes of the navigation structure for the site. Inherited from ASPxSiteMapControlBase.
ShadowImage static Obsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
Site Gets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinID Gets or sets the skin to apply to the control. Inherited from WebControl.
SpriteCssFilePath Gets or sets the path to a CSS file that defines the control’s sprite image settings. Inherited from ASPxSiteMapControlBase.
SpriteImageUrl Gets or sets the path to a sprite image. Inherited from ASPxSiteMapControlBase.
Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl.
SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
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.
TabIndex Gets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protected Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protected Gets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
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.
Theme Gets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
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 that indicates whether a server control is rendered as UI on the page. Inherited from Control.
Width Gets or sets the width of the web server control. Inherited from ASPxWebControl.

Methods

Name Description
AddAttributesToRender(HtmlTextWriter) protected Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl.
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.
ApplyStyle(Style) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. Inherited from WebControl.
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control. Inherited from Control.
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.
CopyBaseAttributes(WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. Inherited from WebControl.
CreateControlCollection() protected Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control.
DataBind() Binds the data source to the invoked server control. Inherited from ASPxWebControl.
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.
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 Control.
FindControl(SiteMapNode, String) Searches the current naming container’s specified node for a server control with the specified id parameter. Inherited from ASPxSiteMapControlBase.
Focus() Sets input focus to the web control. Inherited from ASPxWebControl.
GetCallbackErrorMessage() static Obtains the error info while processing the redirection page. Inherited from ASPxWebControl.
GetClientSideEventHandler(String) Returns the specified client event’s handler. Inherited from ASPxWebControl.
GetCssClassNamePrefix() For internal use only. Inherited from ASPxWebControl.
GetCssClassNamePrefix(String) For internal use only. Inherited from ASPxWebControl.
GetDefaultBooleanProperty(String, DefaultBoolean) For internal use only. Inherited from ASPxWebControl.
GetDesignModeState() protected Gets design-time data for a control. Inherited from Control.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetResourceUrl(Page, String) static Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetResourceUrl(Page, Type, String) static Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
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.
HasControls() Determines if the server control contains any child controls. Inherited from Control.
HasEvents() protected Returns a value indicating whether events are registered for the control or any child controls. Inherited from Control.
HtmlEncode(String, Boolean) For internal use only. Inherited from ASPxWebControl.
HtmlEncode(String) For internal use only. Inherited from ASPxWebControl.
IsAccessibilityCompliantRender() Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl.
IsAccessibilityCompliantRender(Boolean) Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl.
IsClientSideAPIEnabled() Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side. Inherited from ASPxWebControl.
IsEnabled() Returns a value that specifies whether a web control is enabled. Inherited from ASPxWebControlBase.
IsLiteralContent() protected Determines if the server control holds only literal content. Inherited from Control.
IsLoading() This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ASPxWebControl.
IsVisible() Returns a value that specifies whether the current web control is displayed. Inherited from ASPxWebControlBase.
LoadControlState(Object) protected Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control.
MakeResponseCompressed() static Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client. Inherited from ASPxWebControl.
MakeResponseCompressed(Boolean) static Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6. Inherited from ASPxWebControl.
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.
MergeStyle(Style) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. Inherited from WebControl.
OnDataBinding(EventArgs) protected Raises the DataBinding 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.
RedirectOnCallback(String) static Redirects a client to a new URL while processing a callback. Inherited from ASPxWebControl.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RegisterBaseScript(Page, Boolean) static Registers base scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterBaseScript(Page) static Registers base scripts, required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterUtilsScript(Page) static Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RemovedControl(Control) protected Called after a child control is removed from the Controls collection of the Control object. Inherited from Control.
RenderBeginTag(HtmlTextWriter) Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
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.
RenderContents(HtmlTextWriter) protected Renders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderControl(HtmlTextWriter, ControlAdapter) protected Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control.
RenderControl(HtmlTextWriter) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. Inherited from Control.
RenderEndTag(HtmlTextWriter) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RequireClientLibrariesRegistering() static Specifies whether client library registration is required. Inherited from ASPxWebControl.
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 ASPxWebControlBase.
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.
SetCallbackErrorMessage(String) static Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred. Inherited from ASPxWebControl.
SetClientSideEventHandler(String, String) Defines a handler for the specified client event. Inherited from ASPxWebControl.
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.
IAttributeAccessor.GetAttribute(String) Gets an attribute of the Web control with the specified name. Inherited from WebControl.
IAttributeAccessor.SetAttribute(String, String) Sets an attribute of the Web control to the specified name and value. Inherited from WebControl.
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.
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.

Events

Name Description
CallbackError static Allows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control. Inherited from ASPxWebControl.
DataBinding Occurs when the server control binds to a data source. Inherited from Control.
DataBound Occurs after the server control binds to the data source. Inherited from ASPxDataWebControlBase.
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.
NodeCommand Fires when a control contained within a templated node raises the Command event. Inherited from ASPxSiteMapControlBase.
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.
See Also