xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::replace_event_args Class Reference
Inheritance diagram for xtd::forms::replace_event_args:
xtd::event_args xtd::object

Definition

Provides data for the xtd::forms::replace_dialog::replace and xtd::forms::replace_dialog::replace_all events.

Header
#include <xtd/forms/replace_event_args>
Namespace
xtd::forms
Library
xtd.forms
Examples
replace_box.cpp, and replace_dialog.cpp.

Public Constructors

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

Public Properties

const xtd::stringfind_string () const noexcept
 Gets the string to find.
 
const xtd::stringreplace_string () const noexcept
 Gets the replaced string.
 
bool match_case () const noexcept
 Gets the match case value.
 
bool whole_word () const noexcept
 Gets the whole word value.
 

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.
 
- Public Member Functions inherited from xtd::event_args
 event_args ()=default
 Initializes a new instance of the event_args class.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

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::string find_string,
const xtd::string 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::string & xtd::forms::replace_event_args::find_string ( ) const
inlinenoexcept

Gets the string to find.

Returns
The string to find.

◆ replace_string()

const xtd::string & xtd::forms::replace_event_args::replace_string ( ) const
inlinenoexcept

Gets the replaced string.

Returns
The replaced string.

◆ match_case()

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

Gets the match case value.

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

◆ whole_word()

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

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: