xtd::forms::vertical_control_layout_style Class Reference

Inheritance diagram for xtd::forms::vertical_control_layout_style:

Definition

Implements the basic functionality that represents the appearance and behavior of a control layout.

Header

#include <xtd/forms/vertical_control_layout_style> 

Namespace

xtd::forms

Library

xtd.forms

Public Constructors
	vertical_control_layout_style ()=default
	Initialises a new instance of vertical control layout style class.
	vertical_control_layout_style (float height)
	Initialises a new instance of vertical control layout style class with specified height.
	vertical_control_layout_style (int32 height)
	Initialises a new instance of vertical control layout style class with specified height.
	vertical_control_layout_style (xtd::forms::size_type size_type)
	Initialises a new instance of vertical control layout style class with specified size type.
	vertical_control_layout_style (float height, xtd::forms::size_type size_type)
	Initialises a new instance of vertical control layout style class with specified height and size type.
	vertical_control_layout_style (int32 height, xtd::forms::size_type size_type)
	Initialises a new instance of vertical control layout style class with specified height and size type.
	vertical_control_layout_style (bool expanded)
	Initialises a new instance of vertical control layout style class with specified expanded.
	vertical_control_layout_style (float height, bool expanded)
	Initialises a new instance of vertical control layout style class with specified height and expanded.
	vertical_control_layout_style (int32 height, bool expanded)
	Initialises a new instance of vertical control layout style class with specified height and expanded.
	vertical_control_layout_style (xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified content alignment.
	vertical_control_layout_style (float height, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height and content alignment.
	vertical_control_layout_style (int32 height, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height and content alignment.
	vertical_control_layout_style (xtd::forms::size_type size_type, bool expanded)
	Initialises a new instance of vertical control layout style class with specified size type and expanded.
	vertical_control_layout_style (float height, xtd::forms::size_type size_type, bool expanded)
	Initialises a new instance of vertical control layout style class with specified height, size type and expanded.
	vertical_control_layout_style (int32 height, xtd::forms::size_type size_type, bool expanded)
	Initialises a new instance of vertical control layout style class with specified height, size type and expanded.
	vertical_control_layout_style (xtd::forms::size_type size_type, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified size type and content alignment.
	vertical_control_layout_style (float height, xtd::forms::size_type size_type, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height, size type and content alignment.
	vertical_control_layout_style (int32 height, xtd::forms::size_type size_type, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height, size type and content alignment.
	vertical_control_layout_style (xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified size type, expanded and content alignment.
	vertical_control_layout_style (float height, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment.
	vertical_control_layout_style (int32 height, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment.
	vertical_control_layout_style (bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified expanded and content alignment.
	vertical_control_layout_style (float height, bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment.
	vertical_control_layout_style (int32 height, bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment.

Public Properties
std::optional< float >	height () const noexcept
	Gets the height value for a control.
void	height (float height)
	Sets the height value for a control.

Public Methods
bool	equals (const vertical_control_layout_style &value) const noexcept override
xtd::ustring	to_string () const noexcept override
	Returns a string that represent xtd::forms::control_layout_style.
bool	equals (const control_layout_style &value) const noexcept override

Additional Inherited Members
Public Member Functions inherited from xtd::forms::control_layout_style
xtd::forms::size_type	size_type () const noexcept
	Gets a flag indicating how a control should be sized relative to its containing layout container.
control_layout_style &	size_type (xtd::forms::size_type size_type)
	Sets a flag indicating how a control should be sized relative to its containing layout container.
bool	expanded () const noexcept
	Gets a flag indicating if control is expanded to its containing layout container.
control_layout_style &	expanded (bool expanded)
	Sets a flag indicating if control is expanded to its containing layout container.
xtd::forms::content_alignment	align () const noexcept
	Gets a flag indicating how a control should be align to its containing layout container.
control_layout_style &	align (xtd::forms::content_alignment align)
	Sets a flag indicating how a control should be align to its containing layout container.
bool	equals (const control_layout_style &value) const noexcept override
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< control_layout_style >
virtual bool	equals (const control_layout_style &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
Public Member Functions inherited from xtd::iequatable< vertical_control_layout_style >
virtual bool	equals (const vertical_control_layout_style &) 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.
Protected Member Functions inherited from xtd::forms::control_layout_style
	control_layout_style ()
	Initialises a new instance of control layout style class.
	control_layout_style (xtd::forms::size_type size_type)
	Initialises a new instance of control layout style class with specified size type.
	control_layout_style (bool expanded)
	Initialises a new instance of control layout style class with specified expanded.
	control_layout_style (xtd::forms::content_alignment align)
	Initialises a new instance of control layout style class with specified content alignment.
	control_layout_style (xtd::forms::size_type size_type, bool expanded)
	Initialises a new instance of control layout style class with specified size type and expanded.
	control_layout_style (xtd::forms::size_type size_type, xtd::forms::content_alignment align)
	Initialises a new instance of control layout style class with specified size type and content alignment.
	control_layout_style (xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of control layout style class with specified size type, expanded and content alignment.
	control_layout_style (bool expanded, xtd::forms::content_alignment align)
	Initialises a new instance of control layout style class with specified expanded and content alignment.

Constructor & Destructor Documentation

vertical_control_layout_style() [1/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( )

default

Initialises a new instance of vertical control layout style class.

vertical_control_layout_style() [2/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( float  height )

explicit

Initialises a new instance of vertical control layout style class with specified height.

Parameters

height

The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

vertical_control_layout_style() [3/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( int32  height )

explicit

Initialises a new instance of vertical control layout style class with specified height.

Parameters

height

The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

vertical_control_layout_style() [4/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( xtd::forms::size_type  size_type )

explicit

Initialises a new instance of vertical control layout style class with specified size type.

Parameters

size_type

One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.

vertical_control_layout_style() [5/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	float	height,
		xtd::forms::size_type	size_type
	)

Initialises a new instance of vertical control layout style class with specified height and size type.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.

vertical_control_layout_style() [6/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	int32	height,
		xtd::forms::size_type	size_type
	)

Initialises a new instance of vertical control layout style class with specified height and size type.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.

vertical_control_layout_style() [7/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( bool  expanded )

explicit

Initialises a new instance of vertical control layout style class with specified expanded.

Parameters

expanded

true if control expanded; otherwise false.

vertical_control_layout_style() [8/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	float	height,
		bool	expanded
	)

Initialises a new instance of vertical control layout style class with specified height and expanded.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expanded	true if control expanded; otherwise false.

vertical_control_layout_style() [9/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	int32	height,
		bool	expanded
	)

Initialises a new instance of vertical control layout style class with specified height and expanded.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expanded	true if control expanded; otherwise false.

vertical_control_layout_style() [10/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style ( xtd::forms::content_alignment  align )

explicit

Initialises a new instance of vertical control layout style class with specified content alignment.

Parameters

align

One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [11/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	float	height,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [12/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	int32	height,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [13/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	xtd::forms::size_type	size_type,
		bool	expanded
	)

Initialises a new instance of vertical control layout style class with specified size type and expanded.

Parameters

size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expanded	true if control expanded; otherwise false.

vertical_control_layout_style() [14/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	float	height,
		xtd::forms::size_type	size_type,
		bool	expanded
	)

Initialises a new instance of vertical control layout style class with specified height, size type and expanded.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expanded	true if control expanded; otherwise false.

vertical_control_layout_style() [15/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	int32	height,
		xtd::forms::size_type	size_type,
		bool	expanded
	)

Initialises a new instance of vertical control layout style class with specified height, size type and expanded.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expanded	true if control expanded; otherwise false.

vertical_control_layout_style() [16/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	xtd::forms::size_type	size_type,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified size type and content alignment.

Parameters

size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [17/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	float	height,
		xtd::forms::size_type	size_type,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height, size type and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [18/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	int32	height,
		xtd::forms::size_type	size_type,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height, size type and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [19/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	xtd::forms::size_type	size_type,
		bool	expanded,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified size type, expanded and content alignment.

Parameters

size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expanded	true if control expanded; otherwise false.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [20/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	float	height,
		xtd::forms::size_type	size_type,
		bool	expanded,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expanded	true if control expanded; otherwise false.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [21/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	int32	height,
		xtd::forms::size_type	size_type,
		bool	expanded,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
size_type	One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size.
expanded	true if control expanded; otherwise false.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [22/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	bool	expanded,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified expanded and content alignment.

Parameters

expanded	true if control expanded; otherwise false.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [23/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	float	height,
		bool	expanded,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expanded	true if control expanded; otherwise false.
align	One of the content_alignment values. The default is middle_center.

vertical_control_layout_style() [24/24]

xtd::forms::vertical_control_layout_style::vertical_control_layout_style	(	int32	height,
		bool	expanded,
		xtd::forms::content_alignment	align
	)

Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment.

Parameters

height	The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.
expanded	true if control expanded; otherwise false.
align	One of the content_alignment values. The default is middle_center.

Member Function Documentation

height() [1/2]

std::optional< float > xtd::forms::vertical_control_layout_style::height ( ) const

noexcept

Gets the height value for a control.

Returns

The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

height() [2/2]

void xtd::forms::vertical_control_layout_style::height

(

float

height

)

Sets the height value for a control.

Parameters

height

The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property.

to_string()

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

overridevirtualnoexcept

Returns a string that represent xtd::forms::control_layout_style.

Returns

A string containing that represent xtd::forms::control_layout_style.

Reimplemented from xtd::forms::control_layout_style.

---

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

• xtd.forms/include/xtd/forms/vertical_control_layout_style.h