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 (size_t start, size_t length) noexcept
	Initializes a new instance of the xtd::forms::link_area class.

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

Public Methods
bool	equals (const link_area &) const noexcept override
xtd::ustring	to_string () const noexcept override
	Returns a sxd::ustring that represents the current object.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
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.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::iequatable< link_area >
virtual bool	equals (const link_area &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
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_area()

xtd::forms::link_area::link_area ( size_t  start, size_t  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()

bool xtd::forms::link_area::is_empty ( ) const

noexcept

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]

size_t xtd::forms::link_area::length ( ) const

noexcept

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]

link_area & xtd::forms::link_area::length ( size_t  value )

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]

size_t xtd::forms::link_area::start ( ) const

noexcept

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]

link_area & xtd::forms::link_area::start ( size_t  value )

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).

to_string()

xtd::ustring xtd::forms::link_area::to_string ( ) const

overridevirtualnoexcept

Returns a sxd::ustring that represents the current object.

Returns

A string that represents the current object.

Examples

The following code example demonstrates what to_string returns.

Reimplemented from xtd::object.

---

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

• xtd.forms/include/xtd/forms/link_area.h