#include <lengths.h>

Definition

The length specifies the length of the borders.

class forms_export_ lengths : public xtd::iequatable<lengths>, public xtd::object

Inheritance: xtd::object → xtd::forms::style_sheets::lengths

Implements: xtd::iequatable <>

Namespace: xtd::forms::style_sheets

Library: xtd.forms

Fields
static const lengths	empty
	Provides a xtd::forms::style_sheets::lengths object with no xtd::forms::style_sheets::lengths. More...

Constructors
	lengths ()=default
	Initializes a new instance of the xtd::forms::style_sheets::lengths class. More...

	lengths (xtd::forms::style_sheets::length all)
	Initializes a new instance of the xtd::forms::style_sheets::lengths class using the supplied xtd::forms::style_sheets::lengths size for all edges. More...

	lengths (xtd::forms::style_sheets::length left, xtd::forms::style_sheets::length top, xtd::forms::style_sheets::length right, xtd::forms::style_sheets::length bottom)
	Initializes a new instance of the xtd::forms::style_sheets::lengths class using a separate xtd::forms::style_sheets::lengths size for each edge. More...

Peorperties
xtd::forms::style_sheets::length	all () const noexcept
	Gets the xtd::forms::style_sheets::lengths value for all the edges. More...

void	all (xtd::forms::style_sheets::length all) noexcept
	Sets the xtd::forms::style_sheets::lengths value for all the edges. More...

xtd::forms::style_sheets::length	bottom () const noexcept
	Gets the xtd::forms::style_sheets::lengths value for the bottom edge. More...

void	bottom (xtd::forms::style_sheets::length bottom) noexcept
	Sets the xtd::forms::style_sheets::lengths value for the bottom edge. More...

xtd::forms::style_sheets::length	left () const noexcept
	Gets the xtd::forms::style_sheets::lengths value for the left edge. More...

void	left (xtd::forms::style_sheets::length left) noexcept
	Sets the xtd::forms::style_sheets::lengths value for the left edge. More...

xtd::forms::style_sheets::length	right () const noexcept
	Gets the xtd::forms::style_sheets::lengths value for the right edge. More...

void	right (xtd::forms::style_sheets::length right) noexcept
	Sets the xtd::forms::style_sheets::lengths value for the right edge. More...

xtd::forms::style_sheets::length	top () const noexcept
	Gets the xtd::forms::style_sheets::lengths value for the top edge. More...

void	top (xtd::forms::style_sheets::length top) noexcept
	Sets the xtd::forms::style_sheets::lengths value for the top edge. More...

Methods
bool	equals (const object &other) const noexcept override
	Determines whether the specified object is equal to the current object. More...

bool	equals (const lengths &other) const noexcept override

xtd::ustring	to_string () const noexcept override
	Returns a sxd::ustring that represents the current object. More...

