# OfficeBorderSide

Describes one visible edge of a rectangular border box.

Struct 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeBorderSide.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L11)

**Base**

`ValueType`

**Implements**

`IEquatable<OfficeBorderSide>`

**Modifiers**

sealed

Describes one visible edge of a rectangular border box.

## Inheritance

- ValueType
- OfficeBorderSide

## Usage

Explore 18 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 6

- Property [OfficeBorderBox.Bottom](/api/core/officeimo-drawing-officeborderbox/#property-bottom)
- Property [OfficeBorderBox.DiagonalDown](/api/core/officeimo-drawing-officeborderbox/#property-diagonaldown)
- Property [OfficeBorderBox.DiagonalUp](/api/core/officeimo-drawing-officeborderbox/#property-diagonalup)
- Property [OfficeBorderBox.Left](/api/core/officeimo-drawing-officeborderbox/#property-left)
- Property [OfficeBorderBox.Right](/api/core/officeimo-drawing-officeborderbox/#property-right)
- Property [OfficeBorderBox.Top](/api/core/officeimo-drawing-officeborderbox/#property-top)

### Accepted by parameters 12

- Constructor [OfficeBorderBox.OfficeBorderBox](/api/core/officeimo-drawing-officeborderbox/#constructor-ctor-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside) parameter `bottom`
- Constructor [OfficeBorderBox.OfficeBorderBox](/api/core/officeimo-drawing-officeborderbox/#constructor-ctor-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside) parameter `diagonalDown`
- Constructor [OfficeBorderBox.OfficeBorderBox](/api/core/officeimo-drawing-officeborderbox/#constructor-ctor-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside) parameter `diagonalUp`
- Constructor [OfficeBorderBox.OfficeBorderBox](/api/core/officeimo-drawing-officeborderbox/#constructor-ctor-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside) parameter `left`
- Constructor [OfficeBorderBox.OfficeBorderBox](/api/core/officeimo-drawing-officeborderbox/#constructor-ctor-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside) parameter `right`
- Constructor [OfficeBorderBox.OfficeBorderBox](/api/core/officeimo-drawing-officeborderbox/#constructor-ctor-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside-nullable-officeimo-drawing-officeborderside) parameter `top`
- Method [OfficeBorderBox.Uniform](/api/core/officeimo-drawing-officeborderbox/#method-uniform-officeimo-drawing-officeborderside) parameter `side`
- Method [OfficeBorderSide.Equals](/api/core/officeimo-drawing-officeborderside/#method-equals-officeimo-drawing-officeborderside) parameter `other`
- Method [OfficeBorderSide.op_Equality](/api/core/officeimo-drawing-officeborderside/#method-op-equality-officeimo-drawing-officeborderside-officeimo-drawing-officeborderside) parameter `left`
- Method [OfficeBorderSide.op_Equality](/api/core/officeimo-drawing-officeborderside/#method-op-equality-officeimo-drawing-officeborderside-officeimo-drawing-officeborderside) parameter `right`
- Method [OfficeBorderSide.op_Inequality](/api/core/officeimo-drawing-officeborderside/#method-op-inequality-officeimo-drawing-officeborderside-officeimo-drawing-officeborderside) parameter `left`
- Method [OfficeBorderSide.op_Inequality](/api/core/officeimo-drawing-officeborderside/#method-op-inequality-officeimo-drawing-officeborderside-officeimo-drawing-officeborderside) parameter `right`

Filter members 

Show inherited

## Constructors

`public OfficeBorderSide(OfficeColor color, double width, OfficeStrokeDashStyle dashStyle = Solid, OfficeBorderLineKind lineKind = Single, double doubleLineSeparation = 0)` [#](#constructor-ctor-officeimo-officecolor-double-officeimo-drawing-officestrokedashstyle-officeimo-drawing-officeborderlinekind-double)

[OfficeBorderSide.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L11)

Creates a border side.

Parameters

**color OfficeIMO.OfficeColor required**

**width double required**

**dashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optional**

**lineKind OfficeIMO.Drawing.OfficeBorderLineKind = Single optional**

**doubleLineSeparation double = 0 optional**

## Methods

Equals 2 overloads

`public bool Equals(OfficeBorderSide other)` [#](#method-equals-officeimo-drawing-officeborderside)

[OfficeBorderSide.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L46)

Indicates whether the current object is equal to another object of the same type.

Parameters

**other OfficeIMO.Drawing.OfficeBorderSide required**

An object to compare with this object.

Returns

`bool` true if the current object is equal to the other parameter; otherwise, false.

`public override bool Equals(object? obj)` [#](#method-equals-object)

[OfficeBorderSide.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L53)

Indicates whether this instance and a specified object are equal.

Parameters

**obj object? required**

The object to compare with the current instance.

Returns

`bool` true if obj and this instance are the same type and represent the same value; otherwise, false.

`public override int GetHashCode()` [#](#method-gethashcode)

[OfficeBorderSide.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L58)

Returns the hash code for this instance.

Returns

`int` A 32-bit signed integer that is the hash code for this instance.

`public static bool op_Equality(OfficeBorderSide left, OfficeBorderSide right)` [#](#method-op-equality-officeimo-drawing-officeborderside-officeimo-drawing-officeborderside)

[OfficeBorderSide.cs:69](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L69)

Compares two border sides for equality.

Parameters

**left OfficeIMO.Drawing.OfficeBorderSide required**

**right OfficeIMO.Drawing.OfficeBorderSide required**

Returns

`bool`

`public static bool op_Inequality(OfficeBorderSide left, OfficeBorderSide right)` [#](#method-op-inequality-officeimo-drawing-officeborderside-officeimo-drawing-officeborderside)

[OfficeBorderSide.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L72)

Compares two border sides for inequality.

Parameters

**left OfficeIMO.Drawing.OfficeBorderSide required**

**right OfficeIMO.Drawing.OfficeBorderSide required**

Returns

`bool`

## Inherited Methods

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public override string? ToString()` [#](#method-tostring)

Inherited from ValueType

Returns

`string?`

## Properties

`public OfficeColor Color { get; }` [#](#property-color)

[OfficeBorderSide.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L27)

Border color.

`public double Width { get; }` [#](#property-width)

[OfficeBorderSide.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L30)

Border width in the caller's layout unit.

`public OfficeStrokeDashStyle DashStyle { get; }` [#](#property-dashstyle)

[OfficeBorderSide.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L33)

Border dash style.

`public OfficeBorderLineKind LineKind { get; }` [#](#property-linekind)

[OfficeBorderSide.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L36)

Border line composition.

`public double DoubleLineSeparation { get; }` [#](#property-doublelineseparation)

[OfficeBorderSide.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L39)

Distance between the two stroke centers when [OfficeBorderSide.LineKind](/api/core/officeimo-drawing-officeborderside/) is [OfficeBorderLineKind.Double](/api/core/officeimo-drawing-officeborderlinekind/).

`public bool IsVisible { get; }` [#](#property-isvisible)

[OfficeBorderSide.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeBorderSide.cs#L42)

Whether this side should be drawn.

<!-- PowerForge markdown artifact sha256:9A78A951D7A5219D8E196AA4E3EF35ABA755AE806C72D21492A6EBE6C2F28F99 -->
