Class Border

Represents the border formatting options for Word document contents.

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

Constructors

Border(FormatBase, Int32)

Initializes a new instance of the Border class with the specified FormatBase and key.

Declaration
public Border(FormatBase parent, int baseKey)
Parameters
Type Name Description
FormatBase parent

The FormatBase object that represents the base formatting options.
System.Int32 baseKey

The integer that specifies the base key.

Fields

ColorKey

Variable used to hold the ColorKey.

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

HasNoneStyleKey

Variable used to hold the HasNoneStyleKey.

Declaration
protected const int HasNoneStyleKey = 6
Field Value
Type
System.Int32

ShadowKey

Variable used to hold the ShadowKey.

Declaration
protected const int ShadowKey = 5
Field Value
Type
System.Int32

SpaceKey

Variable used to hold the SpaceKey.

Declaration
protected const int SpaceKey = 4
Field Value
Type
System.Int32

Properties

BorderType

Gets or sets style of the border.

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

The BorderStyle member that specifies the style for border.

Color

Gets or sets the color for border.

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

The System.Drawing.Color for border.

LineWidth

Gets or sets the width of the border measured in points.

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

The float that represents the width of the border.

Shadow

Gets or sets a value indicating whether the border should be drawn with shadow.

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

True if shadow should be drawn; otherwise, false.

Space

Gets or sets the width(in points) of space to maintain between border and text within border.

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

The float that specifies the width of the space measured in points.

Methods

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

InitFormatting(Color, Single, BorderStyle, Boolean)

Initializes the Border style.

Declaration
public void InitFormatting(Color color, float lineWidth, BorderStyle borderType, bool shadow)
Parameters
Type Name Description
Color color

The System.Drawing.Color for the border.
System.Single lineWidth

The float that specifies width of the line.
BorderStyle borderType

The BorderStyle member that specifies the style for border.
System.Boolean shadow

True if shadow should be drawn, otherwise false.

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

ReadXmlAttributes(IXDLSAttributeReader)

Reads object data from xml attributes.

Declaration
protected override void ReadXmlAttributes(IXDLSAttributeReader reader)
Parameters
Type Name Description
IXDLSAttributeReader reader

The IXDLSAttributeReader object.
Overrides

WriteXmlAttributes(IXDLSAttributeWriter)

Writes object data as xml attributes.

Declaration
protected override void WriteXmlAttributes(IXDLSAttributeWriter writer)
Parameters
Type Name Description
IXDLSAttributeWriter writer

The IXDLSAttributeWriter object.
Overrides

Implements