Class Borders

Represents the collection of Border that includes top, bottom, right and left borders.

Inheritance
System.Object
OwnerHolder
XDLSSerializableBase
FormatBase
Borders
Implements
Inherited Members
Namespace: Syncfusion.DocIO.DLS
Assembly: Syncfusion.DocIO.UWP.dll
Syntax
public class Borders : FormatBase, IXDLSSerializable

Constructors

Borders()

Initializes a new instance of the Borders class.

Declaration
public Borders()

Fields

BottomKey

Constant value for bottom key.

Declaration
public const int BottomKey = 3
Field Value
Type
System.Int32

DiagonalDownKey

constant value for diagonal down key.

Declaration
public const int DiagonalDownKey = 7
Field Value
Type
System.Int32

DiagonalUpKey

constant value for diagonal up key.

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

HorizontalKey

constant value for horizontal key.

Declaration
public const int HorizontalKey = 6
Field Value
Type
System.Int32

LeftKey

Constant value for left key.

Declaration
public const int LeftKey = 1
Field Value
Type
System.Int32

RightKey

Constant value for right key.

Declaration
public const int RightKey = 4
Field Value
Type
System.Int32

TopKey

Constant value for top key.

Declaration
public const int TopKey = 2
Field Value
Type
System.Int32

VerticalKey

constant value for vertical key.

Declaration
public const int VerticalKey = 5
Field Value
Type
System.Int32

Properties

BorderType

Sets style of the borders. Write-only.

Declaration
public BorderStyle BorderType { set; }
Property Value
Type Description
BorderStyle

The BorderStyle member that specifies the style for left, right, top, bottom, vertical and horizontal borders.

Bottom

Gets the bottom border. Read-only.

Declaration
public Border Bottom { get; }
Property Value
Type Description
Border

The Border for bottom.

Color

Sets color of the borders. Write-only.

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

The System.Drawing.Color for left, right, top and bottom borders.

Horizontal

Gets horizontal border. Read-only.

Declaration
public Border Horizontal { get; }
Property Value
Type Description
Border

The horizontal Border.

Left

Gets the left border. Read-only.

Declaration
public Border Left { get; }
Property Value
Type Description
Border

The Border for left.

LineWidth

Sets width of the borders. Write-only.

Declaration
public float LineWidth { set; }
Property Value
Type Description
System.Single

The float value specifies the line width for left, right, top and bottom borders.

NoBorder

Gets a value indicating whether the border exists. Read-only.

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

True if there is no border; otherwise, false.

Right

Gets the right border. Read-only.

Declaration
public Border Right { get; }
Property Value
Type Description
Border

The Border for right.

Shadow

Sets whether borders should be drawn with shadow. Write-only.

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

True if shadow should be drawn; otherwise, false.

Space

Sets width of space to maintain between borders and text within borders. Write-only.

Declaration
public float Space { set; }
Property Value
Type Description
System.Single

The float that specifies the width of the space.

Top

Gets the top border. Read-only.

Declaration
public Border Top { get; }
Property Value
Type Description
Border

The Border for top.

Vertical

Gets the vertical border. Read-only.

Declaration
public Border Vertical { get; }
Property Value
Type Description
Border

The vertical Border.

Methods

Clone()

Creates duplicate copy of the entity.

Declaration
public Borders Clone()
Returns
Type Description
Borders

The reference to the newly created Borders.

CloneImpl()

Creates duplicate copy of the entity.

Declaration
protected override object CloneImpl()
Returns
Type Description
System.Object

An object that can be casted as Borders.
Overrides

EnsureComposites()

Ensures the composites.

Declaration
protected override void EnsureComposites()
Overrides

GetDefComposite(Int32)

Gets the composite values.

Declaration
protected override FormatBase GetDefComposite(int key)
Parameters
Type Name Description
System.Int32 key

The integer that specifies the key.
Returns
Type Description
FormatBase

The FormatBase object.
Overrides

GetDefValue(Int32)

Returns the default values.

Declaration
protected override object GetDefValue(int key)
Parameters
Type Name Description
System.Int32 key

The integer that specifies the key.
Returns
Type Description
System.Object

An object that specifies the default value.
Overrides
Exceptions
Type Condition
System.ArgumentException

The key is invalid.

InitXDLSHolder()

Registers child objects in XDSL holder.

Declaration
protected override void InitXDLSHolder()
Overrides

OnChange(FormatBase, Int32)

Occurs on format change.

Declaration
protected override void OnChange(FormatBase format, int propertyKey)
Parameters
Type Name Description
FormatBase format

The FormatBase object.
System.Int32 propertyKey

The integer that represents the property key.
Overrides

Implements

Extension Methods