xtd::forms::link Class Reference

#include <link.h>

Definition

Represents a link within a xtd::forms::link_label control.

Namespace

xtd::forms

Library

xtd.forms

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.

Inherits xtd::object.

Public Member Functions
	link ()=default
	Initializes a new instance of the xtd::forms::link class.
	link (size_t start, size_t length)
	Initializes a new instance of the xtd::forms::link_label::link class with the specified starting location and number of characters after the starting location within the xtd::forms::link_label.
	link (size_t start, size_t length, std::any link_data)
	Initializes a new instance of the xtd::forms::link_label::link class with the specified starting location, number of characters after the starting location within the xtd::forms::link_label, and the data associated with the link.
const xtd::ustring &	description () const
	Gets a text description of the link.
link &	description (const xtd::ustring &value)
	Sets a text description of the link.
bool	enabled () const
	Gets a value indicating whether the link is enabled.
link &	enabled (bool value)
	Sets a value indicating whether the link is enabled.
size_t	length () const
	Gets the number of characters in the link text.
link &	length (size_t value)
	Sets the number of characters in the link text.
std::any	link_data () const
	Gets the data associated with the link.
link &	link_data (std::any value)
	Sets the data associated with the link.
const xtd::ustring &	name () const
	Gets the name of the xtd::forms::link_label::link.
link &	name (const xtd::ustring &value)
	Sets the name of the xtd::forms::link_label::link.
size_t	start () const
	Gets the starting location of the link within the text of the xtd::forms::link_label::link.
link &	start (size_t value)
	Sets the starting location of the link within the text of the xtd::forms::link_label::link.
std::any	tag () const
	Gets the object that contains data about the xtd::forms::link_label::link.
link &	tag (std::any value)
	Sets the object that contains data about the xtd::forms::link_label::link.
bool	visited () const
	Gets a value indicating whether the user has visited the link.
link &	visited (bool value)
	Sets a value indicating whether the user has visited the link.
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.

Additional Inherited Members
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.

Constructor & Destructor Documentation

link() [1/3]

xtd::forms::link::link ( )

default

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

link() [2/3]

xtd::forms::link::link	(	size_t	start,
		size_t	length
	)

Initializes a new instance of the xtd::forms::link_label::link class with the specified starting location and number of characters after the starting location within the xtd::forms::link_label.

Parameters

start	The zero-based starting location of the link area within the text of the xtd::forms::link_label.
length	The number of characters, after the starting character, to include in the link area.

link() [3/3]

xtd::forms::link::link	(	size_t	start,
		size_t	length,
		std::any	link_data
	)

Initializes a new instance of the xtd::forms::link_label::link class with the specified starting location, number of characters after the starting location within the xtd::forms::link_label, and the data associated with the link.

Parameters

start	The zero-based starting location of the link area within the text of the xtd::forms::link_label.
length	The number of characters, after the starting character, to include in the link area.
link_data	The data associated with the link.

Member Function Documentation

description() [1/2]

const xtd::ustring & xtd::forms::link::description

(

)

const

Gets a text description of the link.

Returns

A xtd::ustring representing a text description of the link.

description() [2/2]

link & xtd::forms::link::description

(

const xtd::ustring &

value

)

Sets a text description of the link.

Parameters

value

A xtd::ustring representing a text description of the link.

Returns

The current instance of xtd::forms::link_label::link.

enabled() [1/2]

bool xtd::forms::link::enabled

(

)

const

Gets a value indicating whether the link is enabled.

Returns

true if the link is enabled; otherwise, false.

Remarks

You can use this property to display a link in a disabled state within the xtd::forms::link_label control. When a link is disabled, clicking on the link does not cause the xtd::forms::link_label control to raise the xtd::forms::link_label::link_clicked event.

enabled() [2/2]

link & xtd::forms::link::enabled

(

bool

value

)

Sets a value indicating whether the link is enabled.

Parameters

value

true if the link is enabled; otherwise, false.

Returns

The current instance of xtd::forms::link_label::link.

Remarks

You can use this property to display a link in a disabled state within the xtd::forms::link_label control. When a link is disabled, clicking on the link does not cause the xtd::forms::link_label control to raise the xtd::forms::link_label::link_clicked event.

length() [1/2]

size_t xtd::forms::link::length

(

)

const

Gets the number of characters in the link text.

Returns

The number of characters, including spaces, in the link text.

Remarks

To specify text from the xtd::forms::link_label to display as a link, set the xtd::forms::link_label::start property to the location in the text to start creating the link. After the xtd::forms::link_label::start property is set, set the value of the xtd::forms::link_label::length property to the number of characters, including the character position specified in the xtd::forms::link_label::start property, that you want to make the link text. For example, if you want to make the first word of the text "The quick brown fox" a link, you set the xtd::forms::link_label::start property to zero (0) and the xtd::forms::link_label::length property to three (3).

length() [2/2]

link & xtd::forms::link::length

(

size_t

value

)

Sets the number of characters in the link text.

Parameters

value

The number of characters, including spaces, in the link text.

Returns

The current instance of xtd::forms::link_label::link.

Remarks

To specify text from the xtd::forms::link_label to display as a link, set the xtd::forms::link_label::start property to the location in the text to start creating the link. After the xtd::forms::link_label::start property is set, set the value of the xtd::forms::link_label::length property to the number of characters, including the character position specified in the xtd::forms::link_label::start property, that you want to make the link text. For example, if you want to make the first word of the text "The quick brown fox" a link, you set the xtd::forms::link_label::start property to zero (0) and the xtd::forms::link_label::length property to three (3).

link_data() [1/2]

std::any xtd::forms::link::link_data

(

)

const

Gets the data associated with the link.

Returns

