3.1.5.7 Microsoft.SharePoint.Client.Publishing.Navigation.NavigationTermSet

  • Article

TypeId: {5ED5AE4C-8E92-4E56-AF6E-D349611614D8}

ShortName: SP.Publishing.Navigation.NavigationTermSet

Specifies navigation behavior and properties for a term set that is used for taxonomy navigation. The NavigationTermSet class is based on the TermSet class ([MS-EMMCSOM] section 3.1.5.20). NavigationTermSet inherits from the NavigationTermSetItem class (section 3.1.5.8).

Remarks:

The properties of the NavigationTermSet class MAY be stored in TermSet.CustomProperties ([MS-EMMCSOM] section 3.1.5.20.1.1.3). However, this protocol intends that the properties be accessed through the NavigationTermSet class for clarity and efficiency.

The NavigationTermSet object has two modes: an "editable" mode that is required in order to make updates to the object, and a "read-only" mode that, when used, improves performance by retrieving the object from the taxonomy navigation cache. The read-only mode is indicated by the NavigationTermSetItem.IsReadOnly property (section 3.1.5.8.1.1.4).  Use the GetAsEditable (section 3.1.5.7.2.2.4) method to obtain an editable instance.

If the NavigationTermSet is read-only and the protocol client attempts to assign any property or call any method that would change the object state, then the protocol server MUST return an InvalidOperationException error.