BorderCollection (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.BorderCollection

All Implemented Interfaces:

java.lang.Iterable
```
public final class BorderCollection
extends java.lang.Object
implements java.lang.Iterable
```
A collection of Border objects.
To learn more, visit the Programming with Documents documentation article.
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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFormatting()` Removes all borders of an object.
`boolean`	`equals(BorderCollection brColl)` Compares collections of borders.
`Border`	`get(int index)` Retrieves a Border object by index.
`Border`	`getBottom()` Gets the bottom border.
`Border`	`getByBorderType(int borderType)`
`java.awt.Color`	`getColor()` Gets the border color.
`int`	`getCount()` Gets the number of borders in the collection.
`double`	`getDistanceFromText()` Gets distance of the border from text in points.
`Border`	`getHorizontal()` Gets the horizontal border that is used between cells or conforming paragraphs.
`Border`	`getLeft()` Gets the left border.
`int`	`getLineStyle()` Gets the border style.
`double`	`getLineWidth()` Gets the border width in points.
`Border`	`getRight()` Gets the right border.
`boolean`	`getShadow()` Gets a value indicating whether the border has a shadow.
`Border`	`getTop()` Gets the top border.
`Border`	`getVertical()` Gets the vertical border that is used between cells.
`java.util.Iterator`	`iterator()` Returns an enumerator object that can be used to iterate over all borders in the collection.
`void`	`setColor(java.awt.Color value)` Sets the border color.
`void`	`setDistanceFromText(double value)` Sets distance of the border from text in points.
`void`	`setLineStyle(int value)` Sets the border style.
`void`	`setLineWidth(double value)` Sets the border width in points.
`void`	`setShadow(boolean value)` Sets a value indicating whether the border has a shadow.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - equals
```
public final boolean equals(BorderCollection brColl)
                     throws java.lang.Exception
```
    Compares collections of borders.
    
    Throws:
    
    java.lang.Exception
  - getByBorderType
```
public final Border getByBorderType(int borderType)
                             throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - get
```
public final Border get(int index)
                 throws java.lang.Exception
```
    Retrieves a Border object by index.
    
    Parameters:
    
    index - Zero-based index of the border to retrieve.
    
    Returns:
    
    The corresponding Border value.
    
    Throws:
    
    java.lang.Exception
  - getLeft
```
public final Border getLeft()
                     throws java.lang.Exception
```
    Gets the left border.
    
    Returns:
    
    The left border.
    
    Throws:
    
    java.lang.Exception
  - getRight
```
public final Border getRight()
                      throws java.lang.Exception
```
    Gets the right border.
    
    Returns:
    
    The right border.
    
    Throws:
    
    java.lang.Exception
  - getTop
```
public final Border getTop()
                    throws java.lang.Exception
```
    Gets the top border.
    
    Returns:
    
    The top border.
    
    Throws:
    
    java.lang.Exception
  - getBottom
```
public final Border getBottom()
                       throws java.lang.Exception
```
    Gets the bottom border.
    
    Returns:
    
    The bottom border.
    
    Throws:
    
    java.lang.Exception
  - getHorizontal
```
public final Border getHorizontal()
                           throws java.lang.Exception
```
    Gets the horizontal border that is used between cells or conforming paragraphs.
    
    Returns:
    
    The horizontal border that is used between cells or conforming paragraphs.
    
    Throws:
    
    java.lang.Exception
  - getVertical
```
public final Border getVertical()
                         throws java.lang.Exception
```
    Gets the vertical border that is used between cells.
    
    Returns:
    
    The vertical border that is used between cells.
    
    Throws:
    
    java.lang.Exception
  - getCount
```
public final int getCount()
```
    Gets the number of borders in the collection.
    
    Returns:
    
    The number of borders in the collection.
  - getLineWidth
```
public final double getLineWidth()
                          throws java.lang.Exception
```
    Gets the border width in points.
    Returns the width of the first border in the collection.
    
    Sets the width of all borders in the collection excluding diagonal borders.
    
    Returns:
    
    The border width in points.
    
    Throws:
    
    java.lang.Exception
  - setLineWidth
```
public final void setLineWidth(double value)
                        throws java.lang.Exception
```
    Sets the border width in points.
    Returns the width of the first border in the collection.
    
    Sets the width of all borders in the collection excluding diagonal borders.
    
    Parameters:
    
    value - The border width in points.
    
    Throws:
    
    java.lang.Exception
  - getLineStyle
```
public final int getLineStyle()
                       throws java.lang.Exception
```
    Gets the border style.
    Returns the style of the first border in the collection.
    
    Sets the style of all borders in the collection excluding diagonal borders.
    
    Returns:
    
    The border style. The returned value is one of LineStyle constants.
    
    Throws:
    
    java.lang.Exception
  - setLineStyle
```
public final void setLineStyle(int value)
                        throws java.lang.Exception
```
    Sets the border style.
    Returns the style of the first border in the collection.
    
    Sets the style of all borders in the collection excluding diagonal borders.
    
    Parameters:
    
    value - The border style. The value must be one of LineStyle constants.
    
    Throws:
    
    java.lang.Exception
  - getColor
```
public final java.awt.Color getColor()
                              throws java.lang.Exception
```
    Gets the border color.
    Returns the color of the first border in the collection.
    
    Sets the color of all borders in the collection excluding diagonal borders.
    
    Returns:
    
    The border color.
    
    Throws:
    
    java.lang.Exception
  - setColor
```
public final void setColor(java.awt.Color value)
                    throws java.lang.Exception
```
    Sets the border color.
    Returns the color of the first border in the collection.
    
    Sets the color of all borders in the collection excluding diagonal borders.
    
    Parameters:
    
    value - The border color.
    
    Throws:
    
    java.lang.Exception
  - getDistanceFromText
```
public final double getDistanceFromText()
                                 throws java.lang.Exception
```
    Gets distance of the border from text in points.
    Gets the distance from text for the first border.
    
    Sets the distance from text for all borders in the collection excluding diagonal borders.
    
    Has no effect and will be automatically reset to zero for borders of table cells.
    
    Returns:
    
    Distance of the border from text in points.
    
    Throws:
    
    java.lang.Exception
  - setDistanceFromText
```
public final void setDistanceFromText(double value)
                               throws java.lang.Exception
```
    Sets distance of the border from text in points.
    Gets the distance from text for the first border.
    
    Sets the distance from text for all borders in the collection excluding diagonal borders.
    
    Has no effect and will be automatically reset to zero for borders of table cells.
    
    Parameters:
    
    value - Distance of the border from text in points.
    
    Throws:
    
    java.lang.Exception
  - getShadow
```
public final boolean getShadow()
                        throws java.lang.Exception
```
    Gets a value indicating whether the border has a shadow.
    Gets the value from the first border in the collection.
    
    Sets the value for all borders in the collection excluding diagonal borders.
    
    Returns:
    
    A value indicating whether the border has a shadow.
    
    Throws:
    
    java.lang.Exception
  - setShadow
```
public final void setShadow(boolean value)
                     throws java.lang.Exception
```
    Sets a value indicating whether the border has a shadow.
    Gets the value from the first border in the collection.
    
    Sets the value for all borders in the collection excluding diagonal borders.
    
    Parameters:
    
    value - A value indicating whether the border has a shadow.
    
    Throws:
    
    java.lang.Exception
  - clearFormatting
```
public final void clearFormatting()
```
    Removes all borders of an object.
  - iterator
```
public final java.util.Iterator iterator()
```
    Returns an enumerator object that can be used to iterate over all borders in the collection.
    
    Specified by:
    
    iterator in interface java.lang.Iterable

Class BorderCollection

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

equals

getByBorderType

get

getLeft

getRight

getTop

getBottom

getHorizontal

getVertical

getCount

getLineWidth

setLineWidth

getLineStyle

setLineStyle

getColor

setColor

getDistanceFromText

setDistanceFromText

getShadow

setShadow

clearFormatting

iterator