Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create FindOnPage.md #4399

Open
wants to merge 81 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
fe8893d
Create FindOnPage.md
maxwellmyers Feb 27, 2024
eae4c7e
Update FindOnPage.md
maxwellmyers Feb 28, 2024
6c2f522
Update FindOnPage.md
maxwellmyers Feb 28, 2024
18600e6
Update FindOnPage.md
maxwellmyers Feb 28, 2024
f2c8a40
Update FindOnPage.md
maxwellmyers Mar 1, 2024
27cc5a1
Update FindOnPage.md
maxwellmyers Mar 4, 2024
866f3fe
Update FindOnPage.md
maxwellmyers Mar 4, 2024
bdcfbb5
Update FindOnPage.md
maxwellmyers Mar 5, 2024
bcb312d
Update FindOnPage.md
maxwellmyers Mar 6, 2024
0cbebb2
Update FindOnPage.md
maxwellmyers Mar 6, 2024
b88741d
Update FindOnPage.md
maxwellmyers Mar 7, 2024
9d9ef6d
Update FindOnPage.md
maxwellmyers Mar 7, 2024
09c3bd8
Update FindOnPage.md
maxwellmyers Mar 7, 2024
15050e2
Update FindOnPage.md
maxwellmyers Mar 7, 2024
121afee
Update FindOnPage.md
maxwellmyers Mar 7, 2024
83a0f0c
Update FindOnPage.md
maxwellmyers Mar 7, 2024
b1a63fb
Update FindOnPage.md
maxwellmyers Mar 8, 2024
af525b6
Update FindOnPage.md
maxwellmyers Mar 8, 2024
52ba7d4
Update FindOnPage.md
maxwellmyers Mar 8, 2024
e6c8905
Update FindOnPage.md
maxwellmyers Mar 8, 2024
42b3cdd
Update FindOnPage.md
maxwellmyers Mar 8, 2024
f0b9e32
Update FindOnPage.md
maxwellmyers Mar 8, 2024
2320ee1
Update FindOnPage.md
maxwellmyers Mar 8, 2024
5e54814
Update FindOnPage.md
maxwellmyers Mar 8, 2024
151f501
Update FindOnPage.md
maxwellmyers Mar 20, 2024
87f7dba
deleted 438-443
maxwellmyers Mar 28, 2024
e66ba7a
deleted usage example from the api def
maxwellmyers Mar 28, 2024
0a6971e
line length corrected
maxwellmyers Mar 28, 2024
4c87604
217 to 2_17
maxwellmyers Mar 28, 2024
d28354a
Update FindOnPage.md
maxwellmyers Mar 28, 2024
4de44af
Updated Callback in StartFind and the description of the find op comp…
maxwellmyers Mar 28, 2024
b3b07ae
Updated the Configure/Execute Find
maxwellmyers Mar 28, 2024
a74ffa9
Created a flow for using custom dialog and default dialog within star…
maxwellmyers Mar 28, 2024
a33d8c0
Update FindOnPage.md
maxwellmyers Mar 28, 2024
cb1913d
Update FindOnPage.md
maxwellmyers Mar 28, 2024
fcf1ebb
Update FindOnPage.md
maxwellmyers Mar 28, 2024
990ed88
Update FindOnPage.md
maxwellmyers Apr 1, 2024
2f71770
Update FindOnPage.md
maxwellmyers Apr 1, 2024
eeceaf0
Update FindOnPage.md
maxwellmyers Apr 1, 2024
e0a860c
Update FindOnPage.md
maxwellmyers Apr 1, 2024
5f4f6c7
Update FindOnPage.md
maxwellmyers Apr 1, 2024
7d1db17
Update FindOnPage.md
maxwellmyers Apr 1, 2024
b4e4f7d
Update FindOnPage.md
maxwellmyers Apr 17, 2024
9c6460b
Update FindOnPage.md
maxwellmyers Apr 24, 2024
f68c12c
Update FindOnPage.md
maxwellmyers May 2, 2024
7528998
Update FindOnPage.md
maxwellmyers May 2, 2024
374292a
Update FindOnPage.md
maxwellmyers May 3, 2024
e5cde96
Changed search to find
maxwellmyers May 3, 2024
1315049
Update FindOnPage.md
maxwellmyers May 3, 2024
0f40d23
Update FindOnPage.md
maxwellmyers May 3, 2024
9e9f995
Update FindOnPage.md
maxwellmyers May 3, 2024
6dd9024
Update FindOnPage.md
maxwellmyers May 3, 2024
24c70af
Update FindOnPage.md
maxwellmyers May 3, 2024
db2d318
Update FindOnPage.md
maxwellmyers May 6, 2024
57389cf
Update FindOnPage.md
maxwellmyers May 13, 2024
b9a14b6
changed shouldhighlight and supress dialiog
maxwellmyers May 13, 2024
0d2f601
Update FindOnPage.md
maxwellmyers May 13, 2024
99a713f
Update FindOnPage.md
maxwellmyers May 13, 2024
6ccdf17
Update FindOnPage.md
maxwellmyers May 13, 2024
b20d9a6
Update FindOnPage.md
maxwellmyers May 13, 2024
4788c42
Update FindOnPage.md
maxwellmyers May 13, 2024
d4be4a6
Update FindOnPage.md
maxwellmyers May 13, 2024
aa1a1e5
Update FindOnPage.md
maxwellmyers May 13, 2024
d2b65a2
Update FindOnPage.md
maxwellmyers May 14, 2024
c40a79b
added 2 default UI screenshots
maxwellmyers Jul 24, 2024
c062611
Update FindOnPage.md
maxwellmyers Jul 30, 2024
18ea6f5
Update FindOnPage.md
maxwellmyers Jul 30, 2024
c4988da
Update FindOnPage.md
maxwellmyers Jul 30, 2024
99bfd11
Update FindOnPage.md
maxwellmyers Jul 30, 2024
6eeaf1e
Changed FindConfig -> FindOptions
maxwellmyers Jul 30, 2024
05838bf
Update FindOnPage.md
maxwellmyers Aug 6, 2024
7e99d7d
Update FindOnPage.md
maxwellmyers Aug 6, 2024
3e608aa
Update FindOnPage.md
maxwellmyers Aug 21, 2024
c619dbb
Update FindOnPage.md
maxwellmyers Aug 21, 2024
3ed7d68
Update FindOnPage.md
maxwellmyers Aug 21, 2024
571626f
Update FindOnPage.md
maxwellmyers Aug 21, 2024
4257d86
Update FindOnPage.md
maxwellmyers Aug 21, 2024
5e6d5dd
Update FindOnPage.md
maxwellmyers Aug 23, 2024
d1299fc
Update FindOnPage.md
maxwellmyers Oct 15, 2024
1675000
Update FindOnPage.md with experimental find options/
maxwellmyers Jan 13, 2025
d1b34c0
Update FindOnPage.md for find session terminology
maxwellmyers Jan 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update FindOnPage.md
deleted duplicates
  • Loading branch information
