java.lang.Objectcom.aspose.words.Border
public class Border
Borders can be applied to various document elements including paragraph,
run of text inside a paragraph or a table cell. Example:
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");
Property Getters/Setters Summary | ||
---|---|---|
java.awt.Color | getColor() | |
void | setColor(java.awt.Color value) | |
Gets or sets the border color. | ||
double | getDistanceFromText() | |
void | setDistanceFromText(double value) | |
Gets or sets distance of the border from text or from the page edge in points. | ||
boolean | isVisible() | |
Returns true if the LineStyle is not LineStyle.None. | ||
int | getLineStyle() | |
void | setLineStyle(int value) | |
Gets or sets the border style. The value of the property is LineStyle integer constant. | ||
double | getLineWidth() | |
void | setLineWidth(double value) | |
Gets or sets the border width in points. | ||
boolean | getShadow() | |
void | setShadow(boolean value) | |
Gets or sets a value indicating whether the border has a shadow. |
Method Summary | ||
---|---|---|
void | clearFormatting() | |
Resets border properties to default values. | ||
com.aspose.words.IComplexAttr | deepCloneComplexAttr() | |
Reserved for internal use. | ||
boolean | equals(Aspose.Words.IEquatableAttr rhs) | |
Reserved for internal use. | ||
boolean | isInherited() | |
Reserved for internal use. |
Property Getters/Setters Detail |
---|
getLineStyle/setLineStyle | |
public int getLineStyle() / public void setLineStyle(int value) |
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");
getLineWidth/setLineWidth | |
public double getLineWidth() / public void setLineWidth(double value) |
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");
isVisible | |
public boolean isVisible() |
getColor/setColor | |
public java.awt.Color getColor() / public void setColor(java.awt.Color value) |
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");
getDistanceFromText/setDistanceFromText | |
public double getDistanceFromText() / public void setDistanceFromText(double value) |
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");
getShadow/setShadow | |
public boolean getShadow() / public void setShadow(boolean value) |
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.
Method Detail |
---|
clearFormatting | |
public void clearFormatting() |
equals | |
public boolean equals(Aspose.Words.IEquatableAttr rhs) throws java.lang.Exception |
isInherited | |
public boolean isInherited() |
deepCloneComplexAttr | |
public com.aspose.words.IComplexAttr deepCloneComplexAttr() throws java.lang.Exception |