Find Result Panel Customization

[abhik]

Hello Team,

We have a requirement to customize the display name shown in the 'Find in Files' result panel—specifically for entries under either the 'Resource' or 'Description' columns after executing a Find operation.
This is similar to a previous query discussed here: sdk-api-frameworks-document-types/topic26244.html

Currently, the panel displays references derived from the resource URL. For further clarity, please refer to the attached screenshot.

Find_Result_Panel.png

Could you please provide guidance on using the Oxygen plugin framework to customize these fields?

Thanks & Regards,
Abhi_K

[Radu]

Hi,
I'm afraid we do not have such an API, I added an internal issue based on your request, pasting the issue ID below for future reference:

EXM-56025 API to control the file name displayed in the Find in Files results

Maybe you could implement this workaround which would fix both cases:
post72670.html#p72670

Regards,
Radu

[abhik]

Hi Radu,

Thank you for your insights.
The previous issue regarding customization of the validation result panel was resolved using the ValidationProblemsFilter API - https://www.oxygenxml.com/InstData/Edit ... ilter.html

I was wondering — do we have a similar API available for customizing the 'Find in Files' result panel?

Thanks and Regards,
Abhi_K

[Radu]

Hi,
I'm afraid we do not have a similar API for Find in Files results.
Regards,
Radu

[abhik]

Hi Radu,

I understand that currently, there is no dedicated API available to update search results.
To address this limitation, I’d like to propose a potential workaround and get your thoughts on its feasibility -

I’ve noticed there are two types of tab keys for the search results panel:

• "Find all – {resource}" → displays all results for a specific resource
• "Find in Files" → displays results across multiple resources

- Are there any other tab key formats for search results that we should consider?

Based on these tab keys, we could retrieve the results from resultManager and update them by appending the filename to the description.

Code: Select all

            List<DocumentPositionedInfo> results = resultsManager.getAllResults(tabKey);
            updateDescriptionforResultItems(results);
            resultsManager.setResults(tabKey, results, ResultsManager.ResultType.GENERIC);

- Do you see this approach as viable? Could it potentially lead to any unintended side effects?

Additionally, at present, we can only update the search results based on user actions (e.g., selecting an option in a popup menu or clicking a custom button) after the find operation is executed and results are displayed.

- Is there an event or callback that notifies when the find operation has completed and results are shown, so that we can update the search result descriptions automatically, without requiring user interaction?

We’d appreciate your insights on this proposed approach.

Thanks and Regards,
Abhi_K

[Radu]

Hi,
The "ro.sync.exml.workspace.api.results.ResultsManager" API was added mostly to allow developers to add their own result tabs in the Oxygen Results view.
It has indeed API to access the list of results from a specific tab name but it does not have APIs to add a listener to notify you when a new tab with results is opened or when a new result is added to an existing tab. Especially as the "Find/Replace in Files" dynamically updates the results list as it iterates through the list of files...
Regards,
Radu

[abhik]

Hi Radu,

Thanks for sharing your valuable insights.
Could you please also provide an estimated timeline for the completion of EXM-56025 (API to control the file name displayed in the Find in Files results)?

Thanks and Regards,
Abhi_K

[Radu]

Hi,
I do not have a timeline for implementing this improvement, this is not high priority for us.
Regards,
Radu