xtd::forms::find_event_args Class Reference

Definition

Provides data for the xtd::forms::find_dialog::find_next and xtd::forms::replace_dialog::find_next events.

Header

#include <xtd/forms/find_event_args> 

Namespace

xtd::forms

Library

xtd.forms

Examples:

find_box.cpp, find_dialog.cpp, replace_box.cpp, and replace_dialog.cpp.

Constructors
	find_event_args ()
	Initializes a new instance of the xtd::forms::find_event_args class. More...
	find_event_args (const xtd::ustring &find_string, bool match_case, xtd::forms::search_direction search_direction, bool whole_word)
	Initializes a new instance of the xtd::forms::find_event_args class. More...

Properties
const xtd::ustring &	find_string () const noexcept
	Gets the string to find. More...
bool	match_case () const noexcept
	Gets the match case value. More...
xtd::forms::search_direction	search_direction () const noexcept
	Gets the search direction value. More...
bool	whole_word () const noexcept
	Gets the whole word value. More...

Additional Inherited Members
Static Public Attributes inherited from xtd::event_args
static const event_args	empty
	Provides a value to use with events that do not have event data. More...
Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class. More...
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...

Constructor & Destructor Documentation

find_event_args() [1/2]

xtd::forms::find_event_args::find_event_args

(

)

Initializes a new instance of the xtd::forms::find_event_args class.

find_event_args() [2/2]

xtd::forms::find_event_args::find_event_args	(	const xtd::ustring &	find_string,
		bool	match_case,
		xtd::forms::search_direction	search_direction,
		bool	whole_word
	)

Initializes a new instance of the xtd::forms::find_event_args class.

Parameters

find_string	The string to find.
match_case	true if match case option selected; otherwise false.
search_direction	true if match case option selected; otherwise false.
whole_word	One of xtd::forms::search_direction values.

Member Function Documentation

find_string()

const xtd::ustring& xtd::forms::find_event_args::find_string ( ) const

noexcept

Gets the string to find.

Returns

The string to find.

Examples:

find_box.cpp, and replace_box.cpp.

match_case()

bool xtd::forms::find_event_args::match_case ( ) const

noexcept

Gets the match case value.

Returns

true if match case option selected; otherwise false. The default is false.

Examples:

find_box.cpp, and replace_box.cpp.

search_direction()

xtd::forms::search_direction xtd::forms::find_event_args::search_direction ( ) const

noexcept

Gets the search direction value.

Returns

One of xtd::forms::search_direction values; The default is xtd::forms::search_direction::down.

Examples:

find_box.cpp.

whole_word()

bool xtd::forms::find_event_args::whole_word ( ) const

noexcept

Gets the whole word value.

Returns

true if whole word option selected; otherwise false. The default is false.

Examples:

find_box.cpp, and replace_box.cpp.

---

The documentation for this class was generated from the following file:

• xtd.forms/include/xtd/forms/find_event_args.h