maxwellmyers authored Feb 28, 2024
commit 6c2f522ea93ea3266898e1d4892dd2cfc1823829
116 changes: 26 additions & 90 deletions FindOnPage.md
Original file line number Diff line number Diff line change
@@ -183,96 +183,7 @@ typedef enum COREWEBVIEW2_FIND_DIRECTION {
/// Specifies a backwards find in the document.
COREWEBVIEW2_FIND_DIRECTION_BACKWARD
} COREWEBVIEW2_FIND_DIRECTION;
/// Interface defining the find configuration.
/// This interface provides the necessary methods and properties to configure a find operation.
[uuid(4A6ED732-DF08-4449-8949-3632A4DEBFCD), object, pointer_default(unique)]
interface ICoreWebView2FindConfiguration : IUnknown {
/// Gets the find term used for the find operation.
/// \return The find term.
[propget] HRESULT FindTerm([out, retval] LPWSTR* value);
/// Sets the find term to be used for the find operation.
/// \param[in] value The find term.
[propput] HRESULT FindTerm([in] LPCWSTR value);
/// Gets the direction of the find operation (forward or backward).
/// \return The find direction.
[propget] HRESULT FindDirection([out, retval] COREWEBVIEW2_FIND_DIRECTION* value);
/// Sets the direction for the find operation.
/// \param[in] value The find direction.
[propput] HRESULT FindDirection([in] COREWEBVIEW2_FIND_DIRECTION value);
/// Determines if the find operation is case sensitive.
/// \return TRUE if the find is case sensitive, FALSE otherwise.
[propget] HRESULT IsCaseSensitive([out, retval] BOOL* value);
/// Sets whether the find operation should be case sensitive.
/// \param[in] value TRUE to make the find case sensitive, FALSE otherwise.
[propput] HRESULT IsCaseSensitive([in] BOOL value);
/// Determines if only whole words should be matched during the find operation.
/// \return TRUE if only whole words should be matched, FALSE otherwise.
[propget] HRESULT ShouldMatchWord([out, retval] BOOL* value);
/// Sets whether to only match whole words during the find operation.
[propput] HRESULT ShouldMatchWord([in] BOOL value);
/// Gets the state of whether all matches are highlighted.
/// \return TRUE if all matches are highlighted, FALSE otherwise.
[propget] HRESULT ShouldHighlightAllMatches([out, retval] BOOL* value);
/// Sets the state to either highlight all matches or not.
[propput] HRESULT ShouldHighlightAllMatches([in] BOOL value);
/// Determines if the currently active match is highlighted.
/// \return TRUE if the active match is highlighted, FALSE otherwise.
[propget] HRESULT ShouldHighlightActiveMatch([out, retval] BOOL* value);
/// Sets whether to highlight the currently active match.
[propput] HRESULT ShouldHighlightActiveMatch([in] BOOL value);
/// Checks if a custom user interface is desired by end developer.
/// If TRUE, the default Find bar is not displayed.
/// \return TRUE if using a custom UI, FALSE if using the default.
[propget] HRESULT UseCustomUI([out, retval] BOOL* value);
/// Sets whether to use a custom UI for the Find operation.
[propput] HRESULT UseCustomUI([in] BOOL value);
/// Gets the index of the currently active match.
/// If there's no active find session but an attempt is made to change the active match index:
/// The function might crash if the global_match_id isn't found in the map.
/// It will clear any active match highlighting if there's a previously active frame.
/// It will either select a new active match or return an error through the callback if the frame associated with the match isn't valid.
/// \return The active match index.
[propget] HRESULT ActiveMatchIndex([out, retval] LONG* value);
/// Sets the index for the active match.
[propput] HRESULT ActiveMatchIndex([in] LONG value);
/// Gets the total count of matches found in the current document based on the last find criteria.
/// \return The total count of matches.
[propget] HRESULT MatchesCount([out, retval] LONG* value);
/**
* Passes the current highlighting settings to the underlying Mojo.
*
* This function retrieves the current text highlighting settings set by the user
* or the default system and ensures that they are used during any subsequent text
* find or highlight operations. This includes settings related to highlighting
* all matches, the active match, and any custom UI preferences.
*
* Users should call this function after changing any highlight settings to ensure
* that they are applied properly in the system.
*/
HRESULT PassHighlightSettings();
}
/// Handles the event that's fired when the match count changes.
[uuid(623EFBFB-A19E-43C4-B309-D578511D24AB), object, pointer_default(unique)]
interface ICoreWebView2FindMatchCountChangedEventHandler : IUnknown {
/// Provides the event args when the match count changes.
HRESULT Invoke(LONG matchesCount);
}
/// Handles the event that's fired when the active match index changes.
[uuid(623EFBF9-A19E-43C4-B309-D578511D24A9), object, pointer_default(unique)]
interface ICoreWebView2FindActiveMatchIndexChangedEventHandler : IUnknown {
/// Provides the event args when the active match index changes.
/// \param sender The sender of this event, representing the current instance of ICoreWebView2Find.
/// \param args The event args that contain the new active match index.
HRESULT Invoke(
[in] ICoreWebView2* sender,
[in] ICoreWebView2FindActiveMatchIndexChangedEventArgs* args);
}
/// Handles the event that's fired when the find operation completes.
[uuid(2604789D-9553-4246-8E21-B9C74EFAD04F), object, pointer_default(unique)]
interface ICoreWebView2FindOperationCompletedHandler : IUnknown {
/// Provides the event args when the find operation completes.
HRESULT Invoke(HRESULT value, LONG activeMatchIndex, LONG matchesCount);
}