A std::any object representing the data associated with the link.

Remarks

You can use this property to supply information related to the link. The information provided by this property can be used within the xtd::forms::link_label::link_clicked event of the xtd::forms::link_label to provide information about the link that can be used to process the link being clicked. For example, you can specify the URL to display in your web browser when the link is clicked as the value of the xtd::forms::link_label::link_data property. You can also use the xtd::forms::link_label::link_data property to identify a dialog to display when the user clicks on the link.

link_data() [2/2]

link & xtd::forms::link::link_data

(

std::any

value

)

Sets the data associated with the link.

Parameters

value

A std::any object representing the data associated with the link.

Returns

The current instance of xtd::forms::link_label::link.

Remarks

You can use this property to supply information related to the link. The information provided by this property can be used within the xtd::forms::link_label::link_clicked event of the xtd::forms::link_label to provide information about the link that can be used to process the link being clicked. For example, you can specify the URL to display in your web browser when the link is clicked as the value of the xtd::forms::link_label::link_data property. You can also use the xtd::forms::link_label::link_data property to identify a dialog to display when the user clicks on the link.

name() [1/2]

const xtd::ustring & xtd::forms::link::name

(

)

const

Gets the name of the xtd::forms::link_label::link.

Returns

A xtd::ustring representing the name of the xtd::forms::link_label::link. The default value is the empty string ("").

name() [2/2]

link & xtd::forms::link::name

(

const xtd::ustring &

value

)

Sets the name of the xtd::forms::link_label::link.

Parameters

value

A xtd::ustring representing the name of the xtd::forms::link_label::link. The default value is the empty string ("").

Returns

The current instance of xtd::forms::link_label::link.

start() [1/2]

size_t xtd::forms::link::start

(

)

const

Gets the starting location of the link within the text of the xtd::forms::link_label::link.

Returns

The location within the text of the the xtd::forms::link_label control where the link starts.

Remarks

To specify text from the xtd::forms::link_label to display as a link, set the xtd::forms::link_label::start property to the location in the text to start creating the link. After the xtd::forms::link_label::start property is set, set the value of the xtd::forms::link_label::length property to the number of characters, including the character position specified in the xtd::forms::link_label::start property, that you want to make the link text. For example, if you want to make the first word of the text "The quick brown fox" a link, you set the xtd::forms::link_label::start property to zero (0) and the xtd::forms::link_label::length property to three (3).

start() [2/2]

link & xtd::forms::link::start

(

size_t

value

)

Sets the starting location of the link within the text of the xtd::forms::link_label::link.

Parameters

value

The location within the text of the the xtd::forms::link_label control where the link starts.

Returns

The current instance of xtd::forms::link_label::link.

Remarks

To specify text from the xtd::forms::link_label to display as a link, set the xtd::forms::link_label::start property to the location in the text to start creating the link. After the xtd::forms::link_label::start property is set, set the value of the xtd::forms::link_label::length property to the number of characters, including the character position specified in the xtd::forms::link_label::start property, that you want to make the link text. For example, if you want to make the first word of the text "The quick brown fox" a link, you set the xtd::forms::link_label::start property to zero (0) and the xtd::forms::link_label::length property to three (3).

tag() [1/2]

std::any xtd::forms::link::tag

(

)

const

Gets the object that contains data about the xtd::forms::link_label::link.

Returns

An std::any object that contains data about the control. The default has no value.

tag() [2/2]

link & xtd::forms::link::tag

(

std::any

value

)

Sets the object that contains data about the xtd::forms::link_label::link.

Parameters

value

An std::any object that contains data about the control. The default has no value.

Returns

The current instance of xtd::forms::link_label::link.

visited() [1/2]

bool xtd::forms::link::visited

(

)

const

Gets a value indicating whether the user has visited the link.

Returns

true if the link has been visited; otherwise, false.

Remarks

A xtd::forms::link_label control does not automatically denote that a link is a visited link. To display the link as a visited link, you can set the value of this property to true in an event handler for the xtd::forms::link_label::link_clicked event of a xtd::forms::link_label. A visited link is displayed using the color specified in the xtd::forms::link_label::visited_link_color property of the xtd::forms::link_label control. Once the form containing the xtd::forms::link_label control is closed, the all display state associated with the link is deleted. In order to retain the display state of the link, you need to store the display state of the link in a registry setting associated with your application.

Note

If you have only one link specified in a xtd::forms::link_label control, you can use the xtd::forms::link_label::link_visited property of the xtd::forms::link_label to specify the link as visited. You can also use the xtd::forms::link_label::link_visited property if you have multiple links defined, but the setting only applies to the first link defined in the control.

visited() [2/2]

link & xtd::forms::link::visited

(

bool

value

)

Sets a value indicating whether the user has visited the link.

Parameters

value

true if the link has been visited; otherwise, false.

Returns

The current instance of xtd::forms::link_label::link.

Remarks

A xtd::forms::link_label control does not automatically denote that a link is a visited link. To display the link as a visited link, you can set the value of this property to true in an event handler for the xtd::forms::link_label::link_clicked event of a xtd::forms::link_label. A visited link is displayed using the color specified in the xtd::forms::link_label::visited_link_color property of the xtd::forms::link_label control. Once the form containing the xtd::forms::link_label control is closed, the all display state associated with the link is deleted. In order to retain the display state of the link, you need to store the display state of the link in a registry setting associated with your application.

Note

If you have only one link specified in a xtd::forms::link_label control, you can use the xtd::forms::link_label::link_visited property of the xtd::forms::link_label to specify the link as visited. You can also use the xtd::forms::link_label::link_visited property if you have multiple links defined, but the setting only applies to the first link defined in the control.

---

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

• xtd.forms/include/xtd/forms/link.h