Метод UserProperties.Add (Outlook)

Статья
04/07/2023

Создает новое свойство пользователя в коллекции UserProperties .

Синтаксис

expression. Add (Name, Type, AddToFolderFields, DisplayFormat)

Выражение Переменная, представляющая объект UserProperties .

Параметры

Имя	Обязательный или необязательный	Тип данных	Описание
Name	Обязательный	String	Имя свойства. Максимальная длина: 64 символа. Символы "[", "]", "_" и "#" не допускаются в имени.
Тип	Обязательный	OlUserPropertyType	Тип нового свойства.
AddToFolderFields	Необязательный	Логический	Значение true , если свойство будет добавлено в качестве настраиваемого поля в папку, в которую находится элемент. Это поле может отображаться в представлении папки. False , если свойство будет добавлено в качестве настраиваемого поля в элемент, но не в папку. Значение по умолчанию — True.
DisplayFormat	Необязательный	Long	Указывает, как свойство будет отображаться в пользовательском интерфейсе Outlook. Для этого параметра можно задать значение из одного из нескольких различных перечислений, определяемых константой OlUserPropertyType , указанной в параметре Type . Дополнительные сведения о взаимодействии Type и DisplayFormat см. в разделе Свойство DisplayFormat.

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

Объект UserProperty , представляющий новое свойство.

Замечания

Пользовательские свойства можно определить, вызвав метод UserProperties.Add для элемента или папки Outlook или метод UserDefinedProperties.Add для папки.

Можно создать свойство типа, определенного перечислением OlUserPropertyType , за исключением следующих типов: olEnumeration, olOutlookInternal и olSmartFrom.

Чтобы впервые задать свойство, созданное методом UserProperties.Add , используйте свойство UserProperty.Value вместо методов SetProperties и SetProperty объекта PropertyAccessor .

Если вы хотите просмотреть пользовательское свойство элемента, необходимо использовать метод UserProperties.Add для создания этого свойства. Пользовательские свойства, созданные PropertyAccessor , не поддерживаются в пользовательском представлении.

Вы не можете добавлять настраиваемые свойства в элементы документов Office, такие как Word, Excel или файлы PowerPoint. При попытке программного добавления определяемого пользователем поля в объект DocumentItem появится сообщение об ошибке.

Пример

В этом примере VBA создается новый объект ContactItem и добавляется lastDateSpokenWith в качестве настраиваемого свойства.

Sub AddUserProperty() 
 Dim myItem As Outlook.ContactItem 
 Dim myUserProperty As Outlook.UserProperty 
 
 Set myItem = Application.CreateItem(olContactItem) 
 Set myUserProperty = myItem.UserProperties _ 
 .Add("LastDateSpokenWith", olDateTime) 
 myItem.Display 
End Sub

В этом примере VBA создается новый объект ContactItem и добавляется значение Details в качестве свойства пользователя. Значение задается путем изменения свойства Value объекта UserProperty .

Sub AddUserProperty() 
 Dim myItem As Outlook.ContactItem 
 Dim myUserProperty As Outlook.UserProperty 
 
 Set myItem = Application.CreateItem(olContactItem) 
 Set myUserProperty = myItem.UserProperties _ 
 .Add("Details", olText) 
 myUserProperty.Value = "Neighbor" 
 myItem.Display 
End Sub

См. также

Объект UserProperties

Поддержка и обратная связь

Есть вопросы или отзывы, касающиеся Office VBA или этой статьи? Руководство по другим способам получения поддержки и отправки отзывов см. в статье Поддержка Office VBA и обратная связь.

Поделиться через