// Interface defining the find configuration.
[uuid(4A6ED732-DF08-4449-8949-3632A4DEBFCD), object, pointer_default(unique)]
interface ICoreWebView2FindConfiguration : IUnknown {
@@ -329,6 +240,31 @@ interface ICoreWebView2FindConfiguration : IUnknown {
*/
HRESULT PassHighlightSettings();
}

/// Handles the event that's fired when the match count changes.
[uuid(623EFBFB-A19E-43C4-B309-D578511D24AB), object, pointer_default(unique)]
interface ICoreWebView2FindMatchCountChangedEventHandler : IUnknown {
/// Provides the event args when the match count changes.
HRESULT Invoke(LONG matchesCount);
}

/// Handles the event that's fired when the active match index changes.
[uuid(623EFBF9-A19E-43C4-B309-D578511D24A9), object, pointer_default(unique)]
interface ICoreWebView2FindActiveMatchIndexChangedEventHandler : IUnknown {
/// Provides the event args when the active match index changes.
/// \param sender The sender of this event, representing the current instance of ICoreWebView2Find.
/// \param args The event args that contain the new active match index.
HRESULT Invoke(
[in] ICoreWebView2* sender,
[in] ICoreWebView2FindActiveMatchIndexChangedEventArgs* args);
}
/// Handles the event that's fired when the find operation completes.
[uuid(2604789D-9553-4246-8E21-B9C74EFAD04F), object, pointer_default(unique)]
interface ICoreWebView2FindOperationCompletedHandler : IUnknown {
/// Provides the event args when the find operation completes.
HRESULT Invoke(HRESULT value, LONG activeMatchIndex, LONG matchesCount);
}

// Interface providing methods and properties for finding and navigating through text in the web view.
[uuid(7C49A8AA-2A17-4846-8207-21D1520AABC0), object, pointer_default(unique)]
interface ICoreWebView2Find : IUnknown {