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

Article
03/15/2016

Obtient une collection de tous les objets de Term à partir de l'objet en cours de TermSet avec une chaîne de matchingthe Label 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 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
)

Paramètres

termLabel
Type : System.String

Le Label de l' Term pour obtenir

defaultLabelOnly
Type : System.Boolean

true si les libellés par défaut doivent être inclus dans la recherche ; dans le cas contraire, false

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 Term à 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 correspondant à la chaîne fournie dans un LCID, 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.

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 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ètrestringMatchOption . 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. 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.