TermSet.GetTerms Method (String, Int32, Boolean, StringMatchOption, Int32, Boolean)

Gets a collection of all Term objects from the current TermSet with a Label in the provided LCID matching the string provided, with an option to only search default labels.

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

Syntax

'Declaration
Public Function GetTerms ( _
    termLabel As String, _
    lcid As Integer, _
    defaultLabelOnly As Boolean, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Usage
Dim instance As TermSet
Dim termLabel As String
Dim lcid As Integer
Dim defaultLabelOnly As Boolean
Dim stringMatchOption As StringMatchOption
Dim resultCollectionSize As Integer
Dim trimUnavailable As Boolean
Dim returnValue As TermCollection

returnValue = instance.GetTerms(termLabel, _
    lcid, defaultLabelOnly, stringMatchOption, _
    resultCollectionSize, trimUnavailable)

public TermCollection GetTerms(
    string termLabel,
    int lcid,
    bool defaultLabelOnly,
    StringMatchOption stringMatchOption,
    int resultCollectionSize,
    bool trimUnavailable
)

Parameters

• termLabel
  Type: System.String

  The Label of the Term to get

• lcid
  Type: System.Int32

  The locale identifier of the Term.Labels to be matched

• defaultLabelOnly
  Type: System.Boolean

  Indicates whether only default labels should be included in the search.

• stringMatchOption
  Type: Microsoft.SharePoint.Taxonomy.StringMatchOption

  Whether to search for labels that start with the specified string, or those that have an exact match.

• resultCollectionSize
  Type: System.Int32

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

• trimUnavailable
  Type: System.Boolean

  A Boolean indicating whether to trim out [Term] objects that have the IsAvailableForTagging property set to false.

Return Value

Type: Microsoft.SharePoint.Taxonomy.TermCollection
A collection of all Term objects from the current TermSet with a Label in the provided LCID matching the string provided, with an option to only search default labels.

Exceptions

Exception	Condition
ArgumentNullException	The termLabel cannot be null or empty.
ArgumentException	The value of termLabel is invalid. It probably contains invalid characters or is too long.
ArgumentOutOfRangeException	The lcid value must be one of the working languages in the current TermStore object.

Remarks

If trimUnavailable is true, then Term objects with the IsAvailableForTagging property set to false will be trimmed from the results; otherwise all Term objects will be returned regardless of their IsAvailableForTagging value. All Term.Labels in the language matching the lcid parameter will be searched by this method. The search is case-insensitive, and will match either the entire label or only check that it starts with the specified string depending on the value of the stringMatchOption parameter. The maximum number of results returned from this search is restricted by the resultCollectionSize parameter.The termLabel 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 lcid value must be one of the working languages of the T:Microsoft.SharePoint.Taxonomy.TermStore object as specified by TermStore.Languages.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

GetTerms Overload

Microsoft.SharePoint.Taxonomy Namespace

GetDefaultLabel(Int32)

Labels

IsAvailableForTagging

GetTerms(String, Boolean)

GetTerms(String, Boolean, StringMatchOption, Int32, Boolean)

GetTerms(String, Int32, Boolean)