xtd::forms::exception_dialog Class Reference

Definition

Represents a common dialog box that displays exception dialog.

Header

#include <xtd/forms/exception_dialog> 

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light	html dialog_exception_dialog_m.png    html dialog_exception_dialog_g.png
Dark	html dialog_exception_dialog_md.png    html dialog_exception_dialog_gd.png

Examples

The following code example demonstrates the use of exception_dialog dialog.

#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/exception_dialog>
#include <xtd/forms/form>
#include <xtd/invalid_operation_exception>

using namespace xtd;
using namespace xtd::forms;

class form1 : public form {
public:
  form1() {
    text("Exception dialog example");
    controls().push_back(button1);
    
    button1.location({10, 10});
    button1.auto_size(true);
    button1.text("Exception...");
    button1.click += [&] {
      try {
        throw invalid_operation_exception("Throws an invalid operation exception to show an exception dialog.", current_stack_frame_);
      } catch (const xtd::system_exception& e) {
        auto dialog = exception_dialog {};
        dialog.exception(e);
        if (dialog.show_sheet_dialog(*this) == dialog_result::cancel)
          application::exit();
      }
    };
  }
  
private:
  button button1;
};

auto main()->int {
  application::run(form1 {});
}

Examples:

exception_dialog.cpp.

Constructors
	exception_dialog ()
	Initializes a new instance of the exception_dialog class. More...

Properties
xtd::forms::dialog_result	dialog_result () const noexcept
	Gets async dialog_result result after dialog box is closing. More...
xtd::forms::dialog_appearance	dialog_appearance () const noexcept
	Gets the dialog appearance. More...
exception_dialog &	dialog_appearance (xtd::forms::dialog_appearance dialog_appearance)
	Sets the dialog appearance. More...
std::reference_wrapper< const std::exception >	exception () const noexcept
	Gets exception reference. More...
exception_dialog &	exception (const std::exception &exception)
	Sets exception. More...
xtd::ustring	text () const noexcept
	Gets the dialog caption text. More...
exception_dialog &	text (const xtd::ustring &text)
	Sets the dialog caption text. More...

Methods
void	reset () noexcept
	Resets all properties to empty string. More...
xtd::forms::dialog_result	show_dialog ()
	Runs exception dialog box. More...
xtd::forms::dialog_result	show_dialog (const iwin32_window &owner)
	Runs exception dialog box. More...
void	show_sheet (const iwin32_window &owner)
	Runs exception dialog box. More...
xtd::forms::dialog_result	show_sheet_dialog (const iwin32_window &owner)
	Runs exception dialog box. More...

Events
event< exception_dialog, dialog_closed_event_handler >	dialog_closed
	Occurs when the user close an exception dialog box with dialog close button or other dialog buttons. More...

Protected methods
void	on_dialog_closed (const dialog_closed_event_args &e)
	Raises the close event. 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...

Constructor & Destructor Documentation

exception_dialog()

xtd::forms::exception_dialog::exception_dialog

(

)

Initializes a new instance of the exception_dialog class.

Member Function Documentation

dialog_appearance() [1/2]

xtd::forms::dialog_appearance xtd::forms::exception_dialog::dialog_appearance ( ) const

noexcept

Gets the dialog appearance.

Returns

One of the xtd::forms::dialog_appearance values. The default value is xtd::forms::dialog_appearance::standard.

dialog_appearance() [2/2]

exception_dialog& xtd::forms::exception_dialog::dialog_appearance

(

xtd::forms::dialog_appearance

dialog_appearance

)

Sets the dialog appearance.

Parameters

dialog_appearance

One of the xtd::forms::dialog_appearance values. The default value is xtd::forms::dialog_appearance::standard.

Returns

Current exception_dialog instance.

dialog_result()

xtd::forms::dialog_result xtd::forms::exception_dialog::dialog_result ( ) const

noexcept

Gets async dialog_result result after dialog box is closing.

Returns

ok if the user clicks OK in the dialog box; otherwise, cancel.

exception() [1/2]

std::reference_wrapper<const std::exception> xtd::forms::exception_dialog::exception ( ) const

noexcept

Gets exception reference.

Returns

A exception reference.

Examples:

exception_dialog.cpp.

exception() [2/2]

exception_dialog& xtd::forms::exception_dialog::exception

(

const std::exception &

exception

)

Sets exception.

Parameters

exception

The exception.

Returns

Current exception_dialog instance.

Warning

Contains only a reference on the parameter exception. Do not delete exception before closing dialog.

on_dialog_closed()

void xtd::forms::exception_dialog::on_dialog_closed ( const dialog_closed_event_args &  e )

protected

Raises the close event.

Parameters

e	An exception_dialog_closed_event_args that provides the event data.

Remarks

This method is invoked when the exception dialog box is closed.

reset()

void xtd::forms::exception_dialog::reset ( )

noexcept

Resets all properties to empty string.

show_dialog() [1/2]

xtd::forms::dialog_result xtd::forms::exception_dialog::show_dialog

(

)

Runs exception dialog box.

show_dialog() [2/2]

xtd::forms::dialog_result xtd::forms::exception_dialog::show_dialog

(

const iwin32_window &

owner

)

Runs exception dialog box.

show_sheet()

void xtd::forms::exception_dialog::show_sheet

(

const iwin32_window &

owner

)

Runs exception dialog box.

Remarks

The result will done in async. Check result_dialog property after dialog box closed to obtain the result.

show_sheet_dialog()

xtd::forms::dialog_result xtd::forms::exception_dialog::show_sheet_dialog

(

const iwin32_window &

owner

)

Runs exception dialog box.

text() [1/2]

xtd::ustring xtd::forms::exception_dialog::text ( ) const

noexcept

Gets the dialog caption text.

Returns

The current dialog caption text.

text() [2/2]

exception_dialog& xtd::forms::exception_dialog::text

(

const xtd::ustring &

text

)

Sets the dialog caption text.

Parameters

text	The new dialog caption text.

Returns

Current input_dialog instance.

Member Data Documentation

dialog_closed

event<exception_dialog, dialog_closed_event_handler> xtd::forms::exception_dialog::dialog_closed

Occurs when the user close an exception dialog box with dialog close button or other dialog buttons.

Remarks

For more information about handling events, see Handling and Raising Events.

---

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

• xtd.forms/include/xtd/forms/exception_dialog.h