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

Статья
03/15/2016

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

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

Синтаксис

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

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

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

Параметры

customPropertyName
Тип: System.String

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

resultCollectionSize
Тип: System.Int32

Максимальное число возвращаемых объектов Term .

trimUnavailable
Тип: System.Boolean

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

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

Тип: Microsoft.SharePoint.Taxonomy.TermCollection
Коллекция объектов Term со свойством с именем предоставляемого свойства.

Исключения

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

Замечания

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

customPropertyName не может быть пустая ссылка (Nothing в Visual Basic) или пустой и не должна превышать 255 знаков в длину.Он также не может содержать следующие недопустимые символы:tab;"<>|&. Значение resultCollectionSize должно быть больше, чем 0. Поиск без учета регистра.

Максимальное количество результатов, возвращаемых из поиска ограничено параметром resultCollectionSize .Чтобы получить наиболее точные результаты, корпорация Майкрософт рекомендует использовать метод CommitAll() для сохранения изменений в базе данных перед выполнением поиска.