New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadSiteMap

Class

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[EmbeddedSkin("SiteMap", typeof(RadSiteMap))]
[EmbeddedSkin("SiteMap", "Default", typeof(RadSiteMap))]
[ClientScriptResource("Telerik.Web.UI.RadSiteMap", "Telerik.Web.UI.SiteMap.RadSiteMap.js")]
[TelerikToolboxCategory("Navigation")]
[ToolboxBitmap(typeof(RadSiteMap), "Toolbox.Icons.SiteMap.png")]
public class RadSiteMap : HierarchicalControlItemContainer, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, INamingContainer, IXmlSerializable, IControlItemContainer, IRadSiteMapNodeContainer

Inheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlControlItemContainerHierarchicalControlItemContainerRadSiteMap...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlItemContainerIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIFeatureGroupINamingContainerIParserAccessorIPostBackDataHandlerIRadSiteMapNodeContainerIScriptControlISkinnableControlIUrlResolutionServiceIXmlSerializable...

Constructors

RadSiteMap()

public RadSiteMap()

Properties

CssClassFormatString

string

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

protected override string CssClassFormatString { get; }

Overrides: RadDataBoundControl.CssClassFormatString

Example:

protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

DataBindings

RadSiteMapNodeBindingCollection

Gets a collection of RadSiteMapNodeBindingCollection objects that define the relationship between a data item and the tree node it is binding to.

