com.aspose.words

Class PageBorderAppliesTo

java.lang.Object

com.aspose.words.PageBorderAppliesTo

public class PageBorderAppliesTo
extends java.lang.Object

Specifies which pages the page border is printed on.

Examples:

Shows how to create a wide blue band border at the top of the first page.

 
 Document doc = new Document();

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

 Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
 border.setLineStyle(LineStyle.SINGLE);
 border.setLineWidth(30.0);
 border.setColor(Color.BLUE);
 border.setDistanceFromText(0.0);

 doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
 
 

See Also:

PageSetup, PageSetup.getBorderAppliesTo(), PageSetup.setBorderAppliesTo(int)

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_PAGES Page border is shown on all pages of the section.
static int	FIRST_PAGE Page border is shown on the first page of the section only.
static int	length
static int	OTHER_PAGES Page border is shown on all pages except the first page of the section.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String pageBorderAppliesToName)
static java.lang.String	getName(int pageBorderAppliesTo)
static int[]	getValues()
static java.lang.String	toString(int pageBorderAppliesTo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_PAGES

public static int ALL_PAGES

Page border is shown on all pages of the section.

FIRST_PAGE

public static int FIRST_PAGE

Page border is shown on the first page of the section only.

OTHER_PAGES

public static int OTHER_PAGES

Page border is shown on all pages except the first page of the section.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int pageBorderAppliesTo)

toString

public static java.lang.String toString(int pageBorderAppliesTo)

fromName

public static int fromName(java.lang.String pageBorderAppliesToName)

getValues

public static int[] getValues()