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

Article
03/15/2016

Obtient une collection de tous les objets Term , à partir de tous les T:Microsoft.SharePoint.TaxonomyTermSets dans cette TermStore que l'utilisateur actuel est autorisé à lire, qui ont une propriété personnalisée à partir ou mise en correspondance du nom de propriété fourni et la valeur de la propriété fournie.

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

Syntaxe

'Déclaration
Public Function GetTermsWithCustomProperty ( _
    customPropertyName As String, _
    customPropertyValue As String, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Utilisation
Dim instance As TermStore
Dim customPropertyName As String
Dim customPropertyValue As String
Dim stringMatchOption As StringMatchOption
Dim resultCollectionSize As Integer
Dim trimUnavailable As Boolean
Dim returnValue As TermCollection

returnValue = instance.GetTermsWithCustomProperty(customPropertyName, _
    customPropertyValue, stringMatchOption, _
    resultCollectionSize, trimUnavailable)

public TermCollection GetTermsWithCustomProperty(
    string customPropertyName,
    string customPropertyValue,
    StringMatchOption stringMatchOption,
    int resultCollectionSize,
    bool trimUnavailable
)

Paramètres

customPropertyName
Type : System.String

Le nom de propriété personnalisée

customPropertyValue
Type : System.String

La valeur de la propriété personnalisée

stringMatchOption
Type : Microsoft.SharePoint.Taxonomy.StringMatchOption

Indique si pour rechercher une propriété personnalisée les noms et les valeurs qui commencent par les chaînes spécifiées ou rechercher celles qui exactement correspondre aux chaînes spécifiées.

resultCollectionSize
Type : System.Int32

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

trimUnavailable
Type : System.Boolean

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

Valeur renvoyée

Type : Microsoft.SharePoint.Taxonomy.TermCollection
Une collection de tous les objets Term , à partir de tous les objets de TermSet de cette TermStore que l'utilisateur actuel est autorisé à lire, qui ont une propriété personnalisée à partir ou mise en correspondance du nom de propriété spécifié et la valeur de propriété spécifiée.

Exceptions

Exception	Condition
ArgumentNullException	Le customPropertyName ne peut pas être une référence Null (Rien dans Visual Basic) ou vide.
ArgumentException	La valeur de customPropertyName n'est pas valide. Probablement, il contient des caractères non valides ou est trop long.
ArgumentNullException	Le customPropertyValue ne peut pas être une référence Null (Rien dans Visual Basic) ou vide.
ArgumentException	La valeur de customPropertyValue n'est pas valide. Elle dépasse la longueur maximale autorisée 255.
ArgumentException	La valeur de customPropertyValue n'est pas valide. Il contient le caractère non valide '\t', '\n' ou les deux.
ArgumentOutOfRangeException	Le resultCollectionSize n'est pas valide. Il doit être supérieur à 0.

Remarques

Si trimUnavailable est défini sur true conditions de Term.IsAvailableForTagging la valeur false seront réduites à partir des résultats ; Sinon, tous les termes correspondants seront renvoyées quelle que soit leur valeur Term.IsAvailableForTagging . Le customPropertyName ne peut pas être null ou vide et ne doit pas dépasser 255 caractères. Il ne doit pas contenir de la suivante caractères illégaux ;"<>|&tab le customPropertyValue 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 illégaux, \t ou \n. La valeur de resultCollectionSize doit être supérieure à 0. La recherche respecte la casse. Le nombre maximal de résultats renvoyés par cette recherche est limité par le paramètre resultCollectionSize . 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.