[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public RadSiteMapNodeBindingCollection DataBindings { get; }

Property Value:

A RadSiteMapNodeBindingCollection that represents 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.

[PersistenceMode(PersistenceMode.InnerProperty)]
public DefaultSiteMapLevelSetting DefaultLevelSettings { get; }

Property Value:

A SiteMapLevelSetting object.

Individual levels can be customized using the LevelSettings collection. Levels not specified in this collection will get the default settings.

EnableTextHTMLEncoding

bool

Gets or sets a value indicating whether the html encoding will be applied when the site map items are rendered.

public bool EnableTextHTMLEncoding { get; set; }

By default RadSiteMap will not apply a html encoding when the site map items are rendered.

LevelSettings

SiteMapLevelSettingCollection

Gets the collection of LevelSettings objects that define the appearance of the nodes according to their level in the hierarchy.

[PersistenceMode(PersistenceMode.InnerProperty)]
public SiteMapLevelSettingCollection LevelSettings { get; }

Property Value:

A SiteMapLevelSettingCollection containing LevelSettings that define the appearance of the nodes according to their level in the hierarchy.

Nodes

RadSiteMapNodeCollection

Gets a RadSiteMapNodeCollection object that contains the root nodes of the current RadSiteMap control.

[PersistenceMode(PersistenceMode.InnerProperty)]
public RadSiteMapNodeCollection Nodes { get; }

Property Value:

A RadSiteMapNodeCollection that contains the root nodes of the current RadSiteMap control. By default the collection is empty (RadSiteMap has no children).

Implements: IRadSiteMapNodeContainer.Nodes

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.

Example:

cs-api-definition
RadSiteMap1.Nodes[0].Text = "Example";
RadSiteMap1.Nodes[0].NavigateUrl = "http://www.example.com";
cs-api-definition.skip-repl
RadSiteMap1.Nodes(0).Text = "Example"
RadSiteMap1.Nodes(0).NavigateUrl = "http://www.example.com"

SelectedNode

RadSiteMapNode

Gets a collection of RadSiteMapNode objects that represent the node in the control that is currently selected.

[Browsable(false)]
public RadSiteMapNode SelectedNode { get; }

ShowNodeLines

bool

Gets or sets a value indicating whether to render node lines in a fashion similar to RadTreeView.

public bool ShowNodeLines { get; set; }

Property Value:

true if node lines should be rendered; false otherwise. The default value is false

Node lines are supported in List rendering mode without columns.

Methods

ClearSelectedNode()

This methods clears the selected nodes of the current RadSiteMap instance.

public void ClearSelectedNode()

CreateChildItemCollection()

protected override ControlItemCollection CreateChildItemCollection()

Returns:

ControlItemCollection

Overrides: ControlItemContainer.CreateChildItemCollection()

CreateDataBindings()

protected override NavigationItemBindingCollection CreateDataBindings()

Returns:

NavigationItemBindingCollection

Overrides: HierarchicalControlItemContainer.CreateDataBindings()

CreateItem()

protected override ControlItem CreateItem()

Returns:

ControlItem

Overrides: ControlItemContainer.CreateItem()

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: ControlItemContainer.DescribeComponent(IScriptDescriptor)

GetAllNodes()

Gets a linear list of all nodes in the RadSiteMap control.

public IList<RadSiteMapNode> GetAllNodes()

Returns:

IList<RadSiteMapNode>

An IList<T> containing all nodes (from all hierarchy levels).

GetScriptReferences()

protected override IEnumerable<ScriptReference> GetScriptReferences()

Returns:

IEnumerable<ScriptReference>

Overrides: RadDataBoundControl.GetScriptReferences()

InitializeItem(ControlItem)

protected override void InitializeItem(ControlItem item)

Parameters:itemControlItem

Overrides: ControlItemContainer.InitializeItem(ControlItem)

OnTemplateNeeded(RadSiteMapNodeEventArgs)

protected virtual void OnTemplateNeeded(RadSiteMapNodeEventArgs e)

Parameters:eRadSiteMapNodeEventArgs

RaiseItemCreated(ControlItem)

protected override void RaiseItemCreated(ControlItem item)

Parameters:itemControlItem

Overrides: ControlItemContainer.RaiseItemCreated(ControlItem)

RaiseItemDataBound(ControlItem)

protected override void RaiseItemDataBound(ControlItem item)

Parameters:itemControlItem

Overrides: ControlItemContainer.RaiseItemDataBound(ControlItem)

RaiseTemplateNeeded(ControlItem)

protected override void RaiseTemplateNeeded(ControlItem item)

Parameters:itemControlItem

Overrides: ControlItemContainer.RaiseTemplateNeeded(ControlItem)

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.RenderContents(HtmlTextWriter)

Events

NodeCreated

RadSiteMapNodeEventHandler

Occurs when node is created.

public event RadSiteMapNodeEventHandler NodeCreated

The NodeCreated event occurs before NodeDataBound and after postback if ViewState is enabled. NodeCreated is not raised for items defined inline in the ASPX.

NodeDataBound

RadSiteMapNodeEventHandler

Occurs when node is data bound.

public event RadSiteMapNodeEventHandler NodeDataBound

Use the NodeDataBound event to set additional properties of the databound nodes.

Example:

cs-api-definition
protected void RadSiteMap1_NodeDataBound(object sender, RadSiteMapNodeEventArgs e)
{
e.Node.ToolTip = (string)DataBinder.Eval(e.Node.DataItem, "ToolTipColumn");
}
cs-api-definition.skip-repl
Protected Sub RadSiteMap1_NodeDataBound(sender As Object, e As RadSiteMapNodeEventArgs)
e.Node.ToolTip = DirectCast(DataBinder.Eval(e.Node.DataItem, "ToolTipColumn"), String)
End Sub

TemplateNeeded

RadSiteMapNodeEventHandler

Occurs before template is being applied to the node.

public event RadSiteMapNodeEventHandler TemplateNeeded

The TemplateNeeded event is raised before a template is been applied on the node, both during round-trips (postbacks) and at the time data is bound to the control. The TemplateNeeded event is not raised for nodes which are defined inline in the page or user control.

The TemplateNeeded event is commonly used for dynamic templating.

Example:

cs-api-definition
protected void RadSiteMap1_TemplateNeeded(object sender, Telerik.Web.UI.RadSiteMapNodeEventArgs e)
{
string value = e.Node.Value;
if (value != null)
{
// if the value is an even number
if ((Int32.Parse(value) % 2) == 0)
{
var textBoxTemplate = new TextBoxTemplate();
textBoxTemplate.InstantiateIn(e.Node);
}
}
}
cs-api-definition.skip-repl
Sub RadSiteMap1_Template(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadSiteMapNodeEventArgs) Handles RadSiteMap1.TemplateNeeded
Dim value As String = e.Node.Value
If value IsNot Nothing Then
' if the value is an even number
If ((Int32.Parse(value) Mod 2) = 0) Then
Dim textBoxTemplate As TextBoxTemplate = New TextBoxTemplate()
textBoxTemplate.InstantiateIn(e.Node)
End If
End If
End Sub