xtd - Reference Guide 0.2.0
xtd::forms::style_sheets::border_color Class Reference

#include <border_color.h>

Definition

The xtd::forms::style_sheets::border_color is used to set the color of the borders.

class forms_export_ border_color : public xtd::iequatable<border_color>, public xtd::object
Inheritance
xtd::objectxtd::forms::style_sheets::border_color
Implements
xtd::iequatable <>
Namespace
xtd::forms::style_sheets
Library
xtd.forms

Fields

static const border_color empty
 Provides an empty xtd::forms::style_sheets::border_color object. More...
 

Constructors

 border_color ()=default
 Initializes a new instance of the xtd::forms::style_sheets::border_color class. More...
 
 border_color (const xtd::drawing::color &all)
 Initializes a new instance of the xtd::forms::style_sheets::border_color class using the supplied border_color for all edges. More...
 
 border_color (const xtd::drawing::color &left, const xtd::drawing::color &top, const xtd::drawing::color &right, const xtd::drawing::color &bottom)
 Initializes a new instance of the xtd::forms::style_sheets::border_color class using a separate border_color for each edge. More...
 

Peorperties

const xtd::drawing::colorall () const noexcept
 Gets the xtd::forms::style_sheets::border_color value for all the edges. More...
 
void all (const xtd::drawing::color &all) noexcept
 Sets the xtd::forms::style_sheets::border_color value for all the edges. More...
 
const xtd::drawing::colorbottom () const noexcept
 Gets the xtd::forms::style_sheets::border_color value for the bottom edge. More...
 
void bottom (const xtd::drawing::color &bottom) noexcept
 Sets the xtd::forms::style_sheets::border_color value for the bottom edge. More...
 
const xtd::drawing::colorleft () const noexcept
 Gets the xtd::forms::style_sheets::border_color value for the left edge. More...
 
void left (const xtd::drawing::color &left) noexcept
 Sets the xtd::forms::style_sheets::border_color value for the left edge. More...
 
const xtd::drawing::colorright () const noexcept
 Gets the xtd::forms::style_sheets::border_color value for the right edge. More...
 
void right (const xtd::drawing::color &right) noexcept
 Sets the xtd::forms::style_sheets::border_color value for the right edge. More...
 
const xtd::drawing::colortop () const noexcept
 Gets the xtd::forms::style_sheets::border_color value for the top edge. More...
 
void top (const xtd::drawing::color &top) noexcept
 Sets the xtd::forms::style_sheets::border_color 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_color &other) const noexcept override
 

Additional Inherited Members

- Public Member Functions inherited from xtd::iequatable< border_color >
virtual bool equals (const border_color &) 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_color() [1/3]

xtd::forms::style_sheets::border_color::border_color ( )
default

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

◆ border_color() [2/3]

xtd::forms::style_sheets::border_color::border_color ( const xtd::drawing::color all)

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

Parameters
allThe xtd::forms::style_sheets::color_data to be used for border_color for all edges.
Remarks
This constructor sets the right, left, bottom, top and all properties to the value of the all parameter.

◆ border_color() [3/3]

xtd::forms::style_sheets::border_color::border_color ( const xtd::drawing::color left,
const xtd::drawing::color top,
const xtd::drawing::color right,
const xtd::drawing::color bottom 
)

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

Parameters
leftThe border_color for the left edge.
topThe border_color for the top edge.
rightThe border_color for the right edge.
bottomThe border_color 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]

const xtd::drawing::color& xtd::forms::style_sheets::border_color::all ( ) const
noexcept

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

Returns
The xtd::forms::style_sheets::border_color for all edges if the same; otherwise, xtd::forms::style_sheets::color_data::empty.
Remarks
When retrieving this property, if all the edges use the same border_color value, then this common value is returned. Otherwise, xtd::forms::style_sheets::color_data::empty is returned to indicate that all the xtd::forms::style_sheets::border_color values are not equal.

◆ all() [2/2]

void xtd::forms::style_sheets::border_color::all ( const xtd::drawing::color all)
noexcept

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

Parameters
allThe xtd::forms::style_sheets::border_color for all edges if the same; otherwise, xtd::forms::style_sheets::color_data::empty.
Remarks
When retrieving this property, if all the edges use the same border_color value, then this common value is returned. Otherwise, xtd::forms::style_sheets::color_data::empty is returned to indicate that all the xtd::forms::style_sheets::border_color values are not equal.

◆ bottom() [1/2]

const xtd::drawing::color& xtd::forms::style_sheets::border_color::bottom ( ) const
noexcept

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

Returns
The xtd::forms::style_sheets::border_color for the bottom edge.
Remarks
Setting this value can also alter the all property.

◆ bottom() [2/2]

void xtd::forms::style_sheets::border_color::bottom ( const xtd::drawing::color bottom)
noexcept

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

Parameters
bottomThe xtd::forms::style_sheets::border_color for the bottom edge.
Remarks
Setting this value can also alter the all property.

◆ equals()

bool xtd::forms::style_sheets::border_color::equals ( const object obj) const
overridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters
objThe 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]

const xtd::drawing::color& xtd::forms::style_sheets::border_color::left ( ) const
noexcept

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

Returns
The xtd::forms::style_sheets::border_color for the left edge.
Remarks
Setting this value can also alter the all property.

◆ left() [2/2]

void xtd::forms::style_sheets::border_color::left ( const xtd::drawing::color left)
noexcept

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

Parameters
leftThe xtd::forms::style_sheets::border_color for the left edge.
Remarks
Setting this value can also alter the all property.

◆ right() [1/2]

const xtd::drawing::color& xtd::forms::style_sheets::border_color::right ( ) const
noexcept

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

Returns
The xtd::forms::style_sheets::border_color for the right edge.
Remarks
Setting this value can also alter the all property.

◆ right() [2/2]

void xtd::forms::style_sheets::border_color::right ( const xtd::drawing::color right)
noexcept

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

Parameters
rightThe xtd::forms::style_sheets::border_color for the right edge.
Remarks
Setting this value can also alter the all property.

◆ top() [1/2]

const xtd::drawing::color& xtd::forms::style_sheets::border_color::top ( ) const
noexcept

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

Returns
The xtd::forms::style_sheets::border_color for the top edge.
Remarks
Setting this value can also alter the all property.

◆ top() [2/2]

void xtd::forms::style_sheets::border_color::top ( const xtd::drawing::color top)
noexcept

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

Parameters
topThe xtd::forms::style_sheets::border_color for the top edge.
Remarks
Setting this value can also alter the all property.

Member Data Documentation

◆ empty

const border_color xtd::forms::style_sheets::border_color::empty
static

Provides an empty xtd::forms::style_sheets::border_color object.


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