Edit

Share via

SiteMapNodeItem.SiteMapNode Property

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Gets or sets the SiteMapNode object that the SiteMapNodeItem represents.

public:
 virtual property System::Web::SiteMapNode ^ SiteMapNode { System::Web::SiteMapNode ^ get(); void set(System::Web::SiteMapNode ^ value); };
public virtual System.Web.SiteMapNode SiteMapNode { get; set; }
member this.SiteMapNode : System.Web.SiteMapNode with get, set
Public Overridable Property SiteMapNode As SiteMapNode

Property Value

SiteMapNode

A SiteMapNode object that the SiteMapPath control uses to display a site navigation user interface.

Examples

The following code example demonstrates how to get the SiteMapNode property and access the Title and Url properties of a SiteMapNode object. This code example is part of the larger example provided for a SiteMapPath class.

// Override the InitializeItem method to add a PathSeparator
// and DropDownList to the current node.
protected override void InitializeItem(SiteMapNodeItem item) {

    // The only node that must be handled is the CurrentNode.
    if (item.ItemType == SiteMapNodeItemType.Current)
    {
        HyperLink hLink = new HyperLink();

        // No Theming for the HyperLink.
        hLink.EnableTheming = false;
        // Enable the link of the SiteMapPath is enabled.
        hLink.Enabled = this.Enabled;

        // Set the properties of the HyperLink to
        // match those of the corresponding SiteMapNode.
        hLink.NavigateUrl = item.SiteMapNode.Url;
        hLink.Text        = item.SiteMapNode.Title;
        if (ShowToolTips) {
            hLink.ToolTip = item.SiteMapNode.Description;
        }

        // Apply styles or templates to the HyperLink here.
        // ...
        // ...

        // Add the item to the Controls collection.
        item.Controls.Add(hLink);

        AddDropDownListAfterCurrentNode(item);
    }
    else {
        base.InitializeItem(item);
    }
}

' Override the InitializeItem method to add a PathSeparator
' and DropDownList to the current node.
Protected Overrides Sub InitializeItem(item As SiteMapNodeItem)

   ' The only node that must be handled is the CurrentNode.
   If item.ItemType = SiteMapNodeItemType.Current Then
      Dim hLink As New HyperLink()

      ' No Theming for the HyperLink.
      hLink.EnableTheming = False
      ' Enable the link of the SiteMapPath is enabled.
      hLink.Enabled = Me.Enabled

      ' Set the properties of the HyperLink to
      ' match those of the corresponding SiteMapNode.
      hLink.NavigateUrl = item.SiteMapNode.Url
      hLink.Text = item.SiteMapNode.Title
      If ShowToolTips Then
         hLink.ToolTip = item.SiteMapNode.Description
      End If

      ' Apply styles or templates to the HyperLink here.
      ' ...
      ' ...
      ' Add the item to the Controls collection.
      item.Controls.Add(hLink)

      AddDropDownListAfterCurrentNode(item)
   Else
      MyBase.InitializeItem(item)
   End If
End Sub

Remarks

The SiteMapNode property gets or sets the SiteMapNode that the SiteMapNodeItem is bound to. SiteMapNodeItem objects that have a PathSeparator type are not bound to a corresponding SiteMapNode object.

Applies to

See also