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

Article
03/15/2016

Obtient une collection de tous les objets de Term à partir de l' actuel TermSet avec un Label dans le LCID fourni correspond à la chaîne fournie, avec une option pour que les étiquettes par défaut recherche.

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 _
) As TermCollection
'Utilisation
Dim instance As TermSet
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 returnValue As TermCollection

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

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

Paramètres

termLabel
Type : System.String

Le Label de l' Term pour obtenir

lcid
Type : System.Int32

L'identificateur de paramètres régionaux de l' Term.Labels à 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

Si la recherche d'étiquettes qui commencent par la chaîne spécifiée, ou ceux qui ont une correspondance exacte.

resultCollectionSize
Type : System.Int32

Le nombre maximal d'objets de termes à inclure dans l'objet retourné TermCollection .

trimUnavailable
Type : System.Boolean

Valeur booléenne indiquant s'il faut rogner des objets [Term] 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 à partir de l' actuel TermSet avec un Label dans le LCID fourni correspond à la chaîne fournie, avec une option permettant de rechercher uniquement les étiquettes par défaut.

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.
ArgumentOutOfRangeException	La valeur de lcid doit être l'une des langues de travail dans l'objet TermStore en cours.

Remarques

Si trimUnavailable est true, les objets Term avec la propriété IsAvailableForTagging la valeur false seront réduits à partir des résultats ; Sinon, tous les objets Term seront retournés, quel que soit leur valeur IsAvailableForTagging . Tous les Term.Labels dans la langue correspondant au paramètre lcid 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 une référence Null (Rien dans Visual Basic) ou vide et ne doit pas dépasser 255 caractères.Il ne doit pas contenir les caractères suivants : ;"<>|&tab. La valeur de lcid doit être l'une des langues de travail de l'objet T:Microsoft.SharePoint.Taxonomy.TermStore spécifié par TermStore.Languages.Pour obtenir les résultats les plus précis, Microsoft recommande l'utilisation de la méthode CommitAll() pour valider les modifications apportées à la base de données avant l'exécution de cette recherche.