Represents a dialog box that displays find dialog.
Windows | macOS | Gnome | |
---|---|---|---|
Light | | ||
Dark | |
Constructors | |
find_dialog () | |
Initializes a new instance of the find_dialog class. More... | |
Properties | |
const xtd::ustring & | find_string () const noexcept |
Gets the string to find. More... | |
find_dialog & | find_string (const xtd::ustring &value) |
Sets the string to find. More... | |
xtd::drawing::point | location () const noexcept |
Gets the coordinates of the upper-left corner of the dialog relative to the upper-left corner of the screen. More... | |
find_dialog & | location (const xtd::drawing::point &value) |
Sets the coordinates of the upper-left corner of the dialog relative to the upper-left corner of the screen. More... | |
bool | match_case () const noexcept |
Gets the match case value. More... | |
find_dialog & | match_case (bool value) |
Sets the match case value. More... | |
xtd::forms::search_direction | search_direction () const noexcept |
Gets the search direction value. More... | |
find_dialog & | search_direction (xtd::forms::search_direction value) |
Gets the search direction value. More... | |
bool | show_match_case () const noexcept |
Gets a value that indicates whether match case option is shown. More... | |
find_dialog & | show_match_case (bool value) |
Sets a value that indicates whether match case option is shown. More... | |
bool | show_up_down () const noexcept |
Gets a value that indicates whether up down option is shown. More... | |
find_dialog & | show_up_down (bool value) |
Sets a value that indicates whether up down option is shown. More... | |
bool | show_whole_word () const noexcept |
Gets a value that indicates whether whole word option is shown. More... | |
find_dialog & | show_whole_word (bool value) |
Sets a value that indicates whether whole word option is shown. More... | |
const xtd::ustring & | title () const noexcept |
Gets the find dialog title. More... | |
find_dialog & | title (const xtd::ustring &value) |
Sets the find dialog title. More... | |
bool | whole_word () const noexcept |
Gets the whole word value. More... | |
find_dialog & | whole_word (bool value) |
Sets the whole word value. More... | |
Events | |
xtd::event< find_dialog, xtd::forms::find_event_handler > | find_next |
Occurs when the user click the find button. More... | |
xtd::event< find_dialog, xtd::forms::dialog_closed_event_handler > | dialog_closed |
Occurs when the user close the find dialog box with dialog close button or cancel button. More... | |
Methods | |
void | close () |
Closes the find dialog box. More... | |
void | reset () noexcept |
Resets all properties to default values. More... | |
void | show (const iwin32_window &owner) |
Runs find dialog box. More... | |
Additional Inherited Members | |
Public Member Functions inherited from xtd::object | |
object ()=default | |
Create a new instance of the ultimate base class object. More... | |
bool | equals (const object &obj) const noexcept |
Determines whether the specified object is equal to the current object. More... | |
virtual size_t | get_hash_code () const noexcept |
Serves as a hash function for a particular type. More... | |
virtual type_object | get_type () const noexcept |
Gets the type of the current instance. More... | |
template<typename object_t > | |
std::unique_ptr< object_t > | memberwise_clone () const noexcept |
Creates a shallow copy of the current object. More... | |
virtual xtd::ustring | to_string () const noexcept |
Returns a sxd::ustring that represents the current object. More... | |
Static Public Member Functions inherited from xtd::object | |
static bool | equals (const object &object_a, const object &object_b) noexcept |
Determines whether the specified object instances are considered equal. More... | |
static bool | reference_equals (const object &object_a, const object &object_b) noexcept |
Determines whether the specified object instances are the same instance. More... | |
Protected Member Functions inherited from xtd::forms::component | |
component () | |
Initialises a new instance of the component class. More... | |
virtual bool | can_raise_events () const noexcept |
Gets a value indicating whether the component can raise an event. More... | |
bool | design_mode () const noexcept |
Gets a value that indicates whether the component is currently in design mode. More... | |
xtd::forms::find_dialog::find_dialog | ( | ) |
Initializes a new instance of the find_dialog class.
void xtd::forms::find_dialog::close | ( | ) |
Closes the find dialog box.
|
noexcept |
find_dialog& xtd::forms::find_dialog::find_string | ( | const xtd::ustring & | value | ) |
|
noexcept |
Gets the coordinates of the upper-left corner of the dialog relative to the upper-left corner of the screen.
find_dialog& xtd::forms::find_dialog::location | ( | const xtd::drawing::point & | value | ) |
Sets the coordinates of the upper-left corner of the dialog relative to the upper-left corner of the screen.
value | The point that represents the upper-left corner of the dialog relative to the upper-left corner of its screen. |
|
noexcept |
Gets the match case value.
find_dialog& xtd::forms::find_dialog::match_case | ( | bool | value | ) |
Sets the match case value.
value | true if match case option selected; otherwise false. The default is false. |
|
noexcept |
Resets all properties to default values.
Property | Value |
---|---|
title | "" |
find_string | "" |
show_up_down | true |
show_whole_word | true |
show_match_case | true |
search_direction | xtd::forms::search_direction::down |
whole_word | false |
match_case | false |
|
noexcept |
Gets the search direction value.
find_dialog& xtd::forms::find_dialog::search_direction | ( | xtd::forms::search_direction | value | ) |
Gets the search direction value.
value | One of xtd::forms::search_direction values. The default is xtd::forms::search_direction::down. |
void xtd::forms::find_dialog::show | ( | const iwin32_window & | owner | ) |
Runs find dialog box.
|
noexcept |
Gets a value that indicates whether match case option is shown.
find_dialog& xtd::forms::find_dialog::show_match_case | ( | bool | value | ) |
Sets a value that indicates whether match case option is shown.
value | true if match case option is shown; otherwise false. The default is true. |
|
noexcept |
Gets a value that indicates whether up down option is shown.
find_dialog& xtd::forms::find_dialog::show_up_down | ( | bool | value | ) |
Sets a value that indicates whether up down option is shown.
value | true if up down option is shown; otherwise false. The default is true. |
|
noexcept |
Gets a value that indicates whether whole word option is shown.
find_dialog& xtd::forms::find_dialog::show_whole_word | ( | bool | value | ) |
Sets a value that indicates whether whole word option is shown.
value | true if whole word option is shown; otherwise false. The default is true. |
|
noexcept |
find_dialog& xtd::forms::find_dialog::title | ( | const xtd::ustring & | value | ) |
Sets the find dialog title.
value | The find dialog title. |
|
noexcept |
Gets the whole word value.
find_dialog& xtd::forms::find_dialog::whole_word | ( | bool | value | ) |
Sets the whole word value.
value | true if whole word option selected; otherwise false. The default is false. |
xtd::event<find_dialog, xtd::forms::dialog_closed_event_handler> xtd::forms::find_dialog::dialog_closed |
Occurs when the user close the find dialog box with dialog close button or cancel button.
xtd::event<find_dialog, xtd::forms::find_event_handler> xtd::forms::find_dialog::find_next |
Occurs when the user click the find button.