Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Struct

OfficeBorderSide

Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
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.

Accepted by parameters 12

Constructors

public OfficeBorderSide(OfficeColor color, Double width, OfficeStrokeDashStyle dashStyle = Solid, OfficeBorderLineKind lineKind = Single, Double doubleLineSeparation = 0) #

Creates a border side.

Parameters

color OfficeIMO.Drawing.OfficeColor requiredposition: 0
width System.Double requiredposition: 1
dashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 2
lineKind OfficeIMO.Drawing.OfficeBorderLineKind = Single optionalposition: 3
doubleLineSeparation System.Double = 0 optionalposition: 4

Methods

Equals 2 overloads
public Boolean Equals(OfficeBorderSide other) #
Returns: Boolean

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

Parameters

other OfficeIMO.Drawing.OfficeBorderSide requiredposition: 0
An object to compare with this object.

Returns

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

public override Boolean Equals(Object? obj) #
Returns: Boolean

Indicates whether this instance and a specified object are equal.

Parameters

obj System.Object? requiredposition: 0
The object to compare with the current instance.

Returns

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

public override Int32 GetHashCode() #
Returns: Int32

Returns the hash code for this instance.

Returns

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

public static Boolean op_Equality(OfficeBorderSide left, OfficeBorderSide right) #
Returns: Boolean

Compares two border sides for equality.

Parameters

left OfficeIMO.Drawing.OfficeBorderSide requiredposition: 0
right OfficeIMO.Drawing.OfficeBorderSide requiredposition: 1
public static Boolean op_Inequality(OfficeBorderSide left, OfficeBorderSide right) #
Returns: Boolean

Compares two border sides for inequality.

Parameters

left OfficeIMO.Drawing.OfficeBorderSide requiredposition: 0
right OfficeIMO.Drawing.OfficeBorderSide requiredposition: 1

Properties

public OfficeColor Color { get; } #

Border color.

public Double Width { get; } #

Border width in the caller's layout unit.

public OfficeStrokeDashStyle DashStyle { get; } #

Border dash style.

public OfficeBorderLineKind LineKind { get; } #

Border line composition.

public Double DoubleLineSeparation { get; } #

Distance between the two stroke centers when OfficeBorderSide.LineKind is OfficeBorderLineKind.Double.

public Boolean IsVisible { get; } #

Whether this side should be drawn.