Class Border

The border.

Border(BorderStyle)

Initializes a new instance of the Border class with the specified style and default thickness and color.

Declaration

cs-api-definition

public Border(BorderStyle style)

Parameters

style

The style.

Border(double, BorderStyle, ThemableColor)

Initializes a new instance of the Border class with the specified thickness, style, and color.

Declaration

cs-api-definition

public Border(double thickness, BorderStyle style, ThemableColor color)

Parameters

thickness

The thickness.

style

The style.

color

ThemableColor

The color.

Border(double, BorderStyle, ThemableColor, bool, bool, double)

Initializes a new instance of the Border class with full appearance control including optional shadow, frame, and spacing effects.

Declaration

cs-api-definition

public Border(double thickness, BorderStyle style, ThemableColor color, bool shadow, bool frame, double spacing)

Parameters

thickness

The thickness.

style

The style.

color

ThemableColor

The color.

shadow

The shadow.

frame

The frame.

spacing

The spacing.

Properties

Color

Gets the border color, which may reference a document theme color.

Declaration

cs-api-definition

public ThemableColor Color { get; }

Property Value

ThemableColor

The color.

Frame

Gets a value indicating whether a frame effect is applied to the border.

Declaration

cs-api-definition

public bool Frame { get; }

Property Value

The frame.

Shadow

Gets a value indicating whether a shadow effect is applied to the border.

Declaration

cs-api-definition

public bool Shadow { get; }

Property Value

The shadow.

Spacing

Gets the spacing between the border and the content it surrounds, in device independent pixels.

Declaration

cs-api-definition

public double Spacing { get; }

Property Value

The spacing.

Style

Gets the visual pattern of the border line.

Declaration

cs-api-definition

public BorderStyle Style { get; }

Property Value

The style.

Thickness

Gets the width of the border line in device independent pixels.

Declaration

cs-api-definition

public double Thickness { get; }

Property Value

The thickness.

Methods

CompareTo(Border)

Compares a borders to another.

Declaration

cs-api-definition

public int CompareTo(Border other)

Parameters

other

The other.

Returns

int

Implements IComparable<Border>.CompareTo(Border)

Equals(object)

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

Declaration

cs-api-definition

public override bool Equals(object obj)

Parameters

obj

object

The object to compare with the current object.

Returns

Returns true if the specified object is equal to the current object; otherwise, false.

Overrides object.Equals(object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration

cs-api-definition

public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()

Operators

operator !=(Border, Border)

Determines whether the specified borders are different.

Declaration

cs-api-definition

public static bool operator !=(Border first, Border second)

Parameters

first

second

Returns

True if the borders are different.

operator ==(Border, Border)

Determines whether the specified borders are equal.

Declaration

cs-api-definition

public static bool operator ==(Border first, Border second)

Parameters

first

second

Returns