Share via

TermStore.GetTermsWithCustomProperty Method (String, String, StringMatchOption, Int32, Boolean)

  • Article

Gets a collection of all of the Term objects, from all T:Microsoft.SharePoint.TaxonomyTermSets in this TermStore that the current user has permissions to read, that have a custom property starting with or matching 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, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Usage
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
)

Parameters

  • customPropertyName
    Type: System.String

    The custom property name

  • customPropertyValue
    Type: System.String

    The custom property value

  • stringMatchOption
    Type: Microsoft.SharePoint.Taxonomy.StringMatchOption

    Indicates whether to search for custom property names and values that start with the specified strings, or search for those that exactly match the specified strings.

  • resultCollectionSize
    Type: System.Int32

    Indicates the maximum number of Term objects to include in the returned TermCollection object.

  • trimUnavailable
    Type: System.Boolean

    A Boolean indicating whether to trim out terms that have Term.IsAvailableForTagging set to false.

Return Value

Type: Microsoft.SharePoint.Taxonomy.TermCollection
A collection of all Term objects, from all TermSet objects in this TermStore that the current user has permissions to read, that have a custom property starting with or matching the specified property name, and the specified 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 invalid character '\t', '\n', or both.
ArgumentOutOfRangeException

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

Remarks

If trimUnavailable is set to true then terms that have Term.IsAvailableForTagging set to false will be trimmed from the results; otherwise all matching terms will be returned regardless of their Term.IsAvailableForTagging value. The customPropertyName cannot be null 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 null or empty, and must not exceed 255 characters in length.It also cannot contain the illegal characters \t or \n. 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 it is recommended that any pending changes be committed to the database using CommitAll() before executing this search.

See Also

Reference

TermStore Class

TermStore Members

GetTermsWithCustomProperty Overload

Microsoft.SharePoint.Taxonomy Namespace

CustomProperties

GetTermsWithCustomProperty(String, Boolean)

GetTermsWithCustomProperty(String, Int32, Boolean)

GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean)

GetTermsWithCustomProperty(String, String, Boolean)