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

Статья
03/15/2016

Получает коллекцию объектов Term из всех объектов TermSet в этот TermStore , у текущего пользователя есть разрешения на чтение с помощью объекта 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 TermStore
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

Термин, чтобы получить подпись

defaultLabelOnly
Тип: System.Boolean

Указывает, следует ли включать в поиск только метки по умолчанию.

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

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

resultCollectionSize
Тип: System.Int32

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

trimUnavailable
Тип: System.Boolean

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

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

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

Исключения

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

Замечания

Если trimUnavailable имеет значение true, затем термины, имеющие свойство Term.IsAvailableForTagging имеет значение false будут удалены из результатов; в противном случае будут возвращены все условия вне зависимости от их значения Term.IsAvailableForTagging. Этот метод будет осуществлять поиск всех Term.Labels на всех рабочих языках. Поиск без учета регистра и будет соответствовать только проверку, которая начинается с указанной строки в зависимости от значения параметра stringMatchOption или надписи. Максимальное количество результатов, возвращаемых из поиска ограничено параметром resultCollectionSize . termLabel не может быть неопределенным или пустым и не должна превышать 255 знаков в длину. Он также не может содержать следующие недопустимые символы:tab;"<>|&

Для получения наиболее точных результатов рекомендуется быть зафиксированы в базе данных с помощью CommitAll() до выполнения поиска, ожидающие изменения.