Método UserProperties.Add (Outlook)

Cria uma nova propriedade de usuário no conjunto UserProperties.

Sintaxe

expressão. Adicionar (Nome, Tipo, AddToFolderFields, DisplayFormat)

Expressão Uma variável que representa um objeto UserProperties .

Parâmetros

Nome	Obrigatório/Opcional	Tipo de dados	Descrição
Name	Obrigatório	String	O nome da propriedade. O comprimento máximo é de 64 caracteres. Os caracteres, ' [', ']', '_' e '#', não são permitidos no nome de usuário.
Type	Obrigatório	OlUserPropertyType	O tipo da nova propriedade.
AddToFolderFields	Opcional	O booleano será	True se a propriedade será adicionada como um campo personalizado para a pasta que o item está em. Este campo pode ser exibido no modo de exibição da pasta. False se a propriedade será adicionada como um campo personalizado para o item, mas não para a pasta. O valor padrão é True.
DisplayFormat	Opcional	Long	Especifica como a propriedade será exibida na interface de usuário do Outlook. Esse parâmetro pode ser definido como um valor de uma das várias enumerações diferentes, determinadas pela constante OlUserPropertyType especificada no parâmetro Type. Para obter mais informações sobre como Type e DisplayFormat interagem, consulte Propriedade DisplayFormat.

Valor de retorno

Um objeto UserProperty que representa a nova propriedade.

Comentários

É possível definir propriedades personalizadas chamando-se a dos métodos de UserProperties para um item do Outlook ou pasta ou o método Userdefinedproperties para uma pasta.

Você pode criar uma propriedade de um tipo definido pela enumeração OlUserPropertyType, exceto para os seguintes tipos: olEnumeration, olOutlookInternale olSmartFrom.

Para definir uma propriedade criada pelo método UserProperties pela primeira vez, use a propriedade UserProperty.Value em vez das SetProperties e os métodos de SetProperty do objeto PropertyAccessor.

Se você quiser exibir uma propriedade personalizada em um item, você deve usar o método UserProperties para criar essa propriedade. Propriedades personalizadas criadas pelo PropertyAccessor não são suportadas em uma exibição personalizada.

Você não pode adicionar propriedades personalizadas a itens de documento do Office, como arquivos do Word, Excel ou PowerPoint. Você receberá um erro ao tentar adicionar programaticamente um campo definido pelo usuário a um objeto DocumentItem .

Exemplo

Este exemplo do VBA cria um novo objeto ContactItem e adiciona "LastDateSpokenWith" como uma propriedade personalizada.

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

Este exemplo do VBA cria um novo objeto ContactItem e adiciona "Detalhes" como uma propriedade de usuário. O valor é definido, alterando a propriedade Value do objeto 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

Confira também

Objeto UserProperties

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.