NavigationTermSetItem.GetAsEditable - Méthode

Article
03/15/2016

Retourne une version modifiable de cet objet NavigationTerm ou NavigationTermSet .

Espace de noms : Microsoft.SharePoint.Publishing.Navigation
Assembly : Microsoft.SharePoint.Publishing (dans Microsoft.SharePoint.Publishing.dll)

Syntaxe

'Déclaration
Public Function GetAsEditable ( _
    taxonomySession As TaxonomySession _
) As NavigationTermSetItem
'Utilisation
Dim instance As NavigationTermSetItem
Dim taxonomySession As TaxonomySession
Dim returnValue As NavigationTermSetItem

returnValue = instance.GetAsEditable(taxonomySession)

public NavigationTermSetItem GetAsEditable(
    TaxonomySession taxonomySession
)

Paramètres

taxonomySession
Type : Microsoft.SharePoint.Taxonomy.TaxonomySession

L'objet TaxonomySession pour lequel obtenir un objet Term ou TermSet comme modifiable.

Valeur renvoyée

Type : Microsoft.SharePoint.Publishing.Navigation.NavigationTermSetItem
Une version modifiable de l'objet NavigationTerm ou une version modifiable de l'objet NavigationTermSet

Remarques

Les objets NavigationTerm et NavigationTermSet ont deux modes qui reflètent des modèles d'utilisation les plus courants. En mode « modifiable », l'objet agit comme un wrapper pour l'objet sous-jacent analogue dans l'espace de noms N:Microsoft.SharePoint.Taxonomy, et l'objet peut être modifiée librement. En mode « lecture seule », l'objet utilise une représentation légère limitée qui ne référence pas les objets à partir d'un objet TaxonomySession . Le mode « lecture seule » permet un stockage efficace dans le cache de navigation taxonomie et prend en charge certaines optimisations de parcours qui améliorent les performances lorsque ces optimisations sont utilisées avec l'objet TaxonomySiteMapProvider . Le mode « lecture seule » est défini par la propriété IsReadOnly .

La méthode GetAsEditable(TaxonomySession) est utilisée lorsque la propriété IsReadOnly() est égale à true. Elle retourne une version modifiable de cette NavigationTerm objet ou NavigationTermSet , qui sert de wrapper pour l'objet sous-jacent Term ou TermSet à partir de l'objet TaxonomySession qui est fourni.

Utilisez le GetAsEditable lorsque IsReadOnly=true.

Exemples

Cet exemple montre comment utiliser la méthode GetAsEditable pour ajouter un nouveau lien à l'objet NavigationTermSet qui a été récupéré à partir du cache.

static void CreateSimpleLink(SPWeb web)
            {
                // Retrieve the active NavigationTermSet object from the taxonomy navigation cache.
                NavigationTermSet readOnlyTermSet = TaxonomyNavigation.GetTermSetForWeb(web,
                    "GlobalNavigationTaxonomyProvider", includeInheritedSettings: false);
            
                // This operation would fail because readOnlyTermSet.IsReadOnly=true:
                //readOnlyTermSet.CreateTerm("Search The Web", NavigationLinkType.SimpleLink);
            
                // Get an editable version of the object.
                TaxonomySession taxonomySession = new TaxonomySession(web, updateCache: true);
                NavigationTermSet editableTermSet = readOnlyTermSet.GetAsEditable(taxonomySession);
            
                // Configure the Taxonomy working language.
                TermStore termStore = editableTermSet.GetTaxonomyTermStore();
                termStore.WorkingLanguage = TaxonomyNavigation.GetNavigationLcidForWeb(web);
            
                // Create the link by using the editable version of the object.
                NavigationTerm editableTerm = editableTermSet.CreateTerm("Search The Web", NavigationLinkType.SimpleLink);
                editableTerm.TargetUrl.Value = "https://www.bing.com/";
            
                // Commit the changes to the taxonomy service.
                termStore.CommitAll();
                
                // Cause the cache to be updated immediately.  Without this, it may 
                // take 5-10 seconds before this change is reflected in subsequent
                // calls to GetTermSetForWeb().
                TaxonomyNavigation.FlushTermSetFromCache(web, editableTermSet);
            }