Share via


NavigationTermSetView class

Represents contextual information that affects the calculation of certain properties for the NavigationTerm objects in a NavigationTermSet object.

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.Client.ClientObject
    Microsoft.SharePoint.Client.Publishing.Navigation.NavigationTermSetView

Namespace:  Microsoft.SharePoint.Client.Publishing.Navigation
Assembly:  Microsoft.SharePoint.Client.Publishing (in Microsoft.SharePoint.Client.Publishing.dll)

Syntax

'Declaration
Public NotInheritable Class NavigationTermSetView _
    Inherits ClientObject
'Usage
Dim instance As NavigationTermSetView
public sealed class NavigationTermSetView : ClientObject

Remarks

The Web object, site map provider, and policy for trimming child nodes are all examples of contextual information that the NavigationTermSetView object can hold.

The NavigationTermSetView class represents contextual information that is used when rendering a navigation term set, but which is not stored in the TermStore or cached by the taxonomy navigation cache. Therefore, the NavigationTermSetView class is not considered to be part of the term set. Nonetheless, this contextual information affects the behavior of NavigationTerm object and NavigationTermSet object, similar to how a physical object's appearance may change when viewed from different angles.

The View property is a member of both the NavigationTermSet class and NavigationTerm class, and is carried along while traversing the hierarchy. For example, after calling the GetWithNewView method, the returned object will have the view, and so will any other objects obtained from members such as the Parent property and TermSet property.

The View property is read-only and fixed for a specified object instance. Therefore, the view-changing operations always return a new instance of the NavigationTerm object or NavigationTermSet object. Returning the NavigationTerm object or the NavigationTermSet object facilitates internal performance optimizations that require immutable objects.

It is possible for an Web object to be configured to inherit its navigation term set from the parent Web (specified by using the InheritFromParentWeb value). In this situation, the NavigationTermSetView object of the parent Web object is also used for the child Web object. In other words, the WebId property reflects the Web object where the term set was configured, instead of the Web object that is inheriting the navigation.

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See also

Reference

NavigationTermSetView members

Microsoft.SharePoint.Client.Publishing.Navigation namespace