Share via

TermSet.GetTermsWithCustomProperty method (String, Int32, Boolean)

  • Article

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

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

Syntax

'Declaration
Public Function GetTermsWithCustomProperty ( _
    customPropertyName As String, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Usage
Dim instance As TermSet
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
)

Parameters

  • customPropertyName
    Type: System.String

    The custom property name

  • resultCollectionSize
    Type: System.Int32

    The maximum number of Term objects to be returned.

Return value

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

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.
ArgumentOutOfRangeException

The resultCollectionSize value is invalid. It must be greater than 0.

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 resultCollectionSize value must be greater than 0.The search is case-insensitive.

The maximum number of results returned from this search is restricted by the resultCollectionSize parameter.To get the most accurate results, Microsoft recommends using the CommitAll() method to commit 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, String, Boolean)

GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean)

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