Class representing a Border entry. The Border entry is used to define frames and cell borders. More...

Inheritance diagram for NanoXLSX.Styles.Border:

Public Types
enum	StyleValue { None , Hair , Dotted , DashDotDot , DashDot , Dashed , Thin , MediumDashDotDot , SlantDashDot , MediumDashDot , MediumDashed , Medium , Thick , Double }
	Enum for the border style, used by the Border class. More...

Public Member Functions
	Border ()
	Default constructor.
override int	GetHashCode ()
	Returns a hash code for this instance.
override bool	Equals (object obj)
	Returns whether two instances are the same.
override AbstractStyle	Copy ()
	Method to copy the current object to a new one without casting.
Border	CopyBorder ()
	Method to copy the current object to a new one with casting.
override string	ToString ()
	Override toString method.
Public Member Functions inherited from NanoXLSX.Styles.AbstractStyle
AbstractStyle	Copy ()
	Abstract method to copy a component (dereferencing).
int	CompareTo (AbstractStyle other)
	Method to compare two objects for sorting purpose.
bool	Equals (AbstractStyle other)
	Method to compare two objects for sorting purpose.

Static Public Attributes
static readonly StyleValue	DefaultBorderStyle = StyleValue.None
	Default border style as constant.
static readonly string	DefaultBorderColor = ""
	Default border color as constant.

Properties
string	BottomColor `[get, set]`
	Gets or sets the color code of the bottom border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.
StyleValue	BottomStyle `[get, set]`
	Gets or sets the style of bottom cell border.
string	DiagonalColor `[get, set]`
	Gets or sets the color code of the diagonal lines. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.
bool	DiagonalDown `[get, set]`
	Gets or sets whether the downwards diagonal line is used. If true, the line is used.
bool	DiagonalUp `[get, set]`
	Gets or sets whether the upwards diagonal line is used. If true, the line is used.
StyleValue	DiagonalStyle `[get, set]`
	Gets or sets the style of the diagonal lines.
string	LeftColor `[get, set]`
	Gets or sets the color code of the left border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.
StyleValue	LeftStyle `[get, set]`
	Gets or sets the style of left cell border.
string	RightColor `[get, set]`
	Gets or sets the color code of the right border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.
StyleValue	RightStyle `[get, set]`
	Gets or sets the style of right cell border.
string	TopColor `[get, set]`
	Gets or sets the color code of the top border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.
StyleValue	TopStyle `[get, set]`
	Gets or sets the style of top cell border.
Properties inherited from NanoXLSX.Styles.AbstractStyle
int?	InternalID `[get, set]`
	Gets or sets the internal ID for sorting purpose in the Excel style document (nullable).

Detailed Description

Class representing a Border entry. The Border entry is used to define frames and cell borders.

Definition at line 17 of file Border.cs.

Member Enumeration Documentation

◆ StyleValue

enum NanoXLSX.Styles.Border.StyleValue

Enum for the border style, used by the Border class.

Enumerator
None	no border
Hair	hair border
Dotted	dotted border
DashDotDot	dashed border with double-dots
DashDot	dash-dotted border
Dashed	dashed border
Thin	thin border
MediumDashDotDot	medium-dashed border with double-dots
SlantDashDot	slant dash-dotted border
MediumDashDot	medium dash-dotted border
MediumDashed	medium dashed border
Medium	medium border
Thick	thick border
Double	double border

Definition at line 46 of file Border.cs.

Constructor & Destructor Documentation

◆ Border()

NanoXLSX.Styles.Border.Border ( )

Default constructor.

Definition at line 222 of file Border.cs.

Member Function Documentation

◆ Copy()

override AbstractStyle NanoXLSX.Styles.Border.Copy ( )

Method to copy the current object to a new one without casting.

Returns: Copy of the current object without the internal ID

Definition at line 293 of file Border.cs.

◆ CopyBorder()

Border NanoXLSX.Styles.Border.CopyBorder ( )

Method to copy the current object to a new one with casting.

Returns: Copy of the current object without the internal ID

