Skip to content

Commit 7528998

Browse files
authored
Update FindOnPage.md
1 parent f68c12c commit 7528998

File tree

1 file changed

+41
-36
lines changed

1 file changed

+41
-36
lines changed

FindOnPage.md

Lines changed: 41 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -337,16 +337,16 @@ interface ICoreWebView2StagingFindMatchCountChangedEventHandler : IUnknown {
337337

338338

339339
/// Interface providing methods and properties for finding and navigating through text in the web view.
340-
/// This interface allows for text searches, navigation between matches, and customization of the find UI.
340+
/// This interface allows for finding text, navigation between matches, and customization of the find UI.
341341
// MSOWNERS: core ([email protected])
342-
[uuid(b21617e6-34a1-516d-846c-5615516afa90), object, pointer_default(unique)]
342+
[uuid(9c494a0a-c5d8-5fee-b7e6-4926d8d7b391), object, pointer_default(unique)]
343343
interface ICoreWebView2StagingFind : IUnknown {
344344
/// Retrieves the index of the currently active match in the find session. Returns the index of the currently active match, or -1 if there is no active match.
345345
// MSOWNERS: core ([email protected])
346346
[propget] HRESULT ActiveMatchIndex([out, retval] UINT32* value);
347347

348348

349-
/// Gets the total count of matches found in the current document based on the last search criteria. Returns the total count of matches.
349+
/// Gets the total count of matches found in the current document based on the last find sessions criteria. Returns the total count of matches.
350350
// MSOWNERS: core ([email protected])
351351
[propget] HRESULT MatchCount([out, retval] UINT32* value);
352352

@@ -361,47 +361,47 @@ interface ICoreWebView2StagingFind : IUnknown {
361361
[propput] HRESULT ShouldHighlightAllMatches([in] BOOL value);
362362

363363

364-
/// Gets the `SuppressDefaultDialog` property.
364+
/// Gets the `SuppressDefaultFindDialog` property.
365365
// MSOWNERS: core ([email protected])
366-
[propget] HRESULT SuppressDefaultDialog([out, retval] BOOL* value);
366+
[propget] HRESULT SuppressDefaultFindDialog([out, retval] BOOL* value);
367367

368368

369369
/// Checks if a custom user interface is desired by the end developer. Returns TRUE if using a custom UI, FALSE if using the default.
370370
// MSOWNERS: core ([email protected])
371-
[propput] HRESULT SuppressDefaultDialog([in] BOOL value);
371+
[propput] HRESULT SuppressDefaultFindDialog([in] BOOL value);
372372

373373

374374

375-
/// Adds an event handler for the `FindActiveMatchIndexChanged` event.
375+
/// Adds an event handler for the `ActiveMatchIndexChanged` event.
376376
/// Registers an event handler for the ActiveMatchIndexChanged event. This event is raised when the index of the currently active match changes. This can happen when the user navigates to a different match or when the active match is changed programmatically. The parameter is the event handler to be added. Returns a token representing the added event handler. This token can be used to unregister the event handler.
377377
// MSOWNERS: core ([email protected])
378-
HRESULT add_FindActiveMatchIndexChanged(
379-
[in] ICoreWebView2StagingFindActiveMatchIndexChangedEventHandler* eventHandler,
378+
HRESULT add_ActiveMatchIndexChanged(
379+
[in] ICoreWebView2StagingActiveMatchIndexChangedEventHandler* eventHandler,
380380
[out] EventRegistrationToken* token);
381381

382-
/// Removes an event handler previously added with `add_FindActiveMatchIndexChanged`.
382+
/// Removes an event handler previously added with `add_ActiveMatchIndexChanged`.
383383
// MSOWNERS: core ([email protected])
384-
HRESULT remove_FindActiveMatchIndexChanged(
384+
HRESULT remove_ActiveMatchIndexChanged(
385385
[in] EventRegistrationToken token);
386386

387-
/// Adds an event handler for the `FindMatchCountChanged` event.
388-
/// Registers an event handler for the MatchCountChanged event. This event is raised when the total count of matches in the document changes due to a new search operation or changes in the document. The parameter is the event handler to be added. Returns a token representing the added event handler. This token can be used to unregister the event handler.
387+
/// Adds an event handler for the `MatchCountChanged` event.
388+
/// Registers an event handler for the MatchCountChanged event. This event is raised when the total count of matches in the document changes due to a new find operation or changes in the document. The parameter is the event handler to be added. Returns a token representing the added event handler. This token can be used to unregister the event handler.
389389
// MSOWNERS: core ([email protected])
390-
HRESULT add_FindMatchCountChanged(
391-
[in] ICoreWebView2StagingFindMatchCountChangedEventHandler* eventHandler,
390+
HRESULT add_MatchCountChanged(
391+
[in] ICoreWebView2StagingMatchCountChangedEventHandler* eventHandler,
392392
[out] EventRegistrationToken* token);
393393

394-
/// Removes an event handler previously added with `add_FindMatchCountChanged`.
394+
/// Removes an event handler previously added with `add_MatchCountChanged`.
395395
// MSOWNERS: core ([email protected])
396-
HRESULT remove_FindMatchCountChanged(
396+
HRESULT remove_MatchCountChanged(
397397
[in] EventRegistrationToken token);
398398

399399

400-
/// Initiates a search using the specified configuration.
401-
/// Displays the Find bar and starts the search operation. If a search was already ongoing, it will be stopped and replaced with this new instance.
402-
/// If called with an empty string, the Find bar is displayed but no search occurs. Changing the configuration object after initiation won't affect the ongoing search.
403-
/// To change the ongoing search, StartFind must be called again with a new or modified configuration object.
404-
/// This method is primarily designed for HTML document searches.
400+
/// Initiates a find using the specified configuration.
401+
/// Displays the Find bar and starts the find operation. If a find session was already ongoing, it will be stopped and replaced with this new instance.
402+
/// If called with an empty string, the Find bar is displayed but no finding occurs. Changing the configuration object after initiation won't affect the ongoing find session.
403+
/// To change the ongoing find session, StartFind must be called again with a new or modified configuration object.
404+
/// This method is primarily designed for HTML document queries.
405405
// MSOWNERS: core ([email protected])
406406
HRESULT StartFind(
407407
[in] ICoreWebView2StagingFindConfiguration* configuration
@@ -556,18 +556,18 @@ namespace Microsoft.Web.WebView2.Core
556556
runtimeclass CoreWebView2Find : [default]ICoreWebView2Find {}
557557

558558
/// Interface providing methods and properties for finding and navigating through text in the web view.
559-
/// This interface allows for text searches, navigation between matches, and customization of the find UI.
559+
/// This interface allows for finding text, navigation between matches, and customization of the find UI.
560560
[com_interface("staging=ICoreWebView2StagingFind")]
561561
[ms_owner("core", "[email protected]")]
562562
[availability("staging")]
563563
interface ICoreWebView2Find
564564
{
565565
[completed_handler("")]
566-
/// Initiates a search using the specified configuration.
567-
/// Displays the Find bar and starts the search operation. If a search was already ongoing, it will be stopped and replaced with this new instance.
568-
/// If called with an empty string, the Find bar is displayed but no search occurs. Changing the configuration object after initiation won't affect the ongoing search.
569-
/// To change the ongoing search, StartFind must be called again with a new or modified configuration object.
570-
/// This method is primarily designed for HTML document searches.
566+
/// Initiates a find using the specified configuration.
567+
/// Displays the Find bar and starts the find operation. If a find session was already ongoing, it will be stopped and replaced with this new instance.
568+
/// If called with an empty string, the Find bar is displayed but no finding occurs. Changing the configuration object after initiation won't affect the ongoing find session.
569+
/// To change the ongoing find session, StartFind must be called again with a new or modified configuration object.
570+
/// This method is primarily designed for HTML document queries.
571571
Windows.Foundation.IAsyncAction StartFindAsync(CoreWebView2FindConfiguration configuration);
572572

573573
/// Navigates to the next match in the document.
@@ -583,21 +583,26 @@ namespace Microsoft.Web.WebView2.Core
583583
Boolean ShouldHighlightAllMatches { get; set; };
584584

585585
/// Checks if a custom user interface is desired by the end developer. Returns TRUE if using a custom UI, FALSE if using the default.
586-
Boolean SuppressDefaultDialog { get; set; };
586+
Boolean SuppressDefaultFindDialog { get; set; };
587587

588588
/// Retrieves the index of the currently active match in the find session. Returns the index of the currently active match, or -1 if there is no active match.
589-
UInt32 ActiveMatchIndex { get; };
589+
Int32 ActiveMatchIndex { get; };
590590

591-
/// Gets the total count of matches found in the current document based on the last search criteria. Returns the total count of matches.
592-
UInt32 MatchCount { get; };
591+
/// Gets the total count of matches found in the current document based on the last find sessions criteria. Returns the total count of matches.
592+
Int32 MatchCount { get; };
593593

594-
/// Registers an event handler for the MatchCountChanged event. This event is raised when the total count of matches in the document changes due to a new search operation or changes in the document. The parameter is the event handler to be added. Returns a token representing the added event handler. This token can be used to unregister the event handler.
594+
/// Registers an event handler for the MatchCountChanged event.
595+
This event is raised when the total count of matches in the document changes due to a new find operation or changes in the document.
596+
The parameter is the event handler to be added. Returns a token representing the added event handler. This token can be used to unregister the event handler.
595597
[event_handler("", "", "")]
596-
event Windows.Foundation.TypedEventHandler<CoreWebView2Find, Object> FindMatchCountChanged;
598+
event Windows.Foundation.TypedEventHandler<CoreWebView2Find, Object> MatchCountChanged;
597599

598-
/// Registers an event handler for the ActiveMatchIndexChanged event. This event is raised when the index of the currently active match changes. This can happen when the user navigates to a different match or when the active match is changed programmatically. The parameter is the event handler to be added. Returns a token representing the added event handler. This token can be used to unregister the event handler.
600+
/// Registers an event handler for the ActiveMatchIndexChanged event. This event is raised when the index of the currently active match changes.
601+
This can happen when the user navigates to a different match or when the active match is changed programmatically.
602+
The parameter is the event handler to be added. Returns a token representing the added event handler.
603+
This token can be used to unregister the event handler.
599604
[event_handler("", "", "")]
600-
event Windows.Foundation.TypedEventHandler<CoreWebView2Find, Object> FindActiveMatchIndexChanged;
605+
event Windows.Foundation.TypedEventHandler<CoreWebView2Find, Object> ActiveMatchIndexChanged;
601606
};
602607
}
603608
```

0 commit comments

Comments
 (0)