com.aspose.words
Class Border

java.lang.Object
    com.aspose.words.Border

All Implemented Interfaces:

java.lang.Cloneable

public class Border 
extends java.lang.Object

DocumentBuilder builder = new DocumentBuilder();

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.write("run of text in a green border");

public int getLineStyle() / public void setLineStyle(int value)

Gets or sets the border style. The value of the property is LineStyle integer constant.

If you set line style to none, then line width is automatically changed to zero.

Example:

Inserts a string surrounded by a border into a document.

DocumentBuilder builder = new DocumentBuilder();

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.write("run of text in a green border");

public double getLineWidth() / public void setLineWidth(double value)

Gets or sets the border width in points.

If you set line width greater than zero when line style is none, the line style is automatically changed to single line.

Example:

Inserts a string surrounded by a border into a document.

DocumentBuilder builder = new DocumentBuilder();

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.write("run of text in a green border");

public boolean isVisible()

Returns true if the LineStyle is not LineStyle.None.

public java.awt.Color getColor() / public void setColor(java.awt.Color value)

Gets or sets the border color.

Example:

Inserts a string surrounded by a border into a document.

DocumentBuilder builder = new DocumentBuilder();

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.write("run of text in a green border");

public double getDistanceFromText() / public void setDistanceFromText(double value)

Gets or sets distance of the border from text or from the page edge in points.

Has no effect and will be automatically reset to zero for borders of table cells.

Example:

Creates a page border that looks like a wide blue band at the top of the first page only.

Document doc = new Document();

PageSetup ps = doc.getSections().get(0).getPageSetup();
ps.setBorderAlwaysInFront(false);
ps.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
ps.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);

Border border = ps.getBorders().get(BorderType.TOP);
border.setLineStyle(LineStyle.SINGLE);
border.setLineWidth(30);
border.setColor(Color.BLUE);
border.setDistanceFromText(0);

doc.save(getMyDir() + "PageSetup.PageBorderTop Out.doc");

See Also:

PageSetup.BorderDistanceFrom

public boolean getShadow() / public void setShadow(boolean value)

Gets or sets a value indicating whether the border has a shadow.

In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.

public void clearFormatting()

Resets border properties to default values.

When border properties are reset to default values, the border is invisible.

public boolean equals(Aspose.Words.IEquatableAttr rhs)
              throws java.lang.Exception

Reserved for internal use.

public boolean isInherited()

Reserved for internal use.

public com.aspose.words.IComplexAttr deepCloneComplexAttr()
                                 throws java.lang.Exception

Reserved for internal use.