xtd::forms::link_label Class Reference

#include <link_label.h>

Definition

Represents a Windows label control that can display hyperlinks.

Namespace

xtd::forms

Library

xtd.forms

Remarks

The xtd::forms::link_label control is similar to a xtd::forms::label control with the exception that it can display a hyperlink. Multiple hyperlinks can be specified in the text of the control. Each hyperlink can perform a different task within an application. For example, you can use a hyperlink to display a Web site in your web browser or to load a log file associated with an application.

Each hyperlink displayed in the xtd::forms::link_label control is an instance of the xtd::forms::link_label::link class. The xtd::forms::link_label::link class defines display information, state, and location of the hyperlink. In addition, the xtd::forms::link_label::link::link_data property of the xtd::forms::link_label::link class enables you to associate information, such as a URL to display, with the hyperlink. When a user clicks a hyperlink within the control, the xtd::forms::link_label::link_clicked event is raised, and the xtd::forms::link_label::link object representing the hyperlink that was clicked is passed as part of the xtd::forms::link_label_link_clicked_event_args object that is passed as a parameter to the event handler. You can use this object to obtain the xtd::forms::link_label::link object associated with the hyperlink that was clicked by the user. All hyperlinks contained within the xtd::forms::link_label control are stored in the xtd::forms::link_label::link_collection class instance for the control.

There are two ways to add a hyperlink to the the xtd::forms::link_label control. The quickest way is to specify a the xtd::forms::link_label::link_area and assign it to the the xtd::forms::link_label::link_area property. This enables you to specify a single hyperlink within the text of the control. To add multiple hyperlinks, you can use the the xtd::forms::link_label::link_collection::push_back method of the the xtd::forms::link_label::link_collection class by accessing the collection through the the xtd::forms::link_label::links property.

When a xtd::forms::link_label control is created, a default hyperlink that contains all the text within the xtd::forms::link_label control is added to the xtd::forms::link_label::link_collection. You can override this default link by specifying a new link area with the xtd::forms::link_label::link_area property, or specify a link using the xtd::forms::link_label::link_collection::push_back method of the xtd::forms::link_label::link_collection. You can also remove the default hyperlink by using the xtd::forms::link_label::link_collection::erase method of the xtd::forms::link_label::link_collection class.

The xtd::forms::link_label::tab_stop property is true by default, as long as there is at least one link of greater than zero length in the Links collection. The xtd::forms::link_label control has a single xtd::forms::link_label::tab_index value. However, each link of greater than zero length gets its own tab stop, in left-to-right order. To prevent tab navigation to the xtd::forms::link_label control, set the xtd::forms::link_label::tab_stop property to false. However, be aware that adding new links to the xtd::forms::link_label::links collection will automatically set the xtd::forms::link_label::tab_stop property to true again.

The xtd::forms::link_label provides a number of properties that enable you to define the display appearance of hyperlinks in the control. The xtd::forms::link_label::active_link_color, xtd::forms::link_label::disabled_link_color, xtd::forms::link_label::link_color, and xtd::forms::link_label::visited_link_color properties define the colors used when displaying a hyperlink in various states. The xtd::forms::link_label::link_behavior property defines the display of the underline that is associated with a hyperlink.

Examples

The following code example demonstrate the use of link_label control.

#include <filesystem>
#include <xtd/xtd>
 
using namespace std;
using namespace std::filesystem;
using namespace xtd;
using namespace xtd::diagnostics;
using namespace xtd::forms;
 
namespace examples {
  class form1 : public form {
  public:
    form1() {
      text("Link label example");
      client_size({400, 200});
 
      link_label1.location({10, 10});
      link_label1.auto_size(true);
      link_label1.parent(*this);
      link_label1.text("xtd Reference Guide");
      link_label1.link_clicked += [](object& sender, link_label_clicked_event_args& e) {
        e.visited(true);
        process::start("https://codedocs.xyz/gammasoft71/xtd/index.html");
      };
 
      link_label2.location({10, 40});
      link_label2.auto_size(true);
      link_label2.parent(*this);
      link_label2.text("Gammasoft presents xtd framework");
      link_label2.links().push_back({0, 9, "https://gammasoft71.wixsite.com/gammasoft"_s});
      link_label2.links().push_back({19, 3, "https://gammasoft71.wixsite.com/xtdpro"_s});
      link_label2.link_clicked += [](object& sender, link_label_clicked_event_args& e) {
        e.visited(true);
        process::start(as<string>(e.link().link_data()));
      };
 
      link_label3.location({10, 70});
      link_label3.auto_size(true);
      link_label3.parent(*this);
      link_label3.text("Put your temporary files in the temp directory");
      link_label3.links().push_back({32, 4, temp_directory_path()});
      link_label3.link_clicked += [](object& sender, link_label_clicked_event_args& e) {
        process::start(as<path>(e.link().link_data()).string());
      };
    }
    
