Represents a link within a xtd::forms::link_label control.
- Header
#include <xtd/forms/link>
- Namespace
- xtd::forms
- Library
- xtd.forms
|
bool | equals (const link &other) const noexcept override |
|
|
| 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...
|
|
virtual bool | equals (const link &) const noexcept=0 |
| Indicates whether the current object is equal to another object of the same type. More...
|
|
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...
|
|
◆ link() [1/3]
xtd::forms::link::link |
( |
| ) |
|
◆ 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. |
◆ description() [1/2]
Gets a text description of the link.
- Returns
- A xtd::ustring representing a text description of the link.
◆ description() [2/2]
◆ enabled() [1/2]
bool xtd::forms::link::enabled |
( |
| ) |
const |
|
noexcept |
Gets a value indicating whether the link is enabled.
- Returns
- true if the link is enabled; otherwise, false.
◆ 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.
◆ length() [1/2]
size_t xtd::forms::link::length |
( |
| ) |
const |
|
noexcept |
Gets the number of characters in the link text.
- Returns
- The number of characters, including spaces, in the link text.
◆ 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.
◆ link_data() [1/2]
std::any xtd::forms::link::link_data |
( |
| ) |
const |
|
noexcept |
Gets the data associated with the link.
- Returns
- A std::any object representing the data associated with the link.
◆ link_data() [2/2]
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.
◆ name() [1/2]
◆ name() [2/2]
◆ start() [1/2]
size_t xtd::forms::link::start |
( |
| ) |
const |
|
noexcept |
◆ start() [2/2]
link& xtd::forms::link::start |
( |
size_t |
value | ) |
|
◆ tag() [1/2]
std::any xtd::forms::link::tag |
( |
| ) |
const |
|
noexcept |
◆ tag() [2/2]
◆ visited() [1/2]
bool xtd::forms::link::visited |
( |
| ) |
const |
|
noexcept |
Gets a value indicating whether the user has visited the link.
- Returns
- true if the link has been visited; otherwise, false.
- 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.
- 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