helpUrl in Excel custom function

Question

Hello everyone,

I'm currently developing an Excel add-in which includes a custom function. I'm at the point where everything is working and the only thing missing is setting up the helpUrl. I've added the URL in the custom function docstring as stated here and created a page with the information on how to use the function. When I try to click on the "More help on this function" link I've noticed that the information opens in a new tab in the browser, while trying the same with any of the built-in functions the information opens in a small window. I've submitted the add-in for review and it's been rejected because they say when they click on the link they get a "No help available" popup. What am I missing? Is there something else to configure?

Thank you in advance.

Answer 1

Thank you for the clarification. I apologize for any confusion in my previous response.

If you are using JSDoc tags to document your custom functions in Excel add-ins, and the URL is not appearing as expected in the "More help on this function" link within the Formula Builder tab, there might be a few possible reasons for this:

1. Incorrect JSDoc Format: Make sure that you have followed the correct JSDoc format for the URL tag. The correct format should be something like this:

/\*\*
 \* Function description.
 \* @param {parameter\_type} parameter\_name - Parameter description.
 \* @returns {return\_type} Return description.
 \* @see {@link URL}
 \*/
function functionName(parameter\_name) {
  // Function implementation.
}

Ensure that you have properly used the {@link URL} tag to reference the URL you want to link to.

2. Add-in Manifest: Verify that you have properly specified the custom function in the add-in manifest file (manifest.xml). Ensure that the add-in supports the specified custom function and that the manifest is correctly configured.
3. Cache Refresh: Excel might cache the add-in metadata, including the function documentation. In some cases, it might take some time for the changes to be reflected in the Formula Builder tab. Try restarting Excel or clearing the cache to see if the URL appears correctly.
4. Office Version: Ensure that you are using a supported version of Office/Excel that fully supports the feature. The URL link in the "More help on this function" feature might be available in specific versions of Office.

If you have followed the correct format and are still facing issues, I recommend checking Microsoft's official documentation and developer community forums for any known issues or updates regarding the use of JSDoc tags and URL linking in Excel add-ins.

If the problem persists, consider reaching out to Microsoft support or the developer community for further assistance.

Answer 2

The URL is not inserted using HTML and JS on my side. It's a JSDoc tag that you can use as stated in the documentation. It's then handled internally by Excel and added to the Formual Builder tab where "More help on this function" link is shown.

Answer 3

If you have confirmed that the URL is correct and publicly accessible, and the link is opening successfully in a new tab, but you want it to open in a small window like the built-in functions, there might be an issue with the way the link is being handled in your custom function add-in. Here are a few things to check and consider:

Ensure Target Attribute: Make sure that the link in your custom function add-in is not explicitly set to open in a new tab. In HTML, links can have a "target" attribute that determines how the link should be opened. If the "target" attribute is set to "_blank," it will force the link to open in a new tab. Remove any "target" attribute or set it to "_self" to ensure the link opens in the same window.

Check JavaScript Behavior: Review the JavaScript code in your add-in that handles the click event for the "More help on this function" link. Ensure that there are no specific instructions to open the link in a new tab. If there is any code that is explicitly opening the link in a new tab, modify it to open in a small window or use a dialogue box.

Answer 4

Hi Ajibola,

Thanks for the quick response. The URL is confirmed to be correct and publicly accessible. I've tried with other URLs but it keeps opening on a new tab instead of in a small window. The fact that clicking on the "More help on this function" link opens the page successfully makes me think that I'm on the right path, the only issue is that it doesn't open in a new window, and I think this is also why it's not opening properly for the people reviewing the Add-in.

Regards.

Answer 5

Hi,

I'm Ajibola, an Independent Consultant here and a Microsoft user like you. I don't work for Microsoft.

It sounds like you have followed the steps to add the helpUrl to your custom function docstring. However, when you click on the "More help on this function" link, it opens in a new tab in the browser instead of a small window like the built-in functions.

I found an article that explains how to create custom functions in Excel ². According to this article, when you define a custom function in code, you can include a @HelpUrl comment that specifies a URL for more information about the function. When users click "More help on this function" in Excel, Excel opens the URL in a small window.

If you have already done this and it's still not working, I suggest checking if the URL is correct and accessible. You can also try using a different URL to see if it works.

Reference (1) Create custom functions in Excel - Office Add-ins. https://learn.microsoft.com/en-us/office/dev/add-ins/excel/custom-functions-overview. (2) Excel failing to load basic custom functions add-in. https://stackoverflow.com/questions/57994822/excel-failing-to-load-basic-custom-functions-add-in. (3) Excel add-ins overview - Office Add-ins | Microsoft Learn. https://learn.microsoft.com/en-us/office/dev/add-ins/excel/excel-add-ins-overview.

I hope this helps! Let me know if you have any other questions.

Kind regards Ajibola