del método NavigationTermSetItem.GetAsEditable

Artículo
03/15/2016

Devuelve una versión modificable de este objeto de NavigationTerm o NavigationTermSet .

Espacio de nombres: Microsoft.SharePoint.Publishing.Navigation
Ensamblado: Microsoft.SharePoint.Publishing (en Microsoft.SharePoint.Publishing.dll)

Sintaxis

'Declaración
Public Function GetAsEditable ( _
    taxonomySession As TaxonomySession _
) As NavigationTermSetItem
'Uso
Dim instance As NavigationTermSetItem
Dim taxonomySession As TaxonomySession
Dim returnValue As NavigationTermSetItem

returnValue = instance.GetAsEditable(taxonomySession)

public NavigationTermSetItem GetAsEditable(
    TaxonomySession taxonomySession
)

Parámetros

taxonomySession
Tipo: Microsoft.SharePoint.Taxonomy.TaxonomySession

El objeto TaxonomySession para el que se va a obtener un objeto Term o TermSet como editables.

Valor devuelto

Tipo: Microsoft.SharePoint.Publishing.Navigation.NavigationTermSetItem
Una versión editable del objeto NavigationTerm o una versión editable del objeto NavigationTermSet

Comentarios

Los objetos NavigationTerm y NavigationTermSet tienen dos modos que reflejan los patrones de uso más común. En el modo "editable", el objeto actúa como un contenedor para el objeto subyacente análogo en el espacio de nombres N:Microsoft.SharePoint.Taxonomy y el objeto se puede modificar libremente. En el modo "sólo lectura", el objeto utiliza una representación reducida limitada que no hacen referencia a objetos de un objeto TaxonomySession . El modo "sólo lectura" permite el almacenamiento eficiente en la caché de navegación de la taxonomía y es compatible con algunas optimizaciones de recorrido que mejoran el rendimiento cuando se utilizan estas optimizaciones con el objeto TaxonomySiteMapProvider . La propiedad IsReadOnly establece el modo de "sólo lectura".

El método GetAsEditable(TaxonomySession) se utiliza cuando la propiedad IsReadOnly() es igual a true. Devuelve una versión modificable de este objeto de NavigationTerm o un objeto NavigationTermSet , que actúa como un contenedor para el objeto subyacente de Term o TermSet desde el objeto TaxonomySession que se proporciona.

Utilice la GetAsEditable al IsReadOnly=true.

Ejemplos

En este ejemplo se muestra cómo utilizar el método GetAsEditable para agregar un nuevo vínculo a un objeto NavigationTermSet que se ha recuperado de la memoria caché.

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);
            }