  private:
    link_label link_label1;
    link_label link_label2;
    link_label link_label3;
  };
}
 
int main() {
  application::run(examples::form1());
}

Inherits xtd::forms::label.

Classes
class	link_collection
	Represents a collection of controls. More...

Public Types
using	link = xtd::forms::link
	Represents a link within a link_label control.

Public Attributes
event< link_label, link_label_clicked_event_handler >	link_clicked
Public Attributes inherited from xtd::forms::label
event< label, event_handler >	text_align_changed
	Occurs when the value of the xtd::forms::label::text_align property has changed.
Public Attributes inherited from xtd::forms::control
event< control, event_handler >	auto_size_changed
	Occurs when the value of the auto_size property changes.
event< control, event_handler >	back_color_changed
	Occurs when the value of the back_color property changes.
event< control, event_handler >	background_image_changed
	Occurs when the value of the background_image property changes.
event< control, event_handler >	background_image_layout_changed
	Occurs when the value of the background_image_layout property changes.
event< control, event_handler >	click
	Occurs when the control is clicked.
event< control, event_handler >	client_size_changed
	Occurs when the value of the client_size property changes.
event< control, control_event_handler >	control_added
	Occurs when a new control is added to the control::control_collection.
event< control, control_event_handler >	control_removed
	Occurs when a new control is removed to the control::control_collection.
event< control, event_handler >	cursor_changed
	Occurs when the value of the cursor property changes.
event< control, event_handler >	dock_changed
	Occurs when the value of the dock property changes.
event< control, event_handler >	double_click
	Occurs when the control is double-clicked.
event< control, event_handler >	enabled_changed
	Occurs when the value of the enabled property changes.
event< control, event_handler >	font_changed
	Occurs when the value of the font property changes.
event< control, event_handler >	fore_color_changed
	Occurs when the value of the fore_color property changes.
event< control, event_handler >	got_focus
	Occurs when the control receives focus.
event< control, event_handler >	handle_created
	Occurs when a handle is created for the control.
event< control, event_handler >	handle_destroyed
	Occurs when the control's handle is in the process of being destroyed.
event< control, key_event_handler >	key_down
	Occurs when a key is pressed while the control has focus.
event< control, key_press_event_handler >	key_press
	Occurs when a character. space or backspace key is pressed while the control has focus.
event< control, key_event_handler >	key_up
	Occurs when a key is released while the control has focus.
event< control, event_handler >	layout
	Occurs when a control should reposition its child controls.
event< control, event_handler >	location_changed
	Occurs when the value of the location property changes.
event< control, event_handler >	lost_focus
	Occurs when the control loses focus.
event< control, mouse_event_handler >	mouse_click
	Occurs when the control is clicked by the mouse.
event< control, mouse_event_handler >	mouse_double_click
	Occurs when the control is double clicked by the mouse.
event< control, mouse_event_handler >	mouse_down
	Occurs when the mouse pointer is over the control and a mouse button is pressed.
event< control, event_handler >	mouse_enter
	Occurs when the mouse pointer enters the control.
event< control, mouse_event_handler >	mouse_horizontal_wheel
	Occurs when the mouse horizontal wheel moves while the control has focus.
event< control, event_handler >	mouse_leave
	Occurs when the mouse pointer leaves the control.
event< control, mouse_event_handler >	mouse_move
	Occurs when the mouse pointer is moved over the control.
event< control, mouse_event_handler >	mouse_up
	Occurs when the mouse pointer is over the control and a mouse button is released.
event< control, mouse_event_handler >	mouse_wheel
	Occurs when the mouse wheel moves while the control has focus.
