xtd - Reference Guide 0.2.0
xtd::forms::replace_event_args Class Reference

#include <replace_event_args.h>

Definition

Provides data for the xtd::forms::fnd_dialog::find_next event.

Namespace
xtd::forms
Library
xtd.forms

Constructors

 replace_event_args ()=default
 Initializes a new instance of the xtd::forms::replace_event_args class. More...
 
 replace_event_args (const xtd::ustring &find_string, const xtd::ustring &replace_string, bool match_case, bool whole_word)
 Initializes a new instance of the xtd::forms::replace_event_args class. More...
 

Properties

const xtd::ustringfind_string () const
 Gets the string to find. More...
 
const xtd::ustringreplace_string () const
 Gets the replaced string. More...
 
bool match_case () const
 Gets the match case value. More...
 
bool whole_word () const
 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...
 
virtual 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...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. 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

◆ replace_event_args() [1/2]

xtd::forms::replace_event_args::replace_event_args ( )
default

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

◆ replace_event_args() [2/2]

xtd::forms::replace_event_args::replace_event_args ( const xtd::ustring find_string,
const xtd::ustring replace_string,
bool  match_case,
bool  whole_word 
)
inline

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

Parameters
find_stringThe string to find.
replace_stringA string that specifies the replaced text.
match_casetrue if match case option selected; otherwise false.
whole_wordOne of xtd::forms::search_direction values.

Member Function Documentation

◆ find_string()

const xtd::ustring& xtd::forms::replace_event_args::find_string ( ) const
inline

Gets the string to find.

Returns
The string to find.

◆ match_case()

bool xtd::forms::replace_event_args::match_case ( ) const
inline

Gets the match case value.

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

◆ replace_string()

const xtd::ustring& xtd::forms::replace_event_args::replace_string ( ) const
inline

Gets the replaced string.

Returns
The replaced string.

◆ whole_word()

bool xtd::forms::replace_event_args::whole_word ( ) const
inline

Gets the whole word value.

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

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