Excel: Custom Worksheet Properties are not copied with worksheet

[ddanehl]

When a worksheet containing custom worksheet properties is copied, the properties are not copied with it.

Your Environment

• Platform [PC desktop, Mac, iOS, Office on the web]: PC desktop, Web
• Host [Excel, Word, PowerPoint, etc.]: Excel
• Office version number: Microsoft 365 MSO (Version 2502 Build 16.0.18526.20144) 64 Bit
• Operating System: Windows 11
• Browser (if using Office on the web): Edge, Chrome, Firefox

Expected behavior

Custom worksheet properties should be copied with the worksheet.

Current behavior

Custom worksheet properties are not copied with the worksheet

Steps to reproduce

1. Install ScriptLab
2. Open and Run "Custom Properties" example
3. Set a new worksheet property
4. Get all worksheet properties, they are printed in the console
5. Copy the worksheet
6. Get all worksheet properties for the new copied sheet, nothing is found, empty console log

Link to live example(s)

1. Official ScriptLab "Custom Properties" example

Context

We use custom sheet properties in our add-in to maintain metadata for the reports.
Users reported a bug to us that the reports stopped working on sheets which they did a copy of.

[microsoft-github-policy-service]

Thank you for letting us know about this issue. We will take a look shortly. Thanks.

[guoms1]

Hi, @ddanehl

I was able to reproduce the issue locally on both Excel Online and Excel Desktop. I’ve escalated this matter (#9900111) to our dedicated team, and we’re actively investigating it. Thank you for your patience, and I’ll keep you updated with any progress.

Best regards,

[amagupta-collab]

@ddanehl
The current behavior is by design and is not considered as a product bug. The behavior is consistent with VBA. Custom properties set via VBA are also not copied with sheet copy.
Workaround could be to get custom properties in advance and set again after copying.
If you would like us to consider enhancements or new capabilities in future releases, please submit your suggestion to the Microsoft Tech Community Ideas Forum or upvote an existing idea. This helps ensure that other developers with similar feature requests can also share feedback and show support.
🔗 Ideas Forum:
https://techcommunity.microsoft.com/t5/microsoft-365-developer-platform/idb-p/Microsoft365DeveloperPlatform
Thank you for your understanding and support!