Class BorderImpl

Represents the border of an object.

Inheritance
System.Object
CommonObject
BorderImpl
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class BorderImpl : CommonObject, IBorder, IParentApplication, IDisposable

Fields

DEF_BADCOLOR_INCREMENT

Increment for color value in order to let MS Excel edit styles.

Declaration
public const int DEF_BADCOLOR_INCREMENT = 64
Field Value
Type Description
System.Int32

DEF_MAXBADCOLOR

Maximum color index that requires modification in order to let MS Excel edit styles.

Declaration
public const int DEF_MAXBADCOLOR = 8
Field Value
Type Description
System.Int32

Properties

Color

Returns or sets the primary color of the object, as shown in the following table. Use the RGB function to create a color value. Read/write Long.

Declaration
public ExcelKnownColors Color { get; set; }
Property Value
Type Description
ExcelKnownColors

ColorObject

Returns or sets the primary color of the object, as shown in the following table. Use the RGB function to create a color value. Read/write Long.

Declaration
public ColorObject ColorObject { get; }
Property Value
Type Description
ColorObject

ColorRGB

Returns or sets the primary color of the object, as shown in the following table. Use the RGB function to create a color value. Read/write Color.

Declaration
public Color ColorRGB { get; set; }
Property Value
Type Description
System.Drawing.Color

LineStyle

Returns or sets the line style for the border. Read/write ExcelLineStyle.

Declaration
public ExcelLineStyle LineStyle { get; set; }
Property Value
Type Description
ExcelLineStyle

ShowDiagonalLine

This property is used only by Diagonal borders. For any other border index property will have no influence.

Declaration
public bool ShowDiagonalLine { get; set; }
Property Value
Type Description
System.Boolean

Methods

Clone(StyleImpl)

Clone current object.

Declaration
public BorderImpl Clone(StyleImpl newFormat)
Parameters
Type Name Description
StyleImpl newFormat

New extended format.
Returns
Type Description
BorderImpl

Cloned border object.

CopyFrom(IBorder)

Copies all fields from baseBorder except Parent.

Declaration
public void CopyFrom(IBorder baseBorder)
Parameters
Type Name Description
IBorder baseBorder

Border that will be copied.

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The Object to compare with the current Object.
Returns
Type Description
System.Boolean

true if the specified Object is equal to the current Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

A hash code for the current object.
Overrides
System.Object.GetHashCode()

NormalizeColor(ExcelKnownColors)

Normalizes border color to let MS Excel edit style.

Declaration
public static ExcelKnownColors NormalizeColor(ExcelKnownColors color)
Parameters
Type Name Description
ExcelKnownColors color

Color to normalize.
Returns
Type Description
ExcelKnownColors

New color value.

Explicit Interface Implementations

IDisposable.Dispose()

Declaration
void IDisposable.Dispose()

Implements

System.IDisposable