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.

Constructors

	Name	Description
	NavigationTerm

Top

Properties

	Name	Description
	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.
	CatalogTargetUrl	Gets the target URL that is used when rewriting URLs for catalog-friendly URLs that are based on this NavigationTerm object.
	CatalogTargetUrlForChildTerms	Gets the default value of the CatalogTargetUrl property for child NavigationTerm objects. (Inherited from NavigationTermSetItem.)
	CategoryImageUrl	Gets or sets the specified URL of an image that optionally can be displayed by a template page.
	Context	Returns the context that is associated with the client object. (Inherited from ClientObject.)
	ExcludedProviders	A collection of site map provider names that will exclude this navigation term from their results when ExcludeTermsByProvider is true.
	ExcludeFromCurrentNavigation	Gets or sets whether this navigation term and its child terms are hidden from the current navigation menu.
	ExcludeFromGlobalNavigation	Gets or sets a value that indicates whether the navigation term and its child terms are hidden from the global navigation menu.
	FriendlyUrlSegment	Gets a custom friendly URL segment for the node that is represented by the NavigationTerm object.
	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.
	Id	Gets the Id() property and Id property from the underlying taxonomy object. (Inherited from NavigationTermSetItem.)
	IsDeprecated	Indicates whether the NavigationTerm object is deprecated.
	IsPinned	Indicates whether a Term object is a pinned term.
	IsPinnedRoot	Indicates whether the underlying Term object is the root of a subtree of pinned terms.
	IsReadOnly	Gets a Boolean value that indicates whether the object is in “read-only” mode or “editable” mode. (Inherited from NavigationTermSetItem.)
	LinkType	Gets the type of link for this NavigationTermSetItem object. (Inherited from NavigationTermSetItem.)
	ObjectData	Gets the object data for the current client object. (Inherited from ClientObject.)
	ObjectVersion	Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Parent	Returns the parent NavigationTerm object.
	Path	Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	ServerObjectIsNull	Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
	SimpleLinkUrl	Gets or sets the target URL if the navigation node represents a simple link.
	Tag	Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
	TargetUrl	Gets the URL of a publishing page that is used to render a friendly URL.
	TargetUrlForChildTerms	Gets a string that specifies the default value of the target URL for child NavigationTerm objects. (Inherited from NavigationTermSetItem.)
	TaxonomyName	Gets a Name property or a Name property from the underlying taxonomy object. (Inherited from NavigationTermSetItem.)
	Terms	Gets a collection of all immediate child NavigationTerm objects of this NavigationTerm object or NavigationTermSet object. (Inherited from NavigationTermSetItem.)
	TermSet	Gets the associated NavigationTermSet object that the NavigationTerm belongs to.
	Title	Gets a navigation node title that is displayed in menus and breadcrumbs. (Inherited from NavigationTermSetItem.)
	TypedObject	Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
	View	Gets a NavigationTermSetView object that is used for various purposes such as to resolve relative URLs. (Inherited from NavigationTermSetItem.)

Top

Methods

	Name	Description
	CheckUninitializedProperty	Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
	CreateTerm	Creates a new NavigationTerm object with the specified termName. (Inherited from NavigationTermSetItem.)
	CustomFromJson	Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	DeleteObject	Deletes this NavigationTerm object and its child objects from the TermStore object.
	FromJson	Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	GetAllParentTerms	Returns the parent NavigationTerm object and all of its parent terms.
	GetAsEditable	Returns an editable version of a NavigationTerm object.
	GetAsResolvedByView	Constructs a NavigationTerm object in editable mode that is bound to the specified Term object.
	GetAsResolvedByWeb	Constructs an editable NavigationTerm object that is bound to a specified Term object.
	GetResolvedAssociatedFolderUrl	Returns the AssociatedFolderUrl property as a server-relative URL.
	GetResolvedDisplayUrl	Returns the URL that is displayed in the navigation menus. (Inherited from NavigationTermSetItem.)
	GetResolvedTargetUrl	Returns a target page address as a server-relative URL from the Url() property.
	GetResolvedTargetUrlWithoutQuery	Returns a target page address as a server-relative URL that does not include a query string.
	GetTaxonomyTerm	Returns the associated Term object if the NavigationTerm object is in the editable mode.
	GetTaxonomyTermStore	Returns the associated TermStore if the NavigationTermSetItem object is in the editable mode. (Inherited from NavigationTermSetItem.)
	GetWebRelativeFriendlyUrl	Returns the friendly URL segments as a concatenated path.
	GetWithNewView	Returns a new NavigationTerm object based on the NavigationTermSetView that is provided.
	InitNonPropertyFieldFromJson	Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	InitOnePropertyFromJson	(Overrides NavigationTermSetItem.InitOnePropertyFromJson(String, JsonReader).)
	IsObjectPropertyInstantiated	Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
	IsPropertyAvailable	Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
	LoadExpandoFields	Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	Move	Moves the NavigationTerm object to be a child of the specified NavigationTerm object or NavigationTermSet object.
	RefreshLoad	Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	RemoveFromParentCollection	Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
	Retrieve()	Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Retrieve([])	Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	ToString	(Inherited from Object.)
	UpdateClientObjectPropertyType	Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)

Top

See also

Reference

NavigationTerm class

Microsoft.SharePoint.Client.Publishing.Navigation namespace