Definition at line 317 of file Border.cs.

◆ Equals()

override bool NanoXLSX.Styles.Border.Equals ( object obj )

Returns whether two instances are the same.

Parameters

obj	Object to compare

Returns: True if this instance and the other are the same

Definition at line 272 of file Border.cs.

◆ GetHashCode()

override int NanoXLSX.Styles.Border.GetHashCode ( )

Returns a hash code for this instance.

Returns: A hash code for this instance, suitable to be used in hashing algorithms and data structures like a hash table.

Definition at line 246 of file Border.cs.

◆ ToString()

override string NanoXLSX.Styles.Border.ToString ( )

Override toString method.

Returns: String of a class

Definition at line 326 of file Border.cs.

Member Data Documentation

◆ DefaultBorderColor

readonly string NanoXLSX.Styles.Border.DefaultBorderColor = ""

static

Default border color as constant.

Definition at line 29 of file Border.cs.

◆ DefaultBorderStyle

readonly StyleValue NanoXLSX.Styles.Border.DefaultBorderStyle = StyleValue.None

static

Default border style as constant.

Definition at line 24 of file Border.cs.

Property Documentation

◆ BottomColor

string NanoXLSX.Styles.Border.BottomColor

getset

Gets or sets the color code of the bottom border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.

Definition at line 86 of file Border.cs.

◆ BottomStyle

StyleValue NanoXLSX.Styles.Border.BottomStyle

getset

Gets or sets the style of bottom cell border.

Definition at line 106 of file Border.cs.

◆ DiagonalColor

string NanoXLSX.Styles.Border.DiagonalColor

getset

Gets or sets the color code of the diagonal lines. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.

Definition at line 111 of file Border.cs.

◆ DiagonalDown

bool NanoXLSX.Styles.Border.DiagonalDown

getset

Gets or sets whether the downwards diagonal line is used. If true, the line is used.

Definition at line 131 of file Border.cs.

◆ DiagonalStyle

StyleValue NanoXLSX.Styles.Border.DiagonalStyle

getset

Gets or sets the style of the diagonal lines.

Definition at line 141 of file Border.cs.

◆ DiagonalUp

bool NanoXLSX.Styles.Border.DiagonalUp

getset

Gets or sets whether the upwards diagonal line is used. If true, the line is used.

Definition at line 136 of file Border.cs.

◆ LeftColor

string NanoXLSX.Styles.Border.LeftColor

getset

Gets or sets the color code of the left border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.

Definition at line 146 of file Border.cs.

◆ LeftStyle

StyleValue NanoXLSX.Styles.Border.LeftStyle

getset

Gets or sets the style of left cell border.

Definition at line 166 of file Border.cs.

◆ RightColor

string NanoXLSX.Styles.Border.RightColor

getset

Gets or sets the color code of the right border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.

Definition at line 171 of file Border.cs.

◆ RightStyle

StyleValue NanoXLSX.Styles.Border.RightStyle

getset

Gets or sets the style of right cell border.

Definition at line 191 of file Border.cs.

◆ TopColor

string NanoXLSX.Styles.Border.TopColor

getset

Gets or sets the color code of the top border. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF. If set, the value will be cast to upper case.

Definition at line 196 of file Border.cs.

◆ TopStyle

StyleValue NanoXLSX.Styles.Border.TopStyle

getset

Gets or sets the style of top cell border.

Definition at line 215 of file Border.cs.

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

Border.cs

Public Types

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ StyleValue

Constructor & Destructor Documentation

◆ Border()

Member Function Documentation

◆ Copy()

◆ CopyBorder()

◆ Equals()

◆ GetHashCode()

◆ ToString()

Member Data Documentation

◆ DefaultBorderColor

◆ DefaultBorderStyle

Property Documentation

◆ BottomColor

◆ BottomStyle

◆ DiagonalColor

◆ DiagonalDown

◆ DiagonalStyle

◆ DiagonalUp

◆ LeftColor

◆ LeftStyle

◆ RightColor

◆ RightStyle

◆ TopColor

◆ TopStyle