xtd::forms::link_area Struct Reference

Inheritance diagram for xtd::forms::link_area:

Definition

Represents an area within a xtd::forms::link_label control that represents a hyperlink within the control.

Header

#include <xtd/forms/link_area>

Namespace

xtd::forms

Library

xtd.forms

Remarks

There are two ways to add a hyperlink to the text of a xtd::forms::link_label control. You can access the xtd::forms::link_label::link_collection::push_back method of the xtd::forms::link_label::link_collection class through the xtd::forms::link_label::links property of the xtd::forms::link_label to add multiple hyperlinks to the control's text. If you only need to add a single hyperlink to the text of the control, you can use the xtd::forms::link_label::link_area property of the xtd::forms::link_label. This property accepts a xtd::forms::link_area that defines the location of the hyperlink within the control's text. When a hyperlink is specified using the xtd::forms::link_label::link_area property, the link area is then added to the xtd::forms::link_label::link_collection in the same manner as adding the link using the xtd::forms::link_label::link_collection::push_back method of the xtd::forms::link_label::link_collection.

The xtd::forms::link_area::length property specifies the number of characters within the text of the xtd::forms::link_label to include in the link area. The xtd::forms::link_area::start property specifies the first character in the control text to include in the hyperlink. If you want to determine whether a specific xtd::forms::link_area is empty, you can use the xtd::forms::link_area::is_empty property instead of checking the values of the xtd::form::link_area::start and xtd::form::link_area::length properties.

Public Constructors
	link_area ()=default
	link_area (xtd::usize start, xtd::usize length) noexcept
	Initializes a new instance of the xtd::forms::link_area class.

Public Properties
auto	is_empty () const noexcept -> bool
	Gets a value indicating whether the LinkArea is empty.
auto	length () const noexcept -> xtd::usize
	Gets the number of characters in the link area.
auto	length (xtd::usize value) noexcept -> link_area &
	Sets the number of characters in the link area.
auto	start () const noexcept -> xtd::usize
	Gets the starting location of the link area within the text of the xtd::forms::link_label.
auto	start (xtd::usize value) noexcept -> link_area &
	Sets the starting location of the link area within the text of the xtd::forms::link_label.

Public Methods
Determines whether the specified object is equal to the current object. Parameters obj The object to compare with the current object. Returns true if the specified object is equal to the current object. otherwise, false.
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const link_area &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	to_string () const noexcept -> xtd::string override
	Returns a xtd::string that represents the current object.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	equals (const link_area &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

link_area() [1/2]

xtd::forms::link_area::link_area ( )

default

Parameters

start

The zero-based starting location of the link area within the text of the LinkLabel.

link_area() [2/2]

xtd::forms::link_area::link_area ( xtd::usize start, xtd::usize length )

noexcept

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

Parameters

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

Member Function Documentation

is_empty()

auto xtd::forms::link_area::is_empty ( ) const -> bool

nodiscardnoexcept

Gets a value indicating whether the LinkArea is empty.

Returns

true if the specified start and length return an empty link area; otherwise, false.

length() [1/2]

auto xtd::forms::link_area::length ( ) const -> xtd::usize

nodiscardnoexcept

Gets the number of characters in the link area.

Returns

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

Remarks

To specify text from the xtd::forms::link_label to display as a link, set the xtd::forms::link_area::start property to the location in the text to start creating the link. After the xtd::forms::link_area::start property is set, set the value of the xtd::forms::link_area::length property to the number of characters, including the character position specified in the xtd::forms::link_area::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_area::start property to zero (0) and the xtd::forms::link_area::length property to three (3).

length() [2/2]

auto xtd::forms::link_area::length ( xtd::usize value ) -> link_area &

noexcept

Sets the number of characters in the link area.

Parameters

value

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

Returns

This current instance.

Remarks

To specify text from the xtd::forms::link_label to display as a link, set the xtd::forms::link_area::start property to the location in the text to start creating the link. After the xtd::forms::link_area::start property is set, set the value of the xtd::forms::link_area::length property to the number of characters, including the character position specified in the xtd::forms::link_area::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_area::start property to zero (0) and the xtd::forms::link_area::length property to three (3).

start() [1/2]

auto xtd::forms::link_area::start ( ) const -> xtd::usize

nodiscardnoexcept

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

Returns

The location within the text of the xtd::fors::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_area::start property to the location in the text to start creating the link. After the xtd::forms::link_area::start property is set, set the value of the xtd::forms::link_area::length property to the number of characters, including the character position specified in the xtd::forms::link_area::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_area::start property to zero (0) and the xtd::forms::link_area::length property to three (3).

start() [2/2]

auto xtd::forms::link_area::start ( xtd::usize value ) -> link_area &

noexcept

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

Parameters

value

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

Returns

This current instance.

Remarks

To specify text from the xtd::forms::link_label to display as a link, set the xtd::forms::link_area::start property to the location in the text to start creating the link. After the xtd::forms::link_area::start property is set, set the value of the xtd::forms::link_area::length property to the number of characters, including the character position specified in the xtd::forms::link_area::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_area::start property to zero (0) and the xtd::forms::link_area::length property to three (3).

equals() [1/2]

auto xtd::forms::link_area::equals ( const xtd::object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Examples

The following code example compares the current instance with another object.

#include <xtd/xtd>
 
auto main() -> int {
  auto object1 = new_ptr<object>();
  auto object2 = new_ptr<object>();
  
  auto object3 = object2;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
  object3 = object1;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
}
 
// This code produces the following output :
//
// false
// false
// true
// true

Reimplemented from xtd::object.

equals() [2/2]

auto xtd::forms::link_area::equals ( const link_area & other ) const -> bool

nodiscardoverridenoexcept

Determines whether the specified object is equal to the current object.

Parameters

other

The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

get_hash_code()

auto xtd::forms::link_area::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

to_string()

auto xtd::forms::link_area::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a xtd::string that represents the current object.

Returns

A string that represents the current object.

Examples

The following code example demonstrates what to_string returns.

#include <xtd/xtd>
 
namespace examples {
  namespace object_test {
    class object1 : public object {
    };
  }
}
 
auto main() -> int {
  ptr<object> obj1 = new_ptr<examples::object_test::object1>();
  console::write_line(obj1->to_string());
 
  ptr<object> obj2 = new_ptr<date_time>(1971, 1, 5, 23, 5, 0);
  console::write_line(obj2->to_string());
 
  ptr<object> obj3 = new_ptr<boolean_object>();
  console::write_line(obj3->to_string());
}
 
// This code produces the following output :
//
// examples::object_test::object1
// Tue Jan  5 23:05:00 1971
// false

Reimplemented from xtd::object.

---

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

• xtd.forms/include/xtd/forms/link_area.hpp