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

Article
03/15/2016

Obtient une collection d'objets Term avec une propriété personnalisée commençant par filtrage ou le 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 TermSet
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

Si vous souhaitez rechercher les noms des propriétés personnalisées et les valeurs qui commencent par les chaînes spécifiées ou recherchez ceux qui correspondent exactement aux chaînes spécifiées.

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
collection d'objets Term avec une propriété personnalisée à partir ou mise en correspondance du nom de propriété fourni et la valeur de la propriété fournie.

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 invalidcharacter, \t, \nou les deux.
ArgumentOutOfRangeException	Le resultCollectionSize n'est pas valide. Il doit être supérieur à 0.

Remarques

Si trimUnavailable a la valeur true, les objets Term avec la propriété IsAvailableForTagging la valeur false seront réduits à partir des résultats ; sinon tous les termes correspondants seront retournés, quel que soit leur valeur de la propriété IsAvailableForTagging .Le customPropertyName 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.

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 des caractères non autorisés, \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 restrictedby le paramètre resultCollectionSize . Pour obtenir les résultats les plus précis, Microsoft recommande l'utilisation de la méthode CommitAll() pour valider les résultats de la base de données avant l'exécution de cette recherche.