NavigationTerm members

Specifies navigation behavior and properties for a Term object that is used to drive the navigation and friendly URLs for a website.

The NavigationTerm type exposes the following members.

Properties

  Name Description
Public property AssociatedFolderUrl Gets or sets the URL value that is used to associate some page URLs with this NavigationTerm object to indicate the location of the properties in the site map provider hierarchy.
Public property CatalogTargetUrl Gets the target URL that is used when rewriting URLs for catalog-friendly URLs that are based on this NavigationTerm object.
Public property CatalogTargetUrlForChildTerms Gets the default value of the CatalogTargetUrl property for child NavigationTerm objects. (Inherited from NavigationTermSetItem.)
Public property CategoryImageUrl Gets or sets the specified URL of an image that optionally can be displayed by a template page.
Public property ExcludeFromCurrentNavigation Gets or sets whether this navigation term and its child terms are hidden from the current navigation menu.
Public property ExcludeFromGlobalNavigation Gets or sets a value that indicates whether the navigation term and its child terms are hidden from the global navigation menu.
Public property FriendlyUrlSegment Gets a custom friendly URL segment for the node that is represented by the NavigationTerm object.
Public property HoverText Gets or sets a description that is typically displayed by a menu or by breadcrumb navigation controls when the mouse hovers over the navigation link.
Public property Id Gets the Id() property and Id property from the underlying taxonomy object. (Inherited from NavigationTermSetItem.)
Public property IsDeprecated Indicates whether the NavigationTerm object is deprecated.
Public property IsPinned Indicates whether a Term object is a pinned term.
Public property IsPinnedRoot Indicates whether the underlying Term object is the root of a subtree of pinned terms.
Public property IsReadOnly Gets a Boolean value that indicates whether the object is in “read-only” mode or “editable” mode. (Inherited from NavigationTermSetItem.)
Public property LinkType Gets the type of link for this NavigationTermSetItem object. (Inherited from NavigationTermSetItem.)
Public property Parent Returns the parent NavigationTerm object.
Public property SimpleLinkUrl Gets or sets the target URL if the navigation node represents a simple link.
Public property TargetUrl Gets the URL of a publishing page that is used to render a friendly URL.
Public property TargetUrlForChildTerms Gets a string that specifies the default value of the target URL for child NavigationTerm objects. (Inherited from NavigationTermSetItem.)
Public property TaxonomyName Gets a Name property or a Name property from the underlying taxonomy object. (Inherited from NavigationTermSetItem.)
Public property Terms Gets a collection of all immediate child NavigationTerm objects of this NavigationTerm object or NavigationTermSet object. (Inherited from NavigationTermSetItem.)
Public property TermSet Gets the associated NavigationTermSet object that the NavigationTerm belongs to.
Public property Title Gets a navigation node title that is displayed in menus and breadcrumbs. (Inherited from NavigationTermSetItem.)
Public property View Gets a NavigationTermSetView object that is used for various purposes such as to resolve relative URLs. (Inherited from NavigationTermSetItem.)

Top

Methods

  Name Description
Public method CreateTerm(String, NavigationLinkType) Creates a new NavigationTerm object that will be a child of this NavigationTermSetItem object. (Inherited from NavigationTermSetItem.)
Public method CreateTerm(String, NavigationLinkType, Guid) Creates a new NavigationTerm object with the specified termName. (Inherited from NavigationTermSetItem.)
Public method Delete Deletes this NavigationTerm object and its child objects from the associated TermStore object.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetAsEditable Returns an editable version of a NavigationTerm object.
Protected method GetAsEditableTermSetItem This member is reserved for internal use and is not intended to be used directly from your code. (Overrides NavigationTermSetItem.GetAsEditableTermSetItem(TaxonomySession).)
Public methodStatic member GetAsResolvedByView Constructs a NavigationTerm object in editable mode that is bound to the specified Term object.
Public methodStatic member GetAsResolvedByWeb Constructs an editable NavigationTerm object that is bound to a specified Term object.
Protected method GetCustomizableStringCustomValue This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from NavigationTermSetItem.)
Protected method GetCustomizableStringDefaultValue This member is reserved for internal use and is not intended to be used directly from your code. (Overrides NavigationTermSetItem.GetCustomizableStringDefaultValue(Enum).)
Public method GetHashCode (Inherited from Object.)
Public method GetResolvedAssociatedFolderUrl Returns the AssociatedFolderUrl property as a server-relative URL.
Public method GetResolvedDisplayUrl Returns the URL that is displayed in the navigation menus. (Inherited from NavigationTermSetItem.)
Public method GetResolvedTargetUrl Returns a target page address as a server-relative URL from the Url() property.
Public method GetResolvedTargetUrlWithoutQuery Returns a target page address as a server-relative URL that does not include a query string.
Public method GetTaxonomyTerm() Returns the associated Term object if the NavigationTerm object is in the editable mode.
Public method GetTaxonomyTerm(TaxonomySession) Retrieves the corresponding taxonomy object (e.g., Term) from the TaxonomySession object provided.
Public method GetTaxonomyTermStore Returns the associated TermStore if the NavigationTermSetItem object is in the editable mode. (Inherited from NavigationTermSetItem.)
Protected method GetTermSetItemWithNewView reservemember (Overrides NavigationTermSetItem.GetTermSetItemWithNewView(NavigationTermSetView).)
Public method GetType (Inherited from Object.)
Public method GetWebRelativeFriendlyUrl Returns the friendly URL segments as a concatenated path.
Public method GetWithNewView Returns a new NavigationTerm object based on the NavigationTermSetView that is provided.
Protected method MemberwiseClone (Inherited from Object.)
Public method Move Moves the NavigationTerm object to be a child of the specified NavigationTerm object or NavigationTermSet object.
Protected method SetCustomizableStringCustomValue This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from NavigationTermSetItem.)
Public method ToString Returns the string representation of a NavigationTermSetItem object. (Inherited from NavigationTermSetItem.)

Top

See also

Reference

NavigationTerm class

Microsoft.SharePoint.Publishing.Navigation namespace