Worksheet.CustomProperties Property (Excel)

Office 2013 and later

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

Returns a CustomProperties object representing the identifier information associated with a worksheet.

expression .CustomProperties

expression A variable that represents a Worksheet object.

For the CustomProperties property, identifier information for a worksheet can represent metadata for XML.

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