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

Artículo
03/15/2016

Obtiene una colección de todos los objetos Term de todos los objetos TermSet en este objeto de TermStore 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 buscar sólo etiquetas predeterminadas y las opciones de recorte de determinados términos.

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

Sintaxis

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

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

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

Parámetros

termLabel
Tipo: System.String

La etiqueta del término para recuperar

lcid
Tipo: System.Int32

El identificador de configuración regional de las etiquetas del término que coincida.

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 término para incluir en la TermCollection devuelta.

trimUnavailable
Tipo: System.Boolean

Un valor booleano que indica si el recorte de los términos que tienen Term.IsAvailableForTagging establecida en false.

trimDeprecated
Tipo: System.Boolean

Un valor booleano que indica si se va a recortar términos que tienen Term.IsDeprecated establecido en true.

excludeKeyword
Tipo: System.Boolean

Un valor booleano que indica si se deben excluir los términos que se encuentran en las palabras clave TermSet

Valor devuelto

Tipo: Microsoft.SharePoint.Taxonomy.TermCollection
Una colección de todos los objetos de término de todos los TermSets 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 buscar sólo etiquetas predeterminadas y las opciones de recorte de determinados términos

Excepciones

Excepción	Condición
ArgumentNullException	El termLabel no puede ser nulo o 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 tienen Term.IsAvailableForTagging establecido en false se eliminarán de los resultados; de lo contrario, se devolverá todos los términos independientemente de su valor de Term.IsAvailableForTagging .

Si trimDeprecated es true términos que tienen Term.IsDeprecated establecido en true se eliminarán de los resultados; de lo contrario, se devolverá todos los términos independientemente de su valor de Term.IsDeprecated .

Si excludeKeyword es true, a continuación, se excluirá los términos en el termset palabras clave de la búsqueda; de lo contrario, todos los términos incluyen palabras clave se incluirán en la búsqueda.

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.