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
| Name | Type | Access | Description |
|---|---|---|---|
left | Border | Read | Gets the left border. |
right | Border | Read | Gets the right border. |
top | Border | Read | Gets the top border. |
bottom | Border | Read | Gets the bottom border. |
horizontal | Border | Read | Gets the horizontal border that is used between cells or conforming paragraphs. |
vertical | Border | Read | Gets the vertical border that is used between cells. |
count | int | Read | Gets the number of borders in the collection. |
lineWidth | double | Read/Write | Gets or sets the border width in points. |
lineStyle | int | Read/Write | Gets or sets the border style. |
color | Color | Read/Write | Gets or sets the border color. |
distanceFromText | double | Read/Write | Gets or sets distance of the border from text in points. |
shadow | boolean | Read/Write | Gets or sets a value indicating whether the border has a shadow. |
Methods
| Signature | Description |
|---|---|
equals(brColl: BorderCollection) → boolean | Compares collections of borders. |
getByBorderType(borderType: int) → Border | Retrieves a Border object by border type. |
get(index: int) → Border | Retrieves a Border object by index. |
getLeft() → Border | Gets the left border. |
getRight() → Border | Gets the right border. |
getTop() → Border | Gets the top border. |
getBottom() → Border | Gets the bottom border. |
getHorizontal() → Border | Gets the horizontal border that is used between cells or conforming paragraphs. |
getVertical() → Border | Gets the vertical border that is used between cells. |
getCount() → int | Gets the number of borders in the collection. |
getLineWidth() → double | Gets or sets the border width in points. |
setLineWidth(value: double) | Sets the line width value. |
getLineStyle() → int | Gets or sets the border style. |
setLineStyle(value: int) | Sets the line style value. |
getColor() → Color | Gets or sets the border color. |
setColor(value: Color) | Sets the color value. |
getDistanceFromText() → double | Gets or sets distance of the border from text in points. |
setDistanceFromText(value: double) | Sets the distance from text value. |
getShadow() → boolean | Gets 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. |