CustomProperties object (Excel)

A collection of CustomProperty objects that represents additional information. The information can be used as metadata for XML.

Remarks

Use the CustomProperties property of the Worksheet object to return a CustomProperties collection.

After a CustomProperties collection is returned, you can add metadata to worksheets and perform additional actions depending on which you choose to work with.

To add metadata to a worksheet, use the CustomProperties property with the Add method.

Example

The following example demonstrates this feature. In this example, Microsoft Excel adds identifier information to the active worksheet and returns the name and value to the user.

Sub CheckCustomProperties() 
 
 Dim wksSheet1 As Worksheet 
 
 Set wksSheet1 = Application.ActiveSheet 
 
 ' Add metadata to worksheet. 
 wksSheet1.CustomProperties.Add _ 
 Name:="Market", Value:="Nasdaq" 
 
 ' Display metadata. 
 With wksSheet1.CustomProperties.Item(1) 
 MsgBox .Name & vbTab & .Value 
 End With 
 
End Sub

Methods

• Add

Properties

• Application
• Count
• Creator
• Item
• Parent

See also

• Excel Object Model Reference

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.