#include <border_style.h>

Definition

The style specifies what kind of borders to display.

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

Inheritance: xtd::object → xtd::forms::style_sheets::border_style

Implements: xtd::iequatable <>

Namespace: xtd::forms::style_sheets

Library: xtd.forms

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

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

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

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

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

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

border_type	bottom () const
	Gets the xtd::forms::style_sheets::border_style value for the bottom edge. More...

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

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

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

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

void	right (border_type right)
	Sets the xtd::forms::style_sheets::border_style value for the right edge. More...

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

void	top (border_type top) noexcept
	Sets the xtd::forms::style_sheets::border_style 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 border_style &other) const noexcept override

Additional Inherited Members
Public Member Functions inherited from xtd::iequatable< border_style >
virtual bool	equals (const border_style &) 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...

virtual xtd::ustring	to_string () const noexcept
	Returns a sxd::ustring that represents the current object. 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

◆ border_style() [1/3]

xtd::forms::style_sheets::border_style::border_style ( )

default

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

◆ border_style() [2/3]

xtd::forms::style_sheets::border_style::border_style ( border_type all )

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

Parameters

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

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

◆ border_style() [3/3]

xtd::forms::style_sheets::border_style::border_style	(	border_type	left,
		border_type	top,
		border_type	right,
		border_type	bottom
	)

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

Parameters

left	The xtd::forms::style_sheets::border_style size for the left edge.
top	The xtd::forms::style_sheets::border_style size for the top edge.
right	The xtd::forms::style_sheets::border_style size for the right edge.
bottom	The xtd::forms::style_sheets::border_style size 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]

border_type xtd::forms::style_sheets::border_style::all ( ) const

noexcept

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

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

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

◆ all() [2/2]

void xtd::forms::style_sheets::border_style::all ( border_type all )

noexcept

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

Parameters

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

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

◆ bottom() [1/2]

border_type xtd::forms::style_sheets::border_style::bottom ( ) const

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

Returns: The xtd::forms::style_sheets::border_style for the bottom edge.

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

◆ bottom() [2/2]

void xtd::forms::style_sheets::border_style::bottom ( border_type bottom )

noexcept

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

Parameters

bottom The xtd::f noexceptorms::style_sheets::border_style for the bottom edge.

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

◆ equals()

bool xtd::forms::style_sheets::border_style::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]

border_type xtd::forms::style_sheets::border_style::left ( ) const

noexcept

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

Returns: The xtd::forms::style_sheets::border_style for the left edge.

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

◆ left() [2/2]

void xtd::forms::style_sheets::border_style::left ( border_type left )

noexcept

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

Parameters

left	The xtd::forms::style_sheets::border_style for the left edge.

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

◆ right() [1/2]

border_type xtd::forms::style_sheets::border_style::right ( ) const

noexcept

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

Returns: The xtd::forms::style_sheets::border_style for the right edge.

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

◆ right() [2/2]

void xtd::forms::style_sheets::border_style::right ( border_type right )

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

Parameters

right The xtd::forms::style_sheets::border_style for the right edge.

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

◆ top() [1/2]

border_type xtd::forms::style_sheets::border_style::top ( ) const

noexcept

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

Returns: The xtd::forms::style_sheets::border_style for the top edge.

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

◆ top() [2/2]

void xtd::forms::style_sheets::border_style::top ( border_type top )

noexcept

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

Parameters

top	The xtd::forms::style_sheets::border_style for the top edge.

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

Member Data Documentation

◆ empty

const border_style xtd::forms::style_sheets::border_style::empty

static

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

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

xtd.forms/include/xtd/forms/style_sheets/border_style.h

Definition

Fields

Constructors

Peorperties

Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ border_style() [1/3]

◆ border_style() [2/3]

◆ border_style() [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]

◆ top() [1/2]

◆ top() [2/2]

Member Data Documentation

◆ empty