Método UserProperties.Add (Outlook)
Crea una propiedad nueva de usuario en la colección UserProperties.
Sintaxis
expresión. Agregar (Nombre, Tipo, AddToFolderFields, DisplayFormat)
Expresión Variable que representa un objeto UserProperties .
Parameters
| Nombre | Obligatorio/opcional | Tipo de datos | Descripción |
|---|---|---|---|
| Name | Obligatorio | String | El nombre de la propiedad. La longitud máxima es de 64 caracteres. Los caracteres, ' [', ']', '_' y '#', no se permiten en el nombre. |
| Type | Obligatorio | OlUserPropertyType | Tipo de la nueva propiedad. |
| AddToFolderFields | Opcional | Boolean | True si la propiedad se agregará como campo personalizado a la carpeta que el elemento se encuentra en. Este campo puede mostrarse en la vista de la carpeta. False si la propiedad se agregará como un campo personalizado para el elemento pero no para la carpeta. El valor predeterminado es True. |
| DisplayFormat | Opcional | Long | Especifica cómo se mostrará la propiedad en la interfaz de usuario de Outlook. Este parámetro se puede establecer en un valor de una de las distintas enumeraciones, determinadas por la constante OlUserPropertyType especificada en el parámetro Type. Para obtener más información sobre cómo interactúan Type y DisplayFormat, veaDisplayFormat (propiedad). |
Valor devuelto
Objeto UserProperty que representa la nueva propiedad.
Comentarios
Puede definir propiedades personalizadas llamando al método UserProperties.Add de un elemento de Outlook o la carpeta o al método UserDefinedProperties.Add de una carpeta.
Puede crear una propiedad de un tipo definido por la enumeración OlUserPropertyType, excepto los siguientes tipos: olEnumeration, olOutlookInternaly olSmartFrom.
Para establecer por primera vez una propiedad creada por el método UserProperties.Add, utilice la propiedad UserProperty.Value en lugar de los métodos de SetProperty del objeto PropertyAccessor y SetProperties.
Si desea ver una propiedad personalizada en un elemento, debe usar el método UserProperties.Add para crear la propiedad. Las propiedades personalizadas creadas por el PropertyAccessor no se admiten en una vista personalizada.
No puede agregar propiedades personalizadas a elementos de documento de Office tales como archivos de Word, Excel o PowerPoint. Aparecerá un error cuando intente agregar mediante programación un campo definido por el usuario a un objeto DocumentItem.
Ejemplo:
En el ejemplo siguiente de VBA se crea un nuevo objeto ContactItem y se agrega "LastDateSpokenWith" como propiedad 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
En este ejemplo VBA se crea un nuevo objeto ContactItem y se agrega "Details" como propiedad de usuario. El valor se establece cambiando la propiedad Value del 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
Consulte también
Soporte técnico y comentarios
¿Tiene preguntas o comentarios sobre VBA para Office o esta documentación? Vea Soporte técnico y comentarios sobre VBA para Office para obtener ayuda sobre las formas en las que puede recibir soporte técnico y enviar comentarios.