TaxonomySession.GetTermsInWorkingLocale Method

Searches Label objects in the TermStore working language, and returns Term objects from all TermSet objects, which are not scoped to a SPSite object, from all TermStore objects with a Label matching the provided string.

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

Syntax

'Declaration
Public Function GetTermsInWorkingLocale ( _
    termLabel As String, _
    defaultLabelOnly As Boolean, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean, _
    trimDeprecated As Boolean _
) As TermCollection
'Usage
Dim instance As TaxonomySession
Dim termLabel As String
Dim defaultLabelOnly As Boolean
Dim stringMatchOption As StringMatchOption
Dim resultCollectionSize As Integer
Dim trimUnavailable As Boolean
Dim trimDeprecated As Boolean
Dim returnValue As TermCollection

returnValue = instance.GetTermsInWorkingLocale(termLabel, _
    defaultLabelOnly, stringMatchOption, _
    resultCollectionSize, trimUnavailable, _
    trimDeprecated)

public TermCollection GetTermsInWorkingLocale(
    string termLabel,
    bool defaultLabelOnly,
    StringMatchOption stringMatchOption,
    int resultCollectionSize,
    bool trimUnavailable,
    bool trimDeprecated
)

Parameters

• termLabel
  Type: System.String

  String to search

• defaultLabelOnly
  Type: System.Boolean

  yes if it only searches default Label objects; no if it searches all Label objects.

• stringMatchOption
  Type: Microsoft.SharePoint.Taxonomy.StringMatchOption

  How the string is matched

• resultCollectionSize
  Type: System.Int32

  The maximum number of Term objects to return from each TermStore.

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

• trimDeprecated
  Type: System.Boolean

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

Return Value

Type: Microsoft.SharePoint.Taxonomy.TermCollection
Returns TermCollection.

See Also

Reference

TaxonomySession Class

TaxonomySession Members

Microsoft.SharePoint.Taxonomy Namespace