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

Статья
03/15/2016

Возвращает коллекцию объектов Term с пользовательским свойством начиная с или соответствующих предоставленному имени свойства и значение указанного свойства.

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

Синтаксис

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

returnValue = instance.GetTermsWithCustomProperty(customPropertyName, _
    customPropertyValue, stringMatchOption, _
    resultCollectionSize, trimUnavailable)

public TermCollection GetTermsWithCustomProperty(
    string customPropertyName,
    string customPropertyValue,
    StringMatchOption stringMatchOption,
    int resultCollectionSize,
    bool trimUnavailable
)

Параметры

customPropertyName
Тип: System.String

Имя пользовательского свойства

customPropertyValue
Тип: System.String

Значение пользовательского свойства

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

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

resultCollectionSize
Тип: System.Int32

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

trimUnavailable
Тип: System.Boolean

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

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

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

Исключения

Исключение	Условие
ArgumentNullException	customPropertyName не может быть пустая ссылка (Nothing в Visual Basic) или.
ArgumentException	Недопустимое значение customPropertyName . Скорее всего, содержит недопустимые знаки или имеет слишком большую длину.
ArgumentNullException	customPropertyValue не может быть пустая ссылка (Nothing в Visual Basic) или.
ArgumentException	Недопустимое значение customPropertyValue . Он превышает максимально допустимую длину в 255.
ArgumentException	Недопустимое значение customPropertyValue . Он содержит invalidcharacter \tи \n.
ArgumentOutOfRangeException	resultCollectionSize является недопустимым. Оно должно быть больше, чем 0.

Замечания

Если trimUnavailable имеет значение true, затем Term объектов с установленным свойством IsAvailableForTagging для false будут удалены из результатов; в противном случае будут возвращены все совпадающие слова независимо от значения свойства IsAvailableForTagging .customPropertyName не может быть пустая ссылка (Nothing в Visual Basic) или пустой и не должна превышать 255 знаков в длину.Он также не может содержать следующие недопустимые символы:tab;"<>|&.

customPropertyValue не может быть пустая ссылка (Nothing в Visual Basic) или пустой и не должна превышать 255 знаков в длину. Он также не может содержать недопустимые символы \t или \n. Значение resultCollectionSize должно быть больше, чем 0. Поиск без учета регистра. Максимальное количество результатов, возвращаемых из поиска является restrictedby параметром resultCollectionSize . Чтобы получить наиболее точные результаты, корпорация Майкрософт рекомендует использовать метод CommitAll() для сохранения результатов в базе данных перед выполнением поиска.