event< control, paint_event_handler >	paint
	Occurs when the control is redrawn.
event< control, event_handler >	parent_changed
	Occurs when the value of the parent property changes.
event< control, event_handler >	resize
	Occurs when the control is resized.
event< control, event_handler >	size_changed
	Occurs when the value of the size property changes.
event< control, event_handler >	text_changed
	Occurs when the value of the text property changes.
event< control, event_handler >	visible_changed
	Occurs when the value of the visible property changes.

Public Member Functions
	link_label ()
	Initializes a new default instance of the xtd::forms::link_label class.
const xtd::drawing::color &	active_link_color () const
	Gets the color used to display an active link.
link_label &	active_link_color (const xtd::drawing::color &color)
	Sets the color used to display an active link.
const xtd::drawing::color &	disabled_link_color () const
link_label &	disabled_link_color (const xtd::drawing::color &color)
const xtd::drawing::color &	link_color () const
link_label &	link_color (const xtd::drawing::color &color)
link_collection &	links ()
const link_collection &	links () const
const xtd::drawing::color &	visited_link_color () const
link_label &	visited_link_color (const xtd::drawing::color &color)
Public Member Functions inherited from xtd::forms::label
	label ()
	Initialize a new instance of label class.
virtual xtd::forms::border_style	border_style () const
	Gets the border style for the control.
virtual xtd::forms::label &	border_style (xtd::forms::border_style border_style)
	Sets the border style for the control.
xtd::drawing::size	default_size () const override
	Gets the default size of the control.
virtual xtd::forms::flat_style	flat_style () const
	Gets the flat style appearance of the label control.
virtual xtd::forms::label &	flat_style (xtd::forms::flat_style flat_style)
	Sets the flat style appearance of the label control.
virtual xtd::forms::content_alignment	text_align () const
	Gets the alignment of the text on the button control.
virtual xtd::forms::label &	text_align (xtd::forms::content_alignment text_align)
	Gets the alignment of the text on the button control.
