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

Gets Term objects from all TermStore objects that have a property with the provided property name and the property value matching the provided value in the specified way.

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 TaxonomySession
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

  Property name

• customPropertyValue
  Type: System.String

  Property value

• stringMatchOption
  Type: Microsoft.SharePoint.Taxonomy.StringMatchOption

  How the property value is matched

• resultCollectionSize
  Type: System.Int32

  The maximum number of Term objects returned from each TermStore object

• trimUnavailable
  Type: System.Boolean

  yes if it trims away the unavailable Term objects from the result collection; no if it includes the unavailable Term objects in the result collection.

Return Value

Type: Microsoft.SharePoint.Taxonomy.TermCollection
A collection of Term objects

Remarks

Only TermSet objects.that are not scoped to a site and TermSet objects.that are scoped to current site are searched.

The search results are directly from the TermStore object. It may not be synchronized with changes that have been made but not committed. For best results, call the CommitAll method or call the RollbackAll method before calling this method.

See Also

Reference

TaxonomySession Class

TaxonomySession Members

GetTermsWithCustomProperty Overload

Microsoft.SharePoint.Taxonomy Namespace