xtd::forms::link_label_clicked_event_args Class Reference

Definition

Represents a Windows label control that can display hyperlinks.

Header

#include <xtd/forms/link_label_clicked_event_args> 

Namespace

xtd::forms

Library

xtd.forms

Todo:

rename to link_label_link_clicked_event_args

Examples:

form_background_image2.cpp, and link_label.cpp.

Constructors
	link_label_clicked_event_args (const xtd::forms::link &link, xtd::forms::mouse_buttons button)
	Initialise a new instance of xtd::forms::link_labelc_clicked_event_args class. More...

Properties
const xtd::forms::link &	link () const noexcept
	Geyts the link clicked. More...
xtd::forms::mouse_buttons	button () const noexcept
	Gets which mouse button was pressed. More...
bool	visited () const noexcept
	Gets the visited link value. More...
void	visited (bool value)
	Sets the visited link 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

link_label_clicked_event_args()

xtd::forms::link_label_clicked_event_args::link_label_clicked_event_args	(	const xtd::forms::link &	link,
		xtd::forms::mouse_buttons	button
	)

Initialise a new instance of xtd::forms::link_labelc_clicked_event_args class.

Parameters

link	The xtd::forms::link clicked.
button	One of the xtd::forms::mouse_buttons values that indicate which mouse button was pressed.

Member Function Documentation

button()

xtd::forms::mouse_buttons xtd::forms::link_label_clicked_event_args::button ( ) const

noexcept

Gets which mouse button was pressed.

Returns

One of the xtd::forms::mouse_buttons values.

link()

const xtd::forms::link& xtd::forms::link_label_clicked_event_args::link ( ) const

noexcept

Geyts the link clicked.

Returns

The link clocked.

visited() [1/2]

bool xtd::forms::link_label_clicked_event_args::visited ( ) const

noexcept

Gets the visited link value.

Returns

true if visited link; otherwise false.

visited() [2/2]

void xtd::forms::link_label_clicked_event_args::visited

(

bool

value

)

Sets the visited link value.

Parameters

value

true if visited link; otherwise false.

---

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

• xtd.forms/include/xtd/forms/link_label_clicked_event_args.h