Partager via

UserProperties.Add Method

  • Article

Creates a new user property in the UserProperties collection.

Namespace:  Microsoft.Office.Interop.Outlook
Assembly:  Microsoft.Office.Interop.Outlook (in Microsoft.Office.Interop.Outlook.dll)

Syntax

'Declaration
<DispIdAttribute()> _
Function Add ( _
    Name As String, _
    Type As OlUserPropertyType, _
    AddToFolderFields As Object, _
    DisplayFormat As Object _
) As UserProperty
'Usage
Dim instance As UserProperties
Dim Name As String
Dim Type As OlUserPropertyType
Dim AddToFolderFields As Object
Dim DisplayFormat As Object
Dim returnValue As UserProperty

returnValue = instance.Add(Name, Type, _
    AddToFolderFields, DisplayFormat)

[DispIdAttribute()]
UserProperty Add(
    string Name,
    OlUserPropertyType Type,
    Object AddToFolderFields,
    Object DisplayFormat
)

Parameters

  • Name
    Type: System.String

    The name of the property. The maximum length is 64 characters. The characters, '[', ']', '_' and '#', are not permitted in the name.

  • AddToFolderFields
    Type: System.Object

    True if the property will be added as a custom field to the folder that the item is in. This field can be displayed in the folder's view. False if the property will be added as a custom field to the item but not to the folder. The default value is True.

  • DisplayFormat
    Type: System.Object

    Specifies how the property will be displayed in the Outlook user interface. This parameter can be set to a value from one of several different enumerations, determined by the OlUserPropertyType constant specified in the Type parameter. For more information on how Type and DisplayFormat interact, see DisplayFormat.

Return Value

Type: Microsoft.Office.Interop.Outlook.UserProperty
A UserProperty object that represents the new property.

Remarks

You can define custom properties by calling either the UserProperties.Add method for an Outlook item or folder, or the _UserDefinedProperties.Add method for a folder.

You can create a property of a type that is defined by the OlUserPropertyType enumeration, except for the following types: olEnumeration, olOutlookInternal, and olSmartFrom.

To set for the first time a property created by the Add method, use the Value property of the UserProperty object instead of the SetProperties(Object, Object) or SetProperty(String, Object) method of the PropertyAccessor object.

If you want to view a custom property on an item, you must use the UserProperties.Add method to create that property. Custom properties created by the PropertyAccessor are not supported in a custom view.

You cannot add custom properties to Office document items such as Word, Excel, or PowerPoint files. You will receive an error when you try to programmatically add a user-defined field to a DocumentItem object.

See Also

Reference

UserProperties Interface

UserProperties Members

Microsoft.Office.Interop.Outlook Namespace

Other Resources

How to: Ensure that Custom Item Properties Are Supported in Folder-Level Queries