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

Article
03/15/2016

Obtient une collection de tous les objets de Term de tous les objets de TermSet de cette TermStore que l'utilisateur actuel est autorisé à lire avec un objet Label qui correspond à la chaîne fournie dans un LCID, avec une option pour la recherche d'étiquettes par défaut uniquement.

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

Syntaxe

'Déclaration
Public Function GetTerms ( _
    termLabel As String, _
    defaultLabelOnly As Boolean, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Utilisation
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
)

Paramètres

termLabel
Type : System.String

L'étiquette du terme pour obtenir

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 Term à inclure dans le renvoyé TermCollection.

trimUnavailable
Type : System.Boolean

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

Valeur renvoyée

Type : Microsoft.SharePoint.Taxonomy.TermCollection
Une collection de tous les objets de Term de tous les objets TermSet 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 la recherche d'étiquettes par défaut uniquement.

Exceptions

Exception	Condition
ArgumentNullException	Le termLabel ne peut pas être une référence Null (Rien dans Visual Basic) 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 a la valeur true les termes qui ont jeu Term.IsAvailableForTagging sur false seront supprimés à partir des résultats ; Sinon, tous les termes seront renvoyées quelle que soit leur valeur Term.IsAvailableForTagging. Tous les Term.Labels dans toutes les langues de travail sera recherchée par cette méthode. 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.