pageborderattribute.html

永中OFFICE二次开发帮助文档

 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.TOP, 1);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.LEFT, 3);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT, 6);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM, 8);

 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.TOP, Color.RED);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT, Color.CYAN);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT, Color.YELLOW);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM, Color.ORANGE);

 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP, 8f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT, 5f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT, 3f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM, 1f);
 doc.setPageBorderAttribute(pageBorderAttr);
 
 System.out.println(doc.getPageBorderAttribute().getBorderType());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getBottomDistance()"><!-- --></A><H3>
getBottomDistance</H3>
<PRE>
public int <B>getBottomDistance</B>()</PRE>
<DL>
<DD>获取页面边框与页面下边距或纸张下边缘之间的距离（以磅值为默认单位）。
<P>
<DD><DL>

<DT><B>返回：</B><DD>页面边框与页面下边距或纸张下边缘之间的距离
 说明：get方法默认返回为磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），可以用
 application.util.Utilities.pointToOther(double, int)方法将返回的磅值转换为其他度量单位。
 <p>
 <b>例子:</b>
 <pre>
 //请输入一些文字          
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 PageBorderAttribute pageBorderAttr = doc.getPageBorderAttribute();
 pageBorderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.TOP, 1);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.LEFT, 3);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT, 6);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM, 8);

 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.TOP, Color.RED);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT, Color.CYAN);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT, Color.YELLOW);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM, Color.ORANGE);

 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP, 8f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT, 5f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT, 3f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM, 1f);
 
 pageBorderAttr.setBottomDistance(1);
 
 doc.setPageBorderAttribute(pageBorderAttr);
 
 int optionBottom = doc.getPageBorderAttribute().getBottomDistance();
 System.out.println("边框与页面之间下边距的距离是：" + optionBottom);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getDistanceFrom()"><!-- --></A><H3>
getDistanceFrom</H3>
<PRE>
public int <B>getDistanceFrom</B>()</PRE>
<DL>
<DD>获取边框的度量依据（即设置的距离是页面与边框之间的距离，还是正文与边框之间的距离）。
<P>
<DD><DL>

<DT><B>返回：</B><DD>度量依据，只能取以下两个整形值之一：
 <pre>
 0 - 表示设置的距离是页边距与边框之间的距离
 1 - 表示示设置的距离是纸张边缘与边框之间的距离
 </pre>
 <p>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 PageBorderAttribute pageBorderAttr = doc.getPageBorderAttribute();
 pageBorderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.TOP, 1);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.LEFT, 3);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT, 6);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM, 8);

 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.TOP, Color.RED);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT, Color.CYAN);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT, Color.YELLOW);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM, Color.ORANGE);

 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP, 8f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT, 5f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT, 3f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM, 1f);
 
 pageBorderAttr.setDistanceFrom(0);
 
 doc.setPageBorderAttribute(pageBorderAttr);
 System.out.println(doc.getPageBorderAttribute().getDistanceFrom());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getLeftDistance()"><!-- --></A><H3>
getLeftDistance</H3>
<PRE>
public int <B>getLeftDistance</B>()</PRE>
<DL>
<DD>获取页面边框与页面左边距或纸张左边缘之间的距离（以磅值为默认单位）。
<P>
<DD><DL>

<DT><B>返回：</B><DD>页面边框与页面左边距或纸张左边缘之间的距离
 说明：get方法默认返回为磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），可以用
 application.util.Utilities.pointToOther(double, int)方法将返回的磅值转换为其他度量单位。
 <p>
 <b>例子:</b>
 <pre>
 //请输入一些文字          
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 PageBorderAttribute pageBorderAttr = doc.getPageBorderAttribute();
 pageBorderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.TOP, 1);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.LEFT, 3);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT, 6);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM, 8);

 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.TOP, Color.RED);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT, Color.CYAN);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT, Color.YELLOW);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM, Color.ORANGE);

 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP, 8f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT, 5f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT, 3f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM, 1f);
  
 pageBorderAttr.setLeftDistance(1);
  
 doc.setPageBorderAttribute(pageBorderAttr);
  
 int optionLeft = pageBorderAttr.getLeftDistance();
 System.out.println("边框与页面之间左边距的距离是：" + optionLeft);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getRightDistance()"><!-- --></A><H3>
getRightDistance</H3>
<PRE>
public int <B>getRightDistance</B>()</PRE>
<DL>
<DD>获取页面边框与页面右边距或纸张右边缘之间的距离（以磅值为默认单位）。
<P>
<DD><DL>

<DT><B>返回：</B><DD>页面边框与页面右边距或纸张右边缘之间的距离
 说明：get方法默认返回为磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），可以用
 application.util.Utilities.pointToOther(double, int)方法将返回的磅值转换为其他度量单位。
 <p>
 <b>例子:</b>
 <pre>
 //请输入一些文字         
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 PageBorderAttribute pageBorderAttr = doc.getPageBorderAttribute();
 pageBorderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.TOP, 1);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.LEFT, 3);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT, 6);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM, 8);

 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.TOP, Color.RED);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT, Color.CYAN);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT, Color.YELLOW);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM, Color.ORANGE);

 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP, 8f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT, 5f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT, 3f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM, 1f);
 
 pageBorderAttr.setRightDistance(1);
 
 doc.setPageBorderAttribute(pageBorderAttr);

 int optionRight = doc.getPageBorderAttribute().getRightDistance();
 System.out.println("边框与页面之间右边距的距离是：" + optionRight);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getTopDistance()"><!-- --></A><H3>
getTopDistance</H3>
<PRE>
public int <B>getTopDistance</B>()</PRE>
<DL>
<DD>获取页面边框与页面上边距或纸张上边缘之间的距离（以磅值为默认单位）。
<P>
<DD><DL>

<DT><B>返回：</B><DD>页面边框与页面上边距或纸张上边缘之间的距离
 说明：get方法默认返回为磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），可以用
 application.util.Utilities.pointToOther(double, int)方法将返回的磅值转换为其他度量单位。
 <p>
 <b>例子:</b>
 <pre>
 //请输入一些文字
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 PageBorderAttribute pageBorderAttr = doc.getPageBorderAttribute();
 pageBorderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.TOP, 1);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.LEFT, 3);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT, 6);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM, 8);

 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.TOP, Color.RED);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT, Color.CYAN);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT, Color.YELLOW);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM, Color.ORANGE);

 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP, 8f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT, 5f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT, 3f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM, 1f);
 
 pageBorderAttr.setTopDistance(1);
 
 doc.setPageBorderAttribute(pageBorderAttr);
 int optionTop = pageBorderAttr.getTopDistance();
 System.out.println("边框与页面之间上边距的距离是：" + optionTop);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="isAlignWithPage()"><!-- --></A><H3>
isAlignWithPage</H3>
<PRE>
public boolean <B>isAlignWithPage</B>()</PRE>
<DL>
<DD>判断是否将段落边框与表格边界与页面边框对齐。 <br>
 (注：必须设置当前的度量依据为正文，才能设置段落边框与表格边界与页面边框对齐。)
<P>
<DD><DL>

<DT><B>返回：</B><DD>布尔型值，如果段落边框与表格边界与页面边框对齐，返回true；否则，返回false
 <p>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 PageBorderAttribute pageBorderAttr = doc.getPageBorderAttribute();
 pageBorderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.TOP, 1);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.LEFT, 3);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT, 6);
 pageBorderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM, 8);

 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.TOP, Color.RED);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT, Color.CYAN);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT, Color.YELLOW);
 pageBorderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM, Color.ORANGE);

 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP, 8f);
 pageBorderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT, 5f);