Telerik.Web.UI.RadSiteMap
Inheritance Hierarchy
- System.Object
- System.Web.UI.Control
- System.Web.UI.WebControls.WebControl
- System.Web.UI.WebControls.BaseDataBoundControl
- System.Web.UI.WebControls.DataBoundControl
- Telerik.Web.UI.RadDataBoundControl : IControl, IControlResolver, IFeatureGroup, IPostBackDataHandler, IScriptControl, ISkinnableControl
- Telerik.Web.UI.ControlItemContainer : IControlItemContainer, INamingContainer, IXmlSerializable
- Telerik.Web.UI.HierarchicalControlItemContainer
- Telerik.Web.UI.RadSiteMap : IRadSiteMapNodeContainer
Properties
CausesValidation Boolean
Gets or sets a value indicating whether validation is performed when an item within the control is selected.
Remarks
By default, page validation is performed when an item is selected. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control. You can specify or determine whether validation is performed on both the client and the server when an item is clicked by using the CausesValidation property. To prevent validation from being performed, set the CausesValidation property to false.
ClientDataSourceID String
Gets or sets ID of ClientDataSource control that is used for client side binding
ClientIDMode ClientIDMode
This property is overridden in order to support controls which implement INamingContainer. The default value is changed to "AutoID".
CssClassFormatString String
The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
DataBindings RadSiteMapNodeBindingCollection
Gets a collection of objects that define the relationship between a data item and the tree node it is binding to.
DefaultLevelSettings DefaultSiteMapLevelSetting
Gets or sets the SiteMapLevelSetting object to be used when no specific settings have been defined for a given level.
Remarks
Individual levels can be customized using the LevelSettings collection. Levels not specified in this collection will get the default settings.
EnableAjaxSkinRendering String
Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
Remarks
If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
EnableEmbeddedBaseStylesheet Boolean
Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
Remarks
If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
EnableEmbeddedScripts Boolean
Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
Remarks
If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
EnableEmbeddedSkins String
Gets or sets the value, indicating whether to render links to the embedded skins or not.
Remarks
If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
EnableRippleEffect Boolean
Returns true if ripple effect should be added
EnableTextHTMLEncoding Boolean
Gets or sets a value indicating whether the html encoding will be applied when the site map items are rendered.
Remarks
By default RadSiteMap will not apply a html encoding when the site map items are rendered.
IsSkinSet String
For internal use.
KeyboardNavigationSettings KeyboardNavigationSettings
Used to customize the keyboard navigation functionality.
LevelSettings SiteMapLevelSettingCollection
Gets the collection of LevelSettings objects that define the appearance of the nodes according to their level in the hierarchy.
Nodes RadSiteMapNodeCollection
Gets a object that contains the root nodes of the current RadSiteMap control.
Remarks
Use the nodes property to access the root nodes of the RadSiteMap control. You can also use the nodes property to manage the root nodes - you can add, remove or modify nodes.
ODataDataSourceID String
Gets or sets the ODataDataSource used for data binding.
PostBackUrl String
Gets or sets the URL of the page to post to from the current page when a tab from the tabstrip is clicked.
RegisterWithScriptManager Boolean
Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
Remarks
If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.
RenderMode RenderMode
Specifies the rendering mode of the control. Setting the mode to Lightweight will yield HTML 5/CSS 3 html and css. If the set value is Auto use ResolvedRenderMode to receive the actual RenderMode with respect to the user angent of the current request.
Remarks
Lightweight rendering mode might change the outlook of the component in some older browsers that don't support CSS3/HTML5.
ResolvedRenderMode RenderMode
Returns resolved RenderMode should the original value was Auto
RuntimeSkin String
Gets the real skin name for the control user interface. If Skin is not set, returns "Default", otherwise returns Skin.
SelectedNode RadSiteMapNode
Gets a collection of RadSiteMapNode objects that represent the node in the control that is currently selected.
ShowNodeLines Boolean
Gets or sets a value indicating whether to render node lines in a fashion similar to RadTreeView.
Remarks
Node lines are supported in List rendering mode without columns.
Skin String
Gets or sets the skin name for the control user interface.
Remarks
If this property is not set, the control will render using the skin named "Default". If EnableEmbeddedSkins is set to false, the control will not render skin.
ValidationGroup String
Gets or sets the name of the validation group to which this validation control belongs.
Remarks
This property works only when CausesValidation is set to true.
Methods
AddProperty
Adds the property to the IScriptDescriptor, if it's value is different from the given default.
Parameters
descriptor Telerik.Web.UI.IScriptDescriptor
The descriptor to add the property to.
name System.String
The property name.
value System.Object
The current value of the property.
defaultValue System.Object
The default value.
Returns
System.Void
ApplyConditionalRendering
Use this from RenderContents of the inheritor
Returns
System.Void
ClearSelectedNode
This methods clears the selected nodes of the current RadSiteMap instance.
Returns
System.Void
ControlPreRender
Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
Returns
System.Void
DescribeRenderingMode
Should be used by inheritors
Returns
System.Void
GetAllNodes
Gets a linear list of all nodes in the RadSiteMap control.
Returns
System.Collections.Generic.IList
1` An IList
GetEmbeddedSkinNames
Returns the names of all embedded skins. Used by Telerik.Web.Examples.
Returns
System.Collections.Generic.List
1`
GetXml
Gets an XML string representing the state of the control. All child items and their properties are serialized in this string.
Remarks
Use the GetXml method to get the XML state of the control. You can cache it and then restore it using the LoadXml method.
Returns
System.String
A String representing the state of the control - child items, properties etc.
LoadClientState
Loads the client state data
Parameters
clientState System.Collections.Generic.Dictionary{System.String,System.Object}
Returns
System.Void
LoadPostData
Executed when post data is loaded from the request
Parameters
postDataKey System.String
postCollection System.Collections.Specialized.NameValueCollection
Returns
System.Boolean
LoadXml
Loads the control from an XML string.
Remarks
Use the LoadXml method to populate the control from an XML string. You can use it along the GetXml method to implement caching.
Parameters
xml System.String
The string representing the XML from which the control will be populated.
Returns
System.Void
OnNodeCreated
Raises the event.
Parameters
e Telerik.Web.UI.RadSiteMapNodeEventArgs
The instance containing the event data.
Returns
System.Void
OnNodeDataBound
Raises the event.
Parameters
e Telerik.Web.UI.RadSiteMapNodeEventArgs
The instance containing the event data.
Returns
System.Void
RaisePostDataChangedEvent
Executed when post data changes should invoke a changed event
Returns
System.Void
RegisterCssReferences
Registers the CSS references
Returns
System.Void
RegisterScriptControl
Registers the control with the ScriptManager
Returns
System.Void
SaveClientState
Saves the client state data
Returns
System.String