Definition

Stores an ordered pair of integers, which specify a height and width.

class drawing_export_ size : public xtd::object

Inheritance: xtd::object → xtd::drawing::size

Namespace: xtd::drawing

Library: xtd.drawing

Examples:: colored_tab_pages.cpp, docked_panels.cpp, draw_image.cpp, form_background_image.cpp, form_resize.cpp, form_show.cpp, images.cpp, images2.cpp, images3.cpp, point.cpp, process_form.cpp, screen_informations.cpp, settings_example.cpp, settings_example2.cpp, system_sound.cpp, test_forms.cpp, track_bar2.cpp, tutorial_button.cpp, and user_control.cpp.

Fields
static const xtd::drawing::size	empty
	Gets a xtd::drawing::size class that has a Height and Width value of 0. This field is constant. More...

Constructors
	size ()=default
	Initializes a new instance of the xtd::drawing::size class that has a Height and Width value of 0. More...

	size (const xtd::drawing::point &point) noexcept
	Initializes a new instance of the xtd::drawing::size class from the specified xtd::drawing::point class. More...

	size (int32 width, int32 height) noexcept
	Initializes a new instance of the xtd::drawing::size class from the specified dimensions. More...

Properties
int32	height () const noexcept
	Gets he vertical component of this xtd::drawing::size class. More...

void	height (int32 value) noexcept
	Sets the vertical component of this xtd::drawing::size class. More...

bool	is_empty () const noexcept
	Tests whether this xtd::drawing::size class has xtd::drawing::size_fwidth and xtd::drawing::size_fheight of 0. More...

int32	width () const noexcept
	Gets the horizontal component of this xtd::drawing::size class. More...

void	width (int32 value) noexcept
	Sets the horizontal component of this xtd::drawing::size class. More...

Methods
bool	equals (const xtd::drawing::size &value) const noexcept override

xtd::ustring	to_string () const noexcept override
	Creates a human-readable string that represents this xtd::drawing::size class. More...

static size	add (const size &size1, const size &size2) noexcept
	Adds the width and height of one xtd::drawing::size class to the width and height of another size class. More...

static size	ceiling (const size_f &value) noexcept
	Converts the specified xtd::drawing::size_f to a xtd::drawing::size by rounding the values of the xtd::drawing::size_f to the next higher integer values. More...

static size	round (const size_f &value) noexcept
	Converts the specified xtd::drawing::size_f to a xtd::drawing::size object by rounding the xtd::drawing::size_f values to the nearest integer. More...

static xtd::drawing::size	subtract (const xtd::drawing::size &sz1, const xtd::drawing::size &sz2) noexcept
	Returns the result of subtracting specified xtd::drawing::size from the specified xtd::drawing::size. More...

static size	truncate (const size_f &value) noexcept
	Converts the specified xtd::drawing::size_f to a xtd::drawing::size by truncating the values of the xtd::drawing::size_f. More...

Operators
size	operator+ (const xtd::drawing::size &size) const noexcept
	Increases a xtd::drawing::size with a given xtd::drawing::size. More...

size &	operator+= (const xtd::drawing::size &size) noexcept
	Increases a xtd::drawing::size wuth a given xtd::drawing::size. More...

size	operator- (const xtd::drawing::size &size) const noexcept
	Decreases a xtd::drawing::size with the a given xtd::drawing::size. More...

size &	operator-= (const xtd::drawing::size &size) noexcept
	Decreases a xtd::drawing::size with the a given xtd::drawing::size. More...

Additional Inherited Members
Public Member Functions inherited from xtd::object
	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...

