TermStore.GetTerms - Méthode (String, Int32, Boolean, StringMatchOption, Int32, Boolean, Boolean, Boolean)

Article
03/15/2016

Obtient une collection de tous les objets de Term de tous les objets TermSet dans cet objet TermStore que l'utilisateur actuel est autorisé à lire avec une étiquette correspondant à la chaîne fournie dans un LCID, avec une option pour rechercher uniquement les étiquettes par défaut et les options pour ajuster certains termes.

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

Syntaxe

'Déclaration
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
'Utilisation
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
)

Paramètres

termLabel
Type : System.String

L'étiquette du terme à récupérer

lcid
Type : System.Int32

L'identificateur de paramètres régionaux des étiquettes à terme à mettre en correspondance.

defaultLabelOnly
Type : System.Boolean

Indique si seuls les libellés par défaut doivent être inclus dans la recherche.

stringMatchOption
Type : Microsoft.SharePoint.Taxonomy.StringMatchOption

Indique s'il faut rechercher des étiquettes qui commencent par la chaîne spécifiée, ou ceux qui ont une correspondance exacte.

resultCollectionSize
Type : System.Int32

Indique le nombre maximal d'objets de termes à inclure dans la TermCollection renvoyée.

trimUnavailable
Type : System.Boolean

Valeur booléenne indiquant s'il faut découper des termes qui ont Term.IsAvailableForTagging la valeur false.

trimDeprecated
Type : System.Boolean

Valeur booléenne indiquant s'il faut découper des termes qui ont Term.IsDeprecated la valeur true.

excludeKeyword
Type : System.Boolean

Une valeur booléenne indiquant s'il faut exclure des termes qui sont dans les mots clés TermSet

Valeur renvoyée

Type : Microsoft.SharePoint.Taxonomy.TermCollection
Une collection de tous les objets à terme à partir de tous les ensembles de termes dans cette banque de termes que l'utilisateur actuel est autorisé à lire avec une étiquette correspondant à la chaîne fournie dans un LCID, avec une option pour rechercher uniquement les étiquettes par défaut et les options pour ajuster certains termes

Exceptions

Exception	Condition
ArgumentNullException	Le termLabel ne peut pas être null ou vide.
ArgumentException	La valeur de termLabel n'est pas valide. Probablement, il contient des caractères non valides ou est trop long.

Remarques

Si trimUnavailable est true conditions de Term.IsAvailableForTagging la valeur false seront réduites à partir des résultats ; Sinon, tous les termes seront renvoyées quelle que soit leur valeur Term.IsAvailableForTagging .

Si trimDeprecated est true conditions de Term.IsDeprecated la valeur true seront réduites à partir des résultats ; Sinon, tous les termes seront renvoyées quelle que soit leur valeur Term.IsDeprecated .

Si excludeKeyword a la valeur true termes dans le mots clés termset seront exclues de la recherche ; Sinon, tous les termes incluent les mots clés sont inclus dans la recherche.

La recherche respecte la casse et doit correspondre à l'étiquette entière ou une vérification uniquement qu'elle commence par la chaîne spécifiée en fonction de la valeur du paramètre stringMatchOption .

Le nombre maximal de résultats renvoyés par cette recherche est limité par le paramètre resultCollectionSize .

Le termLabel ne peut pas être null ou vide et ne doit pas dépasser 255 caractères.

Il ne doit pas contenir les caractères suivants : ;"<>|&tab

Pour obtenir les résultats les plus précis, il est recommandé que toutes les modifications en attente soient validées dans la base de données à l'aide de CommitAll() avant l'exécution de cette recherche.