Additional Inherited Members
Public Member Functions inherited from xtd::iequatable< lengths >
virtual bool	equals (const lengths &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type. More...

Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance. More...

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

Constructor & Destructor Documentation

◆ lengths() [1/3]

xtd::forms::style_sheets::lengths::lengths ( )

default

Initializes a new instance of the xtd::forms::style_sheets::lengths class.

◆ lengths() [2/3]

xtd::forms::style_sheets::lengths::lengths ( xtd::forms::style_sheets::length all )

Initializes a new instance of the xtd::forms::style_sheets::lengths class using the supplied xtd::forms::style_sheets::lengths size for all edges.

Parameters

all	The number of pixels to be used for xtd::forms::style_sheets::lengths for all edges.

Remarks: This constructor sets the right, left, bottom, top and all properties to the value of the all parameter.

◆ lengths() [3/3]

xtd::forms::style_sheets::lengths::lengths	(	xtd::forms::style_sheets::length	left,
		xtd::forms::style_sheets::length	top,
		xtd::forms::style_sheets::length	right,
		xtd::forms::style_sheets::length	bottom
	)

Initializes a new instance of the xtd::forms::style_sheets::lengths class using a separate xtd::forms::style_sheets::lengths size for each edge.

Parameters

left	The xtd::forms::style_sheets::lengths size, in pixels, for the left edge.
top	The xtd::forms::style_sheets::lengths size, in pixels, for the top edge.
right	The xtd::forms::style_sheets::lengths size, in pixels, for the right edge.
bottom	The xtd::forms::style_sheets::lengths size, in pixels, for the bottom edge.

Remarks: If all of the parameter values are equal, then the all property will reflect this common value.

Member Function Documentation

◆ all() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::lengths::all ( ) const

noexcept

Gets the xtd::forms::style_sheets::lengths value for all the edges.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for all edges if the same; otherwise, -1.

Remarks: When retrieving this property, if all the edges use the same xtd::forms::style_sheets::lengths value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::lengths values are not equal.

◆ all() [2/2]

void xtd::forms::style_sheets::lengths::all ( xtd::forms::style_sheets::length all )

noexcept

Sets the xtd::forms::style_sheets::lengths value for all the edges.

Parameters

all	The xtd::forms::style_sheets::lengths, in pixels, for all edges if the same; otherwise, -1.

Remarks: When retrieving this property, if all the edges use the same xtd::forms::style_sheets::lengths value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::lengths values are not equal.

◆ bottom() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::lengths::bottom ( ) const

noexcept

Gets the xtd::forms::style_sheets::lengths value for the bottom edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the bottom edge.

Remarks: Setting this value can also alter the all property.

◆ bottom() [2/2]

void xtd::forms::style_sheets::lengths::bottom ( xtd::forms::style_sheets::length bottom )

noexcept

Sets the xtd::forms::style_sheets::lengths value for the bottom edge.

Parameters

bottom The xtd::forms::style_sheets::lengths, in pixels, for the bottom edge.

Remarks: Setting this value can also alter the all property.

◆ equals()

bool xtd::forms::style_sheets::lengths::equals ( const object & obj ) const

overridevirtualnoexcept

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.

Reimplemented from xtd::object.

◆ left() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::lengths::left ( ) const

noexcept

Gets the xtd::forms::style_sheets::lengths value for the left edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the left edge.

Remarks: Setting this value can also alter the all property.

◆ left() [2/2]

void xtd::forms::style_sheets::lengths::left ( xtd::forms::style_sheets::length left )

noexcept

Sets the xtd::forms::style_sheets::lengths value for the left edge.

Parameters

left	The xtd::forms::style_sheets::lengths, in pixels, for the left edge.

Remarks: Setting this value can also alter the all property.

◆ right() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::lengths::right ( ) const

noexcept

Gets the xtd::forms::style_sheets::lengths value for the right edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the right edge.

Remarks: Setting this value can also alter the all property.

◆ right() [2/2]

void xtd::forms::style_sheets::lengths::right ( xtd::forms::style_sheets::length right )

noexcept

Sets the xtd::forms::style_sheets::lengths value for the right edge.

Parameters

right The xtd::forms::style_sheets::lengths, in pixels, for the right edge.

Remarks: Setting this value can also alter the all property.

◆ to_string()

xtd::ustring xtd::forms::style_sheets::lengths::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.

◆ top() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::lengths::top ( ) const

noexcept

Gets the xtd::forms::style_sheets::lengths value for the top edge.

Returns: The xtd::forms::style_sheets::lengths, in pixels, for the top edge.

Remarks: Setting this value can also alter the all property.

◆ top() [2/2]

void xtd::forms::style_sheets::lengths::top ( xtd::forms::style_sheets::length top )

noexcept

Sets the xtd::forms::style_sheets::lengths value for the top edge.

Parameters

top	The xtd::forms::style_sheets::lengths, in pixels, for the top edge.

Remarks: Setting this value can also alter the all property.

Member Data Documentation

◆ empty

const lengths xtd::forms::style_sheets::lengths::empty

static

Provides a xtd::forms::style_sheets::lengths object with no xtd::forms::style_sheets::lengths.

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

xtd.forms/include/xtd/forms/style_sheets/lengths.h

Definition

Fields

Constructors

Peorperties

Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ lengths() [1/3]

◆ lengths() [2/3]

◆ lengths() [3/3]

Member Function Documentation

◆ all() [1/2]

◆ all() [2/2]

◆ bottom() [1/2]

◆ bottom() [2/2]

◆ equals()

◆ left() [1/2]

◆ left() [2/2]

◆ right() [1/2]

◆ right() [2/2]

◆ to_string()

◆ top() [1/2]

◆ top() [2/2]

Member Data Documentation

◆ empty