Partilhar via

TermSet.GetTermsWithCustomProperty Method (String, String, Boolean)

  • Artigo

Gets a collection of Term objects with a custom property with the provided property name and the provided property value.

Namespace:  Microsoft.SharePoint.Taxonomy
Assembly:  Microsoft.SharePoint.Taxonomy (in Microsoft.SharePoint.Taxonomy.dll)

Syntax

'Declaration
Public Function GetTermsWithCustomProperty ( _
    customPropertyName As String, _
    customPropertyValue As String, _
    trimUnavailable As Boolean _
) As TermCollection
'Usage
Dim instance As TermSet
Dim customPropertyName As String
Dim customPropertyValue As String
Dim trimUnavailable As Boolean
Dim returnValue As TermCollection

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

public TermCollection GetTermsWithCustomProperty(
    string customPropertyName,
    string customPropertyValue,
    bool trimUnavailable
)

Parameters

  • customPropertyName
    Type: System.String

    The custom property name

  • customPropertyValue
    Type: System.String

    The custom property value

Return Value

Type: Microsoft.SharePoint.Taxonomy.TermCollection
A collection of Term objects with a custom property with the provided property name and the provided property value

Exceptions

Exception Condition
ArgumentNullException

The customPropertyName cannot be a null reference (Nothing in Visual Basic) or empty.
ArgumentException

The value of customPropertyName is invalid. It probably contains invalid characters or is too long.
ArgumentNullException

The customPropertyValue cannot be a null reference (Nothing in Visual Basic) or empty.
ArgumentException

The value of customPropertyValue is invalid. It exceeds the maximum allowed length 255.
ArgumentException

The value of customPropertyValue is invalid. It contains invalidcharacter \t, \n, or both.

Remarks

If trimUnavailable is true, then Term objects with the IsAvailableForTagging property set to false will be trimmed from the results; otherwise all matching terms will be returned regardless of their IsAvailableForTagging property value.The customPropertyName cannot be a null reference (Nothing in Visual Basic) or empty, and must not exceed 255 characters in length.It also cannot contain any of the following illegal characters: ;"<>|&tab. The customPropertyValue cannot be a null reference (Nothing in Visual Basic) or empty, and must not exceed 255 characters in length. It also cannot contain any of the illegal characters \t or \n.The search is case-insensitive. A maximum of 100 results will be returned from this search. To get the most accurate results, Microsoft recommends using the CommitAll() method to commit any pending changes to the database before executing this search.

See Also

Reference

TermSet Class

TermSet Members

GetTermsWithCustomProperty Overload

Microsoft.SharePoint.Taxonomy Namespace

CustomProperties

GetTermsWithCustomProperty(String, Boolean)

GetTermsWithCustomProperty(String, Int32, Boolean)

GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean)

GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean)