(String, Boolean, StringMatchOption, Int32, Boolean) del método TermStore.GetTerms

Artículo
03/15/2016

Obtiene una colección de todos los objetos Term de todos los objetos de TermSet de este TermStore que el usuario actual tiene permisos para leer con un objeto Label que coincide con la cadena proporcionada en cualquier LCID, con una opción para sólo etiquetas predeterminadas de búsqueda.

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

Sintaxis

'Declaración
Public Function GetTerms ( _
    termLabel As String, _
    defaultLabelOnly As Boolean, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Uso
Dim instance As TermStore
Dim termLabel As String
Dim defaultLabelOnly As Boolean
Dim stringMatchOption As StringMatchOption
Dim resultCollectionSize As Integer
Dim trimUnavailable As Boolean
Dim returnValue As TermCollection

returnValue = instance.GetTerms(termLabel, _
    defaultLabelOnly, stringMatchOption, _
    resultCollectionSize, trimUnavailable)

public TermCollection GetTerms(
    string termLabel,
    bool defaultLabelOnly,
    StringMatchOption stringMatchOption,
    int resultCollectionSize,
    bool trimUnavailable
)

Parámetros

termLabel
Tipo: System.String

La etiqueta del término para obtener

defaultLabelOnly
Tipo: System.Boolean

Indica si sólo los etiquetas predeterminadas deben incluirse en la búsqueda.

stringMatchOption
Tipo: Microsoft.SharePoint.Taxonomy.StringMatchOption

Indica si se va a buscar las etiquetas que comienzan con la cadena especificada, o los que tienen una coincidencia exacta.

resultCollectionSize
Tipo: System.Int32

Indica el número máximo de objetos de Term para incluir en el TermCollectionde devuelto.

trimUnavailable
Tipo: System.Boolean

Un valor booleano que indica si se va a recortar términos que tienen la propiedad IsAvailableForTagging establecida en false.

Valor devuelto

Tipo: Microsoft.SharePoint.Taxonomy.TermCollection
Una colección de todos los objetos de todos los objetos TermSet en este almacén de términos que el usuario actual tiene permisos para leer con una etiqueta que coinciden con la cadena proporcionada en cualquier LCID, con una opción para sólo etiquetas predeterminadas de búsqueda Term .

Excepciones

Excepción	Condición
ArgumentNullException	El termLabel no puede ser una referencia null (Nothing en Visual Basic) o estar vacío.
ArgumentException	El valor de termLabel no es válido. Probablemente contiene caracteres no válidos o es demasiado largo.

Comentarios

Si trimUnavailable es true términos que se ha establecido Term.IsAvailableForTagging en false se eliminarán de los resultados; de lo contrario, se devolverá todos los términos independientemente de su valor de Term.IsAvailableForTagging. Se buscará en todos los Term.Labels en todos los idiomas de trabajo por este método. La búsqueda distingue mayúsculas de minúsculas y coincidirá con la toda etiqueta o sólo la comprobación que comienza con la cadena especificada según el valor del parámetro stringMatchOption . El número máximo de resultados de esta búsqueda está restringido por el parámetro resultCollectionSize . El termLabel no puede ser nulo ni estar vacío y no debe superar los 255 caracteres de longitud. Tampoco puede contener cualquiera de los siguientes caracteres no válidos: ;"<>|&tab

Se recomienda que todos los cambios pendientes se confirmarán en la base de datos con CommitAll() antes de ejecutar esta búsqueda para obtener resultados más precisos.