BorderCollection Class

A collection of Border objects.

Inheritance Hierarchy

SystemObject
Aspose.WordsBorderCollection

Namespace: Aspose.Words
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 20.3

Syntax

C++

public sealed class BorderCollection : IEnumerable<Border>, 
	IEnumerable

Public NotInheritable Class BorderCollection
	Implements IEnumerable(Of Border), IEnumerable

public ref class BorderCollection sealed : IEnumerable<Border^>, 
	IEnumerable

[<SealedAttribute>]
type BorderCollection =  
    class
        interface IEnumerable<Border>
        interface IEnumerable
    end

The BorderCollection type exposes the following members.

Properties

	Name	Description
	Bottom	Gets the bottom border.
	Color	Gets or sets the border color.
	Count	Gets the number of borders in the collection.
	DistanceFromText	Gets or sets distance of the border from text in points.
	Horizontal	Gets the horizontal border that is used between cells or conforming paragraphs.
	ItemInt32	Retrieves a Border object by index.
	ItemBorderType	Retrieves a Border object by border type.
	Left	Gets the left border.
	LineStyle	Gets or sets the border style.
	LineWidth	Gets or sets the border width in points.
	Right	Gets the right border.
	Shadow	Gets or sets a value indicating whether the border has a shadow.
	Top	Gets the top border.
	Vertical	Gets the vertical border that is used between cells.

Methods

	Name	Description
	ClearFormatting	Removes all borders of an object.
	Equals(Object)	(Inherited from Object.)
	Equals(BorderCollection)	Compares collections of borders.
	GetEnumerator	Returns an enumerator object that can be used to iterate over all borders in the collection.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Remarks

Different document elements have different borders. For example, ParagraphFormat has Bottom, Left, Right and Top borders. You can specify different formatting for each border independently or enumerate through all borders and apply same formatting.

Examples

Shows how to insert a paragraph with a top border.

DocumentBuilder builder = new DocumentBuilder();

Border topBorder = builder.ParagraphFormat.Borders[BorderType.Top];
topBorder.Color = Color.Red;
topBorder.LineStyle = LineStyle.DashSmallGap;
topBorder.LineWidth = 4;

builder.Writeln("Hello World!");

Reference

Aspose.Words Namespace