Public Member Functions inherited from xtd::iequatable< size >
virtual bool	equals (const size &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type. 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

◆ size() [1/3]

xtd::drawing::size::size ( )

default

Initializes a new instance of the xtd::drawing::size class that has a Height and Width value of 0.

◆ size() [2/3]

xtd::drawing::size::size ( const xtd::drawing::point & point )

explicitnoexcept

Initializes a new instance of the xtd::drawing::size class from the specified xtd::drawing::point class.

Parameters

point The xtd::drawing::point class from which to initialize this xtd::drawing::size class

◆ size() [3/3]

xtd::drawing::size::size	(	int32	width,
		int32	height
	)

noexcept

Initializes a new instance of the xtd::drawing::size class from the specified dimensions.

Parameters

width	The width component of the new xtd::drawing::size.
height	The height component of the new xtd::drawing::size.

Member Function Documentation

◆ add()

static size xtd::drawing::size::add	(	const size &	size1,
		const size &	size2
	)

staticnoexcept

Adds the width and height of one xtd::drawing::size class to the width and height of another size class.

Parameters

size1	The first xtd::drawing::size class to add.
size2	The second xtd::drawing::size class to add.

Returns: xtd::drawing::size A xtd::drawing::size class that is the result of the addition operation.

◆ ceiling()

static size xtd::drawing::size::ceiling ( const size_f & value )

staticnoexcept

Converts the specified xtd::drawing::size_f to a xtd::drawing::size by rounding the values of the xtd::drawing::size_f to the next higher integer values.

Parameters

value The xtd::drawing::size_f to convert.

Returns: The xtd::drawing::size this method converts to.

◆ height() [1/2]

int32 xtd::drawing::size::height ( ) const

noexcept

Gets he vertical component of this xtd::drawing::size class.

Returns: The vertical component of this xtd::drawing::size class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size::height and xtd::drawing::size::width of the xtd::drawing::size class depend on the xtd::drawing::graphics:page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::::graphics object that is used to draw.

Examples:: images.cpp, screen.cpp, and wiggly.cpp.

◆ height() [2/2]

void xtd::drawing::size::height ( int32 value )

noexcept

Sets the vertical component of this xtd::drawing::size class.

Parameters

value The vertical component of this xtd::drawing::size class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size::height and xtd::drawing::size::width of the xtd::drawing::size class depend on the xtd::drawing::graphics:page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::::graphics object that is used to draw.

◆ is_empty()

bool xtd::drawing::size::is_empty ( ) const

noexcept

Tests whether this xtd::drawing::size class has xtd::drawing::size_fwidth and xtd::drawing::size_fheight of 0.

Returns: Returns true when this xtd::drawing::size class has both a xtd::drawing::size::width and xtd::drawing::size::height of 0; otherwise, false.

◆ operator+()

size xtd::drawing::size::operator+ ( const xtd::drawing::size & size ) const

noexcept

Increases a xtd::drawing::size with a given xtd::drawing::size.

Parameters

size	A xtd::drawing::size that specifies the pair of numbers to add to the size of this xtd::drawing::size.

Returns: The increased xtd::drawing::size.

◆ operator+=()

size& xtd::drawing::size::operator+= ( const xtd::drawing::size & size )

noexcept

Increases a xtd::drawing::size wuth a given xtd::drawing::size.

Parameters

size	A xtd::drawing::size that specifies the pair of numbers to add to the size of this xtd::drawing::size.

Returns: The increased xtd::drawing::size.

◆ operator-()

size xtd::drawing::size::operator- ( const xtd::drawing::size & size ) const

noexcept

Decreases a xtd::drawing::size with the a given xtd::drawing::size.

Parameters

size	A xtd::drawing::size that specifies the pair of numbers to subtract from the size of this xtd::drawing::size.

Returns: The decreased xtd::drawing::size.

◆ operator-=()

size& xtd::drawing::size::operator-= ( const xtd::drawing::size & size )

noexcept

Decreases a xtd::drawing::size with the a given xtd::drawing::size.

Parameters

size	A xtd::drawing::size that specifies the pair of numbers to subtract from the size of this xtd::drawing::size.

Returns: The decreased xtd::drawing::size.

◆ round()

static size xtd::drawing::size::round ( const size_f & value )

staticnoexcept

Converts the specified xtd::drawing::size_f to a xtd::drawing::size object by rounding the xtd::drawing::size_f values to the nearest integer.

Parameters

value The xtd::drawing::size_f to convert.

Returns: The xtd::drawing::size this method converts to.

◆ subtract()

static xtd::drawing::size xtd::drawing::size::subtract	(	const xtd::drawing::size &	sz1,
		const xtd::drawing::size &	sz2
	)

staticnoexcept

Returns the result of subtracting specified xtd::drawing::size from the specified xtd::drawing::size.

Parameters

sz1	The xtd::drawing::size to be subtracted from.
sz2	The xtd::drawing::size to subtract from the xtd::drawing::size.

Returns: The xtd::drawing::size that is the result of the subtraction operation.

◆ to_string()

xtd::ustring xtd::drawing::size::to_string ( ) const

overridevirtualnoexcept

Creates a human-readable string that represents this xtd::drawing::size class.

Returns: A xtd::ustring that represents this xtd::drawing::size.

Reimplemented from xtd::object.

◆ truncate()

static size xtd::drawing::size::truncate ( const size_f & value )

staticnoexcept

Converts the specified xtd::drawing::size_f to a xtd::drawing::size by truncating the values of the xtd::drawing::size_f.

Parameters

value The xtd::drawing::size_f to convert.

Returns: The xtd::drawing::size this method converts to.

◆ width() [1/2]

int32 xtd::drawing::size::width ( ) const

noexcept

Gets the horizontal component of this xtd::drawing::size class.

Returns: int The horizontal component of this xtd::drawing::size class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size::height and xtd::drawing::size::width of the xtd::drawing::size class depend on the xtd::drawing::graphics:page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::::graphics object that is used to draw.

Examples:: images.cpp, screen.cpp, and wiggly.cpp.

◆ width() [2/2]

void xtd::drawing::size::width ( int32 value )

noexcept

Sets the horizontal component of this xtd::drawing::size class.

Parameters

value The horizontal component of this xtd::drawing::size class, typically measured in pixels.

Remarks: The unit for the xtd::drawing::size::height and xtd::drawing::size::width of the xtd::drawing::size class depend on the xtd::drawing::graphics:page_unit and xtd::drawing::graphics::page_scale settings for the xtd::drawing::::graphics object that is used to draw.

Member Data Documentation

◆ empty

const xtd::drawing::size xtd::drawing::size::empty

static

Gets a xtd::drawing::size class that has a Height and Width value of 0. This field is constant.

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

xtd.drawing/include/xtd/drawing/size.h

Definition

Fields

Constructors

Properties

Methods

Operators

Additional Inherited Members

Constructor & Destructor Documentation

◆ size() [1/3]

◆ size() [2/3]

◆ size() [3/3]

Member Function Documentation

◆ add()

◆ ceiling()

◆ height() [1/2]

◆ height() [2/2]

◆ is_empty()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ round()

◆ subtract()

◆ to_string()

◆ truncate()

◆ width() [1/2]

◆ width() [2/2]

Member Data Documentation

◆ empty