BorderCollection

BorderCollection

Overview

BorderCollection is a class in Aspose.Words FOSS for Java. Inherits from: Iterable<Border>.

A collection of Border objects.

Edition status of its 34 listed members (a property and its accessor methods are listed separately, overloads once): 34 not yet exercised by a verified example.

This class declares 22 methods for BorderCollection objects in Java programs. Available methods include: clearFormatting, equals, get, getBottom, getByBorderType, getColor, getCount, getDistanceFromText, getHorizontal, getLeft, getLineStyle, getLineWidth, and 10 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bottom, color, count, distanceFromText, horizontal, left, and 6 more.

Properties

NameTypeAccessDescription
leftBorderReadGets the left border.
rightBorderReadGets the right border.
topBorderReadGets the top border.
bottomBorderReadGets the bottom border.
horizontalBorderReadGets the horizontal border that is used between cells or conforming paragraphs.
verticalBorderReadGets the vertical border that is used between cells.
countintReadGets the number of borders in the collection.
lineWidthdoubleRead/WriteGets or sets the border width in points.
lineStyleintRead/WriteGets or sets the border style.
colorColorRead/WriteGets or sets the border color.
distanceFromTextdoubleRead/WriteGets or sets distance of the border from text in points.
shadowbooleanRead/WriteGets or sets a value indicating whether the border has a shadow.

Methods

SignatureDescription
equals(brColl: BorderCollection) → booleanCompares collections of borders.
getByBorderType(borderType: int) → BorderRetrieves a Border object by border type.
get(index: int) → BorderRetrieves a Border object by index.
getLeft() → BorderGets the left border.
getRight() → BorderGets the right border.
getTop() → BorderGets the top border.
getBottom() → BorderGets the bottom border.
getHorizontal() → BorderGets the horizontal border that is used between cells or conforming paragraphs.
getVertical() → BorderGets the vertical border that is used between cells.
getCount() → intGets the number of borders in the collection.
getLineWidth() → doubleGets or sets the border width in points.
setLineWidth(value: double)Sets the line width value.
getLineStyle() → intGets or sets the border style.
setLineStyle(value: int)Sets the line style value.
getColor() → ColorGets or sets the border color.
setColor(value: Color)Sets the color value.
getDistanceFromText() → doubleGets or sets distance of the border from text in points.
setDistanceFromText(value: double)Sets the distance from text value.
getShadow() → booleanGets or sets a value indicating whether the border has a shadow.
setShadow(value: boolean)Sets the shadow value.
clearFormatting()Removes all borders of an object.
iterator() → Iterator<Border>Returns an enumerator object that can be used to iterate over all borders in the collection.

See Also