Метод TermSet.GetTerms (String, Boolean, StringMatchOption, Int32, Boolean)

Статья
03/15/2016

Возвращает коллекцию объектов Term из текущего объекта TermSet в любые LCID, с возможностью поиска меток по умолчанию только строкой matchingthe Label .

Пространство имен: Microsoft.SharePoint.Taxonomy
Сборка: Microsoft.SharePoint.Taxonomy (в Microsoft.SharePoint.Taxonomy.dll)

Синтаксис

'Декларация
Public Function GetTerms ( _
    termLabel As String, _
    defaultLabelOnly As Boolean, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Применение
Dim instance As TermSet
Dim termLabel As String
Dim defaultLabelOnly As Boolean
Dim stringMatchOption As StringMatchOption
Dim resultCollectionSize As Integer
Dim trimUnavailable As Boolean
Dim returnValue As TermCollection

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

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

Параметры

termLabel
Тип: System.String

Label для Term для получения

defaultLabelOnly
Тип: System.Boolean

true Если метки по умолчанию должны быть включены в поиск; в противном случае — false

stringMatchOption
Тип: Microsoft.SharePoint.Taxonomy.StringMatchOption

Следует ли для поиска меток, которые начинаются с указанной строки или те, которые имеют точное соответствие.

resultCollectionSize
Тип: System.Int32

Максимальное число Term объекты для включения в возвращаемый TermCollection объекта.

trimUnavailable
Тип: System.Boolean

Логическое значение, определяющее необходимость обрезать Term объекты, имеющие свойство IsAvailableForTagging значение false.

Возвращаемое значение

Тип: Microsoft.SharePoint.Taxonomy.TermCollection
Коллекция всех объектов Term из текущего TermSet с Label , совпадающие строки, предоставленный в любой LCID, с возможностью поиска только подписи по умолчанию.

Исключения

Исключение	Условие
ArgumentNullException	termLabel не может быть пустая ссылка (Nothing в Visual Basic) или.
ArgumentException	Недопустимое значение termLabel . Скорее всего, содержит недопустимые знаки или имеет слишком большую длину.

Замечания

Если trimUnavailabletrue, затем Term объектов с установленным свойством IsAvailableForTagging для false будут удалены из результатов; в противном случае будут возвращены все объекты Term вне зависимости от их значения IsAvailableForTagging . Этот метод будет осуществлять поиск всех Term.Labels на всех рабочих языках. Поиск без учета регистра и будет соответствовать только проверку, которая начинается с указанной строки в зависимости от значения параметраstringMatchOption или надписи. Максимальное количество результатов, возвращаемых из поиска ограничено параметром resultCollectionSize .termLabel не может быть пустая ссылка (Nothing в Visual Basic) или пустой и не должна превышать 255 знаков в длину.Он также не может содержать следующие недопустимые символы:tab;"<>|&. Чтобы получить наиболее точные результаты, корпорация Майкрософт рекомендует использовать метод CommitAll() для сохранения изменений базы данных перед выполнением поиска.