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

Artículo
03/15/2016

Obtiene una colección de todos los objetos de Term desde el objeto de TermSet actual con una cadena de matchingthe de Label de los 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 TermSet
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

El Label de la Term para obtener

defaultLabelOnly
Tipo: System.Boolean

true si etiquetas predeterminadas deben incluirse en la búsqueda; en caso contrario, false

stringMatchOption
Tipo: Microsoft.SharePoint.Taxonomy.StringMatchOption

Si desea buscar las etiquetas que comienzan con la cadena especificada, o los que tienen una coincidencia exacta.

resultCollectionSize
Tipo: System.Int32

El número máximo de objetos de Term para incluir en el objeto devuelto TermCollection .

trimUnavailable
Tipo: System.Boolean

Un valor booleano que indica si se va a recortar objetos Term que tienen la propiedad IsAvailableForTagging establecida en false.

Valor devuelto

Tipo: Microsoft.SharePoint.Taxonomy.TermCollection
Una colección de todos los objetos de Term de la actual TermSet con un Label que coinciden con la cadena proporcionada en cualquier LCID, con una opción para buscar sólo etiquetas predeterminadas.

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, objetos Term con la propiedad IsAvailableForTagging establecida en false se eliminarán de los resultados; de lo contrario, se devolverá Term todos los objetos independientemente de su valor de 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ámetrostringMatchOption . El número máximo de resultados de esta búsqueda está restringido por el parámetro resultCollectionSize .El termLabel no puede ser una referencia null (Nothing en Visual Basic) o vacía y no debe superar los 255 caracteres de longitud.Tampoco puede contener cualquiera de los siguientes caracteres no válidos: ;"<>|&tab. Para obtener resultados más precisos, Microsoft recomienda utilizar el método CommitAll() para confirmar los cambios a la base de datos antes de ejecutar esta búsqueda.