Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

TermStore.GetTerms method (String, Boolean)

Returns a collection of all Term objects from all TermSet objects in this TermStore that the current user has permissions to read with a Label object that matches the string provided in any LCID.

Namespace:  Microsoft.SharePoint.Taxonomy
Assembly:  Microsoft.SharePoint.Taxonomy (in Microsoft.SharePoint.Taxonomy.dll)
public TermCollection GetTerms(
	string termLabel,
	bool trimUnavailable
)

Parameters

termLabel
Type: System.String

The Label of the Term to retrieve

trimUnavailable
Type: System.Boolean

A Boolean indicating whether to trim out terms that have 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 with a Label matching the string provided in any LCID.
ExceptionCondition
ArgumentNullException

The termLabel cannot be a null reference (Nothing in Visual Basic) or empty.

ArgumentException

The value of termLabel is invalid. It probably containsinvalid characters or is too long.

If trimUnavailable is set to true, then terms that have IsAvailableForTagging set to false will be trimmed from the results; otherwise, all terms will be returned regardless of their IsAvailableForTagging value.

All Term.Labels in all working languages will be searched by this method. The search is case-insensitive, and returns a maimum of 100 results.

The termLabel cannot be null or empty, and must not exceed 255 characters in length.It also cannot contain any of the following illegal characters: ;"<>|&tab

To get the most accurate results it is recommended that any pending changes be committed to the database using CommitAll() prior to executing this search.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.