pageborderattribute.html

永中OFFICE二次开发帮助文档

<DT><B>参数：</B><DD><CODE>borderPosition</CODE> - 边缘边框类型，其常量和相应的值如下：
 <pre>
 BorderAndShadingConstants.LEFT = 0       左边缘边框
 BorderAndShadingConstants.TOP = 1        上边缘边框
 BorderAndShadingConstants.RIGHT = 2      右边缘边框
 BorderAndShadingConstants.BOTTOM = 3     下边缘边框
 </pre><DD><CODE>width</CODE> - 边框线条的宽度
 说明：set方法的参数默认取磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），
 可以用 application.util.Utilities.otherToPoint(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);
 doc.setPageBorderAttribute(pageBorderAttr);
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当参数borderPosition超出范围<DT><B>另请参见：</B><DD><A HREF="../../../../../application/workbooks/workbook/style/border/PageBorderAttribute.html#getBorderLineWidth(int)"><CODE>getBorderLineWidth(int borderPosition)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setBorderType(int)"><!-- --></A><H3>
setBorderType</H3>
<PRE>
public void <B>setBorderType</B>(int&nbsp;borderType)</PRE>
<DL>
<DD>设置边框类型。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>borderType</CODE> - 边框的类型，其常量和相应的值如下：
 <pre>
 BorderAndShadingConstants.BORDERTYPE_NONE = 0    表示无边框
 BorderAndShadingConstants.BORDERTYPE_BOX = 1     表示方框格式
 BorderAndShadingConstants.BORDERTYPE_SHADOW = 2  表示在所选内容四周加上边框，并应用预设的阴影格式
 BorderAndShadingConstants.BORDERTYPE_THREED = 3  表示在所选内容四周加上边框，并应用预设的三维边框格式
 BorderAndShadingConstants.BORDERTYPE_CUSTOM = 4  表示自定义格式
 </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);
 doc.setPageBorderAttribute(pageBorderAttr);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setBottomDistance(int)"><!-- --></A><H3>
setBottomDistance</H3>
<PRE>
public void <B>setBottomDistance</B>(int&nbsp;bottom)</PRE>
<DL>
<DD>设置页面边框与页面下边距或纸张下边缘之间的距离（以磅值为默认单位）。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>bottom</CODE> - 页面边框与页面下边距或纸张下边缘之间的距离
 说明：set方法的参数默认取磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），
 可以用 application.util.Utilities.otherToPoint(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);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setDistanceFrom(int)"><!-- --></A><H3>
setDistanceFrom</H3>
<PRE>
public void <B>setDistanceFrom</B>(int&nbsp;ind)</PRE>
<DL>
<DD>设置边框的度量依据（即设置的距离是页边距与边框之间的距离，还是纸张边缘与边框之间的距离）。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>ind</CODE> - 度量依据，只能取以下两个整形值之一：
 <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);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setLeftDistance(int)"><!-- --></A><H3>
setLeftDistance</H3>
<PRE>
public void <B>setLeftDistance</B>(int&nbsp;left)</PRE>
<DL>
<DD>设置页面边框与页面左边距或纸张左边缘之间的距离（以磅值为默认单位）。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>left</CODE> - 页面边框与页面左边距或纸张左边缘之间的距离
 说明：set方法的参数默认取磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），
 可以用 application.util.Utilities.otherToPoint(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);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setRightDistance(int)"><!-- --></A><H3>
setRightDistance</H3>
<PRE>
public void <B>setRightDistance</B>(int&nbsp;right)</PRE>
<DL>
<DD>设置页面边框与页面右边距或纸张右边缘之间的距离（以磅值为默认单位）。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>right</CODE> - 页面边框与页面右边距或纸张右边缘之间的距离
 说明：set方法的参数默认取磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），
 可以用 application.util.Utilities.otherToPoint(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);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setShowInFront(boolean)"><!-- --></A><H3>
setShowInFront</H3>
<PRE>
public void <B>setShowInFront</B>(boolean&nbsp;flag)</PRE>
<DL>
<DD>页面边框总在最前面显示。（即设置“总在前面显示”）
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>flag</CODE> - 布尔型，如为true，页面边框将总在最前方显示；否则，页面边框不在最前方法显示
 <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.setBorderLineCo