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

Article
03/15/2016

Cette méthode récupère une collection de tous les objets à terme, à partir de cette banque de termes que l'utilisateur actuel est autorisé à lire, ensembles de tous les termes qui ont une propriété personnalisée avec le nom de propriété fourni.

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

Syntaxe

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

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

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

Paramètres

customPropertyName
Type : System.String

Le nom de propriété personnalisée

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.

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, qui ont une propriété personnalisée avec le nom de propriété fourni.

Exceptions

Exception	Condition
ArgumentNullException	Le customPropertyName ne peut pas être null ou vide.
ArgumentException	La valeur de customPropertyName n'est pas valide. Probablement, il contient des caractères non valides ou est trop long.
ArgumentOutOfRangeException	La valeur resultCollectionSize n'est pas valide. Il doit être supérieur à 0.

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 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 les caractères suivants non conformes ; « < > | & onglet la valeur de resultCollectionSize doit être supérieur à 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.