Public Member Functions inherited from xtd::forms::control
	control ()
	Initializes a new instance of the control class with default settings.
	control (const control &parent, const xtd::ustring &text)
	Initializes a new instance of the control class as a child control, with specific text.
	control (const control &parent, const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
	Initializes a new instance of the control class as a child control, with specific text, size, and location.
	control (const xtd::ustring &text)
	Initializes a new instance of the control class with specific text.
	control (const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
	Initializes a new instance of the control class with specific text, size, and location.
virtual anchor_styles	anchor () const
	Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
virtual control &	anchor (anchor_styles anchor)
	Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
virtual drawing::point	auto_scroll_point () const
	Gets where this control is scrolled to in scroll_control_into_view(control).
virtual bool	auto_size () const
	Gets a value that indicates whether the control resizes based on its contents.
virtual control &	auto_size (bool auto_size)
	Sets a value that indicates whether the control resizes based on its contents.
virtual drawing::color	back_color () const
	Gets the background color for the control.
virtual control &	back_color (const drawing::color &color)
	Sets the background color for the control.
virtual const xtd::drawing::image &	background_image () const
	Gets the background image displayed in the control.
virtual control &	background_image (const xtd::drawing::image &background_image)
	Sets the background image displayed in the control.
virtual xtd::forms::image_layout	background_image_layout () const
	Gets the background image layout as defined in the xtd::forms::image_layout enumeration.
virtual control &	background_image_layout (xtd::forms::image_layout background_image_layout)
	Sets the background image layout as defined in the xtd::forms::image_layout enumeration.
std::shared_ptr< xtd::iasync_result >	begin_invoke (delegate< void()> value)
	Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
std::shared_ptr< xtd::iasync_result >	begin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
	Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
virtual int32_t	bottom () const
	Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
virtual drawing::rectangle	bounds () const
	Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual control &	bounds (const drawing::rectangle &bounds)
	Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
virtual void	bring_to_front ()
	Brings the control to the front of the z-order.
virtual bool	can_focus () const
	Gets a value indicating whether the control can receive focus.
bool	can_raise_events () const override
	Determines if events can be raised on the control.
virtual bool	can_select () const
	Gets a value indicating whether the control can be selected.
virtual const drawing::rectangle &	client_rectangle () const
	Gets the rectangle that represents the client area of the control.
virtual const drawing::size &	client_size () const
	Gets the height and width of the client area of the control.
virtual control &	client_size (const drawing::size &client_size)
	Sets the height and width of the client area of the control.
virtual xtd::ustring	company_name () const
	Gets the name of the company or creator of the application containing the control.
virtual control_collection &	controls ()
	Gets the collection of controls contained within the control.
virtual const control_collection &	controls () const
	Gets the collection of controls contained within the control.
void	create_control ()
	Forces the creation of the visible control, including the creation of the handle and any visible child controls.
drawing::graphics	create_graphics () const
	Creates the xtd::drawing::graphics for the control.
virtual void	create_handle ()
	Creates a handle for the control.
virtual bool	created ()
	Gets a value indicating whether the control has been created.
virtual forms::cursor	cursor () const
	Gets the cursor that is displayed when the mouse pointer is over the control.
virtual control &	cursor (const forms::cursor &cursor)
	Sets the cursor that is displayed when the mouse pointer is over the control.
virtual drawing::color	default_back_color () const
	Gets the default background color of the control.
virtual forms::cursor	default_cursor () const
	Gets the default cursor for the control.
virtual drawing::font	default_font () const
	Gets the default font of the control.
virtual drawing::color	default_fore_color () const
	Gets the default foreground color of the control.
virtual drawing::size	default_size () const
	Gets the default size of the control.
virtual void	destroy_control ()
	Forces the destruction of the visible control, including the destruction of the handle and any visible child controls.
virtual void	destroy_handle ()
	Destroys the handle associated with the control.
virtual drawing::rectangle	display_rectangle () const
	Gets the rectangle that represents the display area of the control.
virtual dock_style	dock () const
	Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual control &	dock (dock_style dock)
	Sets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
virtual bool	double_buffered () const
	Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual control &	double_buffered (bool double_buffered)
	Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
virtual bool	enabled () const
	Gets a value indicating whether the control can respond to user interaction.
virtual control &	enabled (bool enabled)
	Sets a value indicating whether the control can respond to user interaction.
void	end_invoke (std::shared_ptr< xtd::iasync_result > async)
	Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed.
bool	focus ()
	Sets input focus to the control.
virtual bool	focused () const
	Gets a value indicating whether the control has input focus.
virtual drawing::font	font () const
	Gets the font of the text displayed by the control.
virtual control &	font (const drawing::font &font)
	Sets the font of the text displayed by the control.
virtual drawing::color	fore_color () const
	Gets the foreground color of the control.
virtual control &	fore_color (const drawing::color &color)
	Sets the foreground color of the control.
size_t	get_child_index (intptr_t child) const
	Retrieves the index of a control within the control collection.
size_t	get_child_index (intptr_t child, bool &throw_exception) const
	Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.
intptr_t	handle () const override
	Gets the window handle that the control is bound to.
virtual int32_t	height () const
	Gets the height of the control.
virtual control &	height (int32_t height)
	Sets the height of the control.
virtual void	hide ()
	Conceals the control from the user.
virtual void	invalidate () const
	Invalidates the entire surface of the control and causes the control to be redrawn.
virtual void	invalidate (bool invalidate_children) const
	Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
virtual void	invalidate (const drawing::rectangle &rect) const
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
virtual void	invalidate (const drawing::rectangle &rect, bool invalidate_children) const
	Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
void	invoke (delegate< void()> value)
	Executes the specified delegate on the thread that owns the control's underlying window handle.
void	invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
	Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
bool	is_handle_created () const
	Gets a value indicating whether the control has a handle associated with it.
virtual int32_t	left () const
	Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual control &	left (int32_t left)
	Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
virtual drawing::point	location () const
	Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual control &	location (const drawing::point &location)
	Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
virtual forms::padding	margin () const
	Gets the space between controls.
virtual control &	margin (const forms::padding &margin)
	Sets the space between controls.
virtual const drawing::size &	maximum_size () const
	Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	maximum_size (const drawing::size &size)
	Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
virtual const drawing::size &	minimum_size () const
	Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual control &	minimum_size (const drawing::size &size)
	Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
virtual const xtd::ustring &	name () const
	Gets the name of the control.
virtual control &	name (const xtd::ustring &name)
	Sets the name of the control.
virtual forms::padding	padding () const
	Gets padding within the control.
virtual control &	padding (const forms::padding &padding)
	Sets padding within the control.
virtual std::optional< control_ref >	parent () const
	Gets the parent container of the control.
virtual control &	parent (const control &parent)
	Sets the parent container of the control.
virtual control &	parent (std::nullptr_t)
	Resets the parent container of the control.
void	perform_layout ()
	Forces the control to apply layout logic to all its child controls.
xtd::drawing::point	point_to_client (const xtd::drawing::point &p)
	Computes the location of the specified screen point into client coordinates.
xtd::drawing::point	point_to_screen (const xtd::drawing::point &p)
	Computes the location of the specified client point into screen coordinates.
virtual bool	pre_process_message (xtd::forms::message &message)
	Preprocesses keyboard or input messages within the message loop before they are dispatched.
virtual xtd::ustring	product_name () const
	Gets the product name of the assembly containing the control.
bool	recreating_handle () const
	Gets a value indicating whether the control is currently re-creating its handle.
virtual void	refresh () const
	Forces the control to invalidate its client area and immediately redraw itself and any child controls.
void	resume_layout ()
	Resumes usual layout logic.
void	resume_layout (bool perform_layout)
	Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
virtual int32_t	right () const
	Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
intptr_t	send_message (intptr_t hwnd, int32_t msg, intptr_t wparam, intptr_t lparam) const
	Send a message with specified hwnd, message, wparam and lparam.
void	set_auto_size_mode (auto_size_mode auto_size_mode)
	Sets a value indicating how a control will behave when its auto_size property is enabled.
void	set_bounds (int32_t x, int32_t y, int32_t width, int32_t height)
	Sets the bounds of the control to the specified location and size.
void	set_bounds (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
	Sets the specified bounds of the control to the specified location and size.
virtual void	show ()
	Displays the control to the user.
virtual const drawing::size &	size () const
	Gets the height and width of the control.
virtual control &	size (const drawing::size &size)
	Sets the height and width of the control.
void	suspend_layout ()
	Temporarily suspends the layout logic for the control.
virtual std::any	tag () const
	Gets the object that contains data about the control.
virtual control &	tag (std::any tag)
	Sets the object that contains data about the control.
virtual const xtd::ustring &	text () const
	Gets the text associated with this control.
virtual control &	text (const xtd::ustring &text)
	Sets the text associated with this control.
xtd::ustring	to_string () const noexcept override
	Returns a string containing the name of the control, if any.
virtual int32_t	top () const
	Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual control &	top (int32_t top)
	Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
virtual std::optional< control_ref >	top_level_control () const
	Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
virtual void	update () const
	Causes the control to redraw the invalidated regions within its client area.
virtual bool	visible () const
	Gets a value indicating whether the control and all its child controls are displayed.
virtual control &	visible (bool visible)
	Sets a value indicating whether the control and all its child controls are displayed.
virtual int32_t	width () const
	Gets the width of the control.
virtual control &	width (int32_t width)
	Sets the width of the control.
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.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.
virtual intptr_t	handle () const =0
	Gets the handle to the window represented by the implementer.

Protected Member Functions
xtd::drawing::size	measure_control () const override
	Measure this control.
void	on_cursor_changed (const xtd::event_args &e) override
	Raises the control::cursor_changed event.
void	on_mouse_click (const xtd::forms::mouse_event_args &e) override
	Raises the control::mouse_click event.
void	on_mouse_down (const xtd::forms::mouse_event_args &e) override
	Raises the control::mouse_down event.
void	on_mouse_move (const xtd::forms::mouse_event_args &e) override
	Raises the control::mouse_move event.
void	on_mouse_up (const xtd::forms::mouse_event_args &e) override
	Raises the control::mouse_up event.
void	on_paint (xtd::forms::paint_event_args &e) override
	Raises the control::paint event.
void	on_text_align_changed (const xtd::event_args &e) override
	Raises the xtd::forms::label::text_align_changed event.
void	on_text_changed (const xtd::event_args &e) override
	Raises the control::text_changed event.
link_label::link &	point_in_link (const xtd::drawing::point &point)
Protected Member Functions inherited from xtd::forms::label
xtd::forms::create_params	create_params () const override
	Gets the required creation parameters when the control handle is created.
xtd::drawing::size	measure_control () const override
	Measure this control.
void	on_font_changed (const xtd::event_args &e) override
	Raises the control::font_changed event.
void	on_handle_created (const event_args &e) override
	Raises the control::handle_created event.
void	on_paint (xtd::forms::paint_event_args &e) override
	Raises the control::paint event.
void	on_resize (const xtd::event_args &e) override
	Raises the control::resize event.
virtual void	on_text_align_changed (const xtd::event_args &e)
	Raises the xtd::forms::label::text_align_changed event.
void	on_text_changed (const xtd::event_args &e) override
	Raises the control::text_changed event.
Protected Member Functions inherited from xtd::forms::control
virtual forms::create_params	create_params () const
	Gets the required creation parameters when the control handle is created.
virtual void	def_wnd_proc (message &message)
	Sends the specified message to the default window procedure.
bool	get_style (control_styles flag) const
	Retrieves the value of the specified control style bit for the control.
virtual drawing::size	measure_control () const
	Measure this control.
drawing::size	measure_text () const
	Measure this control text.
virtual void	on_auto_size_changed (const event_args &e)
	Raises the control::auto_size_changed event.
virtual void	on_back_color_changed (const event_args &e)
	Raises the control::back_color_changed event.
virtual void	on_background_image_changed (const event_args &e)
	Raises the control::background_image_changed event.
virtual void	on_background_image_layout_changed (const event_args &e)
	Raises the control::background_image_layout_changed event.
virtual void	on_click (const event_args &e)
	Raises the control::click event.
virtual void	on_client_size_changed (const event_args &e)
	Raises the control::client_size_changed event.
virtual void	on_control_added (const control_event_args &e)
	Raises the control::control_added event.
virtual void	on_control_removed (const control_event_args &e)
	Raises the control::control_removed event.
virtual void	on_create_control ()
	Raises the control::create_control event.
virtual void	on_cursor_changed (const event_args &e)
	Raises the control::cursor_changed event.
virtual void	on_dock_changed (const event_args &e)
	Raises the control::dock_changed event.
virtual void	on_double_click (const event_args &e)
	Raises the double_click event.
virtual void	on_enabled_changed (const event_args &e)
	Raises the control::enabled_changed event.
virtual void	on_font_changed (const event_args &e)
	Raises the control::font_changed event.
virtual void	on_fore_color_changed (const event_args &e)
	Raises the control::fore_color_changed event.
virtual void	on_got_focus (const event_args &e)
	Raises the control::got_focus event.
virtual void	on_handle_created (const event_args &e)
	Raises the control::handle_created event.
virtual void	on_handle_destroyed (const event_args &e)
	Raises the control::handle_destroyed event.
virtual void	on_key_down (key_event_args &e)
	Raises the control::key_down event.
virtual void	on_key_press (key_press_event_args &e)
	Raises the control::key_press event.
virtual void	on_key_up (key_event_args &e)
	Raises the control::key_up event.
virtual void	on_layout (const event_args &e)
	Raises the control::layout event.
virtual void	on_location_changed (const event_args &e)
	Raises the control::location_changed event.
virtual void	on_lost_focus (const event_args &e)
	Raises the control::lost_focus event.
virtual void	on_mouse_click (const mouse_event_args &e)
	Raises the control::mouse_click event.
virtual void	on_mouse_double_click (const mouse_event_args &e)
	Raises the control::mouse_double_click event.
virtual void	on_mouse_down (const mouse_event_args &e)
	Raises the control::mouse_down event.
virtual void	on_mouse_enter (const event_args &e)
	Raises the control::mouse_enter event.
virtual void	on_mouse_horizontal_wheel (const mouse_event_args &e)
	Raises the control::mouse_horizontal_wheel event.
virtual void	on_mouse_leave (const event_args &e)
	Raises the control::mouse_leave event.
virtual void	on_mouse_move (const mouse_event_args &e)
	Raises the control::mouse_move event.
virtual void	on_mouse_up (const mouse_event_args &e)
	Raises the control::mouse_up event.
virtual void	on_mouse_wheel (const mouse_event_args &e)
	Raises the control::mouse_wheel event.
virtual void	on_paint (paint_event_args &e)
	Raises the control::paint event.
virtual void	on_parent_back_color_changed (const event_args &e)
	Raises the control::parent_back_color_changed event.
virtual void	on_parent_changed (const event_args &e)
	Raises the control::parent_changed event.
virtual void	on_parent_cursor_changed (const event_args &e)
	Raises the control::parent_cursor_changed event.
virtual void	on_parent_enabled_changed (const event_args &e)
	Raises the xtd::control::enabled_changed event when the xtd::control::enabled property value of the control's container changes..
virtual void	on_parent_font_changed (const event_args &e)
	Raises the control::parent_font_changed event.
virtual void	on_parent_fore_color_changed (const event_args &e)
	Raises the control::parent_fore_color_changed event.
virtual void	on_resize (const event_args &e)
	Raises the control::resize event.
virtual void	on_size_changed (const event_args &e)
	Raises the control::size_changed event.
virtual void	on_text_changed (const event_args &e)
	Raises the control::text_changed event.
virtual void	on_visible_changed (const event_args &e)
	Raises the control::visible_changed event.
virtual void	recreate_handle ()
	Forces the re-creation of the handle for the control.
virtual void	set_bounds_core (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
	Performs the work of setting the specified bounds of this control.
virtual void	set_client_size_core (int32_t width, int32_t height)
	Sets the size of the client area of the control.
void	set_style (control_styles flag, bool value)
	Sets a specified control_styles flag to either true or false.
virtual void	wnd_proc (message &m)
	Processes Windows messages.
Protected Member Functions inherited from xtd::forms::component
	component ()=default
	Initialises a new instance of the component class.
virtual bool	can_raise_events () const
	Gets a value indicating whether the component can raise an event.
bool	design_mode () const
	Gets a value that indicates whether the component is currently in design mode.

Additional Inherited Members
Static Public Member Functions inherited from xtd::forms::control
template<typename control_t >
static std::unique_ptr< control_t >	create (const control &parent, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified parent, location ,size back_color and fore_color.
template<typename control_t >
static std::unique_ptr< control_t >	create (const control &parent, const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified parent, text, location ,size back_color and fore_color.
template<typename control_t >
static std::unique_ptr< control_t >	create (const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified location ,size back_color and fore_color.
template<typename control_t >
static std::unique_ptr< control_t >	create (const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
	A factory to create a specified control with specified text, location ,size back_color and fore_color.
static std::optional< control_ref >	from_child_handle (intptr_t handle)
	Retrieves the control that contains the specified handle.
static std::optional< control_ref >	from_handle (intptr_t handle)
	Returns the control that is currently associated with the specified handle.
static forms::keys	modifier_keys ()
	Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
static forms::mouse_buttons	mouse_buttons ()
	Gets a value indicating which of the mouse buttons is in a pressed state.
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.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Typedef Documentation

link

using xtd::forms::link_label::link = xtd::forms::link

Represents a link within a link_label control.

Remarks

The xtd::forms::link_label::link class defines the properties of a link within a xtd::forms::link_label control. You can use these properties to provide data to the xtd::forms::link_label::link_clicked event of the xtd::forms::link_label control to perform tasks when the link is clicked in the control. The xtd::forms::link_label::link_data property enables you to define information that the xtd::forms::link_label::link_clicked event can use to display a URL within your web browser or to open a file.

In addition to information related to the link, the properties of the xtd::forms::link_label::link class also help define the text of the xtd::forms::link_label::lLink and its display state. The xtd::forms::link_label::start and xtd::forms::link_label::length properties define the location and length of text from the text of the xtd::forms::link_label control to display as a link. The xtd::forms::link_label::enabled property allows you to display the link as a disabled link, and the xtd::forms::link_label::visited property can alert the user that they already visited the specified link in the current instance of the xtd::forms::link_label.

You can display multiple links in a single xtd::forms::link_label control. Each xtd::forms::link_label::link is added into the xtd::forms::link_label::link_collection associated with the xtd::forms::link_label control. To obtain the collection of links defined in a xtd::forms::link_label control, use the xtd::forms::link_label::links property.

Constructor & Destructor Documentation

link_label()

xtd::forms::link_label::link_label

(

)

Initializes a new default instance of the xtd::forms::link_label class.

Member Function Documentation

active_link_color() [1/2]

const xtd::drawing::color & xtd::forms::link_label::active_link_color

(

)

const

Gets the color used to display an active link.

Returns

A xtd::drawing::color that represents the color to display an active link. The default color is specified by the system, typically this color is xtd::drawing::color::red in light mode and xtd::drawing::color::from_argb(0xFFD03E3D) in dark mode.

Remarks

An active link is a link that is in the process of being clicked. This is similar to the depressed state of a xtd::forms::button control. You can use this property to specify the color that the link is displayed in when the link is in the process of being clicked.

There are a number of colors associated with a link. The xtd::forms::link_label::link_color specifies the color of all links displayed in the xtd::forms::link_label control. The xtd::forms::link_label::visited_link_color property enables you to specify the color of a link after it has been visited by the user. When a link is disabled, the xtd::forms::link_label::disabled_link_color is used to display the link in a disabled state.

Note

When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is xtd::drawing::color::red and this property is set to xtd::drawing::color::red, the text is not shown properly when the link is in the process of being clicked.

active_link_color() [2/2]

link_label & xtd::forms::link_label::active_link_color

(

const xtd::drawing::color &

color

)

Sets the color used to display an active link.

Parameters

color

A xtd::drawing::color that represents the color to display an active link. The default color is specified by the system, typically this color is xtd::drawing::color::red in light mode and xtd::drawing::color::from_argb(0xFFD03E3D) in dark mode.

Remarks

An active link is a link that is in the process of being clicked. This is similar to the depressed state of a xtd::forms::button control. You can use this property to specify the color that the link is displayed in when the link is in the process of being clicked.

There are a number of colors associated with a link. The xtd::forms::link_label::link_color specifies the color of all links displayed in the xtd::forms::link_label control. The xtd::forms::link_label::visited_link_color property enables you to specify the color of a link after it has been visited by the user. When a link is disabled, the xtd::forms::link_label::disabled_link_color is used to display the link in a disabled state.

Note

When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is xtd::drawing::color::red and this property is set to xtd::drawing::color::red, the text is not shown properly when the link is in the process of being clicked.

measure_control()

xtd::drawing::size xtd::forms::link_label::measure_control ( ) const

overrideprotectedvirtual

Measure this control.

Returns

The drawing::size size of this control.

Reimplemented from xtd::forms::label.

on_cursor_changed()

void xtd::forms::link_label::on_cursor_changed ( const xtd::event_args &  e )

overrideprotectedvirtual

Raises the control::cursor_changed event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_mouse_click()

void xtd::forms::link_label::on_mouse_click ( const xtd::forms::mouse_event_args &  e )

overrideprotectedvirtual

Raises the control::mouse_click event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_mouse_down()

void xtd::forms::link_label::on_mouse_down ( const xtd::forms::mouse_event_args &  e )

overrideprotectedvirtual

Raises the control::mouse_down event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_mouse_move()

void xtd::forms::link_label::on_mouse_move ( const xtd::forms::mouse_event_args &  e )

overrideprotectedvirtual

Raises the control::mouse_move event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_mouse_up()

void xtd::forms::link_label::on_mouse_up ( const xtd::forms::mouse_event_args &  e )

overrideprotectedvirtual

Raises the control::mouse_up event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

on_paint()

void xtd::forms::link_label::on_paint ( xtd::forms::paint_event_args &  e )

overrideprotectedvirtual

Raises the control::paint event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::label.

on_text_align_changed()

void xtd::forms::link_label::on_text_align_changed ( const xtd::event_args &  e )

overrideprotectedvirtual

Raises the xtd::forms::label::text_align_changed event.

Remarks

Raising an event invokes the event handler through a delegate.

Notes to Inheritors

When overriding xtd::forms::label::on_text_align_changed in a derived class, be sure to call the base class's xtd::forms::label::on_text_align_changed method.

Reimplemented from xtd::forms::label.

on_text_changed()

void xtd::forms::link_label::on_text_changed ( const xtd::event_args &  e )

overrideprotectedvirtual

Raises the control::text_changed event.

Parameters

e	An xtd::event_args that contains the event data.

Reimplemented from xtd::forms::label.

---

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

• xtd.forms/include/xtd/forms/link_label.h