borderattribute.html

永中OFFICE二次开发帮助文档

 BorderAndShadingConstants.TOP = 1        上边缘边框
 BorderAndShadingConstants.RIGHT = 2      右边缘边框
 BorderAndShadingConstants.BOTTOM = 3     下边缘边框
 BorderAndShadingConstants.MIDDLE_HORIZON = 4     中间水平线边框
 BorderAndShadingConstants.MIDDLE_VERTICAL = 5    中间垂直线边框
 BorderAndShadingConstants.DIAGONAL_FORWARD = 6   左上对角线边框
 BorderAndShadingConstants.DIAGONAL_BACKWARD = 7  右上对角线边框
<DT><B>返回：</B><DD>边框线颜色，如果返回值为null表示指定的边框线颜色为三态或者不确定的值
 </pre>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 BorderAttribute borderAttr = doc.getBorderAttribute();
 borderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_BOX);
 borderAttr.setBorderLineType(BorderAndShadingConstants.TOP,1);
 borderAttr.setBorderLineType(BorderAndShadingConstants.LEFT,3);
 borderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT,6);
 borderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM,8);
      
 borderAttr.setBorderLineColor(BorderAndShadingConstants.TOP,Color.RED);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT,Color.CYAN);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT,Color.YELLOW);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM,Color.ORANGE);

 borderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP,8f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT,5f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT,3f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM,1f);

 doc.setBorderAttribute(borderAttr);
 System.out.println(doc.getBorderAttribute().getBorderLineColor(BorderAndShadingConstants.TOP));
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当指定边缘边框类型常量不存在<DT><B>另请参见：</B><DD><A HREF="../../../../../application/constants/BorderAndShadingConstants.html" title="application.constants 中的接口"><CODE>BorderAndShadingConstants</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getBorderLineType(int)"><!-- --></A><H3>
getBorderLineType</H3>
<PRE>
public int <B>getBorderLineType</B>(int&nbsp;borderPosition)</PRE>
<DL>
<DD>得到边框线类型。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>borderPosition</CODE> - 边缘边框类型，其常量和相应的值如下：
 <pre>
 BorderAndShadingConstants.LEFT = 0       左边缘边框
 BorderAndShadingConstants.TOP = 1        上边缘边框
 BorderAndShadingConstants.RIGHT = 2      右边缘边框
 BorderAndShadingConstants.BOTTOM = 3     下边缘边框
 BorderAndShadingConstants.MIDDLE_HORIZON = 4     中间水平线边框
 BorderAndShadingConstants.MIDDLE_VERTICAL = 5    中间垂直线边框
 BorderAndShadingConstants.DIAGONAL_FORWARD = 6   左上对角线边框
 BorderAndShadingConstants.DIAGONAL_BACKWARD = 7  右上对角线边框
<DT><B>返回：</B><DD>返回边框线类型在对话框的索引，如果返回值为9999999表示指定边框线类型为三态或者不确定的值
 </pre>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 BorderAttribute borderAttr = doc.getBorderAttribute();
 borderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_BOX);
 borderAttr.setBorderLineType(BorderAndShadingConstants.TOP,1);
 borderAttr.setBorderLineType(BorderAndShadingConstants.LEFT,3);
 borderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT,6);
 borderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM,8);
      
 borderAttr.setBorderLineColor(BorderAndShadingConstants.TOP,Color.RED);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT,Color.CYAN);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT,Color.YELLOW);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM,Color.ORANGE);

 borderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP,8f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT,5f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT,3f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM,1f);

 doc.setBorderAttribute(borderAttr);
 System.out.println(doc.getBorderAttribute().getBorderLineType(BorderAndShadingConstants.TOP));
 </pre><DT><B>另请参见：</B><DD><A HREF="../../../../../application/workbooks/workbook/style/border/BorderAttribute.html#setBorderLineType(int, int)"><CODE>setBorderLineType(int borderPosition, int lineType)</CODE></A>, 
<A HREF="../../../../../application/constants/BorderAndShadingConstants.html" title="application.constants 中的接口"><CODE>BorderAndShadingConstants</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getBorderLineWidth(int)"><!-- --></A><H3>
getBorderLineWidth</H3>
<PRE>
public float <B>getBorderLineWidth</B>(int&nbsp;borderPosition)</PRE>
<DL>
<DD>得到边框线宽度（以磅为默认单位）。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>borderPosition</CODE> - 边缘边框类型，其常量和相应的值如下：
 <pre>
 BorderAndShadingConstants.LEFT = 0       左边缘边框
 BorderAndShadingConstants.TOP = 1        上边缘边框
 BorderAndShadingConstants.RIGHT = 2      右边缘边框
 BorderAndShadingConstants.BOTTOM = 3     下边缘边框
 BorderAndShadingConstants.MIDDLE_HORIZON = 4     中间水平线边框
 BorderAndShadingConstants.MIDDLE_VERTICAL = 5    中间垂直线边框
 BorderAndShadingConstants.DIAGONAL_FORWARD = 6   左上对角线边框
 BorderAndShadingConstants.DIAGONAL_BACKWARD = 7  右上对角线边框
 </pre>
<DT><B>返回：</B><DD>边框线条宽度，如果返回值为9999999表示指定边框线类型为三态或者不确定的值
 说明：get方法默认返回为磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），可以用
 application.util.Utilities.pointToOther(double, int)方法将返回的磅值转换为其他度量单位。
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 BorderAttribute borderAttr = doc.getBorderAttribute();
 borderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_BOX);
 borderAttr.setBorderLineType(BorderAndShadingConstants.TOP,1);
 borderAttr.setBorderLineType(BorderAndShadingConstants.LEFT,3);
 borderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT,6);
 borderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM,8);
      
 borderAttr.setBorderLineColor(BorderAndShadingConstants.TOP,Color.RED);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT,Color.CYAN);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT,Color.YELLOW);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM,Color.ORANGE);

 borderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP,8f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT,5f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT,3f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM,1f);

 doc.setBorderAttribute(borderAttr);
 System.out.println(doc.getBorderAttribute().getBorderLineWidth(BorderAndShadingConstants.TOP));
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当指定边缘边框类型常量不存在<DT><B>另请参见：</B><DD><A HREF="../../../../../application/workbooks/workbook/style/border/BorderAttribute.html#setBorderLineWidth(int, float)"><CODE>setBorderLineWidth(int borderPosition, float width)</CODE></A>, 
<A HREF="../../../../../application/constants/BorderAndShadingConstants.html" title="application.constants 中的接口"><CODE>BorderAndShadingConstants</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getBorderType()"><!-- --></A><H3>
getBorderType</H3>
<PRE>
public int <B>getBorderType</B>()</PRE>
<DL>
<DD>得到边框类型。
<P>
<DD><DL>

<DT><B>返回：</B><DD>边框的类型，其常量和相应的值如下：
 <pre>
 BorderAndShadingConstants.BORDERTYPE_NONE = 0    表示无边框
 BorderAndShadingConstants.BORDERTYPE_BOX = 1     表示方框格式
 BorderAndShadingConstants.BORDERTYPE_SHADOW = 2  表示阴影边框格式。注意：此类型在电子表格中无效）
 BorderAndShadingConstants.BORDERTYPE_ALL = 2     表示全部边框格式。注意：此类型只在电子表格中有效）
 BorderAndShadingConstants.BORDERTYPE_THREED = 3  表示三维边框格式。注意：此类型在电子表格中无效）
 BorderAndShadingConstants.BORDERTYPE_GRID = 3    表示网格边框格式。注意：此类型只在电子表格中有效）　　　
 BorderAndShadingConstants.BORDERTYPE_CUSTOM = 4  表示自定义格式
 </pre>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 BorderAttribute borderAttr = doc.getBorderAttribute();
 borderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_BOX);
 borderAttr.setBorderLineType(BorderAndShadingConstants.TOP,1);
 borderAttr.setBorderLineType(BorderAndShadingConstants.LEFT,3);
 borderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT,6);
 borderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM,8);
      
 borderAttr.setBorderLineColor(BorderAndShadingConstants.TOP,Color.RED);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT,Color.CYAN);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT,Color.YELLOW);
 borderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM,Color.ORANGE);

 borderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP,8f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT,5f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT,3f);
 borderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM,1f);

 doc.setBorderAttribute(borderAttr);     
 System.out.println(doc.getBorderAttribute().getBorderType());
 </pre><DT><B>另请参见：</B><DD><A HREF="../../../../../application/workbooks/workbook/style/border/BorderAttribute.html#setBorderType(int)"><CODE>setBorderType(int borderType)</CODE></A>, 
<A HREF="../../../../../application/constants/BorderAndShadingConstants.html" title="application.constants 中的接口"><CODE>BorderAndShadingConstants</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTemplateBorder()"><!-- --></A><H3>
getTemplateBorder</H3>
<PRE>
public int <B>getTemplateBorder</B>()</PRE>
<DL>
<DD>获得边框模板类型。
<P>
<DD><DL>

<DT><B>返回：</B><DD>边缘边框类型，其常量和相应的值如下：
 <pre>
 BorderAndShadingConstants.BorderAndShadingConstants.LEFT = 0   左边缘边框
 BorderAndShadingConstants.BorderAndShadingConstants.TOP = 1    上边缘边框
 BorderAndShadingConstants.BorderAndShadingConstants.RIGHT = 2  右边缘边框
 BorderAndShadingConstants.BorderAndShadingConstants.BOTTOM = 3 下边缘边框
 </pre>
 <p>
 <b>例子:</b>
 </pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
      .getActiveDocument();
 BorderAttribute borderAttribute = new BorderAttribute();
 borderAttribute.setBorderType(BorderAndShadingConstants.BORDERTYPE_BOX);
 borderAttribute.setBorderLineType(BorderAndShadingConstants.LEFT,2);
 borderAttribute.setBorderLineWidth(BorderAndShadingConstants.LEFT,0.5f);
 borderAttribute.setBorderLineColor(BorderAndShadingConstants.LEFT,Color.RED);
 borderAttribute.setTemplateBorder(BorderAndShadingConstants.LEFT);
 doc.setBorderAttribute(borderAttribute);
 System.out.println(""+borderAttribute.getTemplateBorder());
 </pre><DT><B>另请参见：</B><DD><A HREF="../../../../../application/constants/BorderAndShadingConstants.html" title="application.constants 中的接口"><CODE>BorderAndShadingConstants</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setApplyType(int)"><!-- --></A><H3>
setApplyType</H3>
<PRE>
public void <B>setApplyType</B>(int&nbsp;bordersApplyType)</PRE>
<DL>
<DD>设置边框应用范围。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>bordersApplyType</CODE> - 边框类型(缺省是应用于段落)，其常量和相应的值如下：
 <pre>
   BorderAndShadingConstants.APPLY_PARAGRAPH = 0   应用于段落
   BorderAndShadingConstants.APPLY_TEXT = 1        应用于文字
   BorderAndShadingConstants.APPLY_CELL = 2        应用于单元格
   BorderAndShadingConstants.APPLY_TABLE = 3       应用于表格
 </pre>
 <b>例子：</b>
 <pre>
 Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                 .getWorksheets().getActiveWorksheet();
 Range range = worksheet.getRange("B3:E5");
 BorderAttribute border = new BorderAttribute(); 
 border.setApplyType(BorderAndShadingConstants.APPLY_CELL);
 border.setBorderType(BorderAndShadingConstants.BORDERTYPE_CUSTOM);
 border.setBorderLineType(BorderAndShadingConstants.DIAGONAL_FORWARD,0);
 border.setBorderLineWidth(BorderAndShadingConstants.DIAGONAL_FORWARD,0.5f);
 border.setBorderLineType(BorderAndShadingConstants.DIAGONAL_BACKWARD,0);
 border.setBorderLineWidth(BorderAndShadingConstants.DIAGONAL_BACKWARD,0.5f);
 range.setBorderAttribute(border);
 </pre> 
 
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当边框类型不存在<DT><B>另请参见：</B><DD><A HREF="../../../../../application/constants/BorderAndShadingConstants.html" title="application.constants 中的接口"><CODE>BorderAndShadingConstants</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setBorderLineColor(int, java.awt.Color)"><!-- --></A><H3>
setBorderLineColor</H3>
<PRE>
public void <B>setBorderLineColor</B>(int&nbsp;borderPosition,
                               java.awt.Color&nbsp;color)</PRE>
<DL>
<DD>设置边框线颜色。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>borderPosition</CODE> - 边缘边框类型，其常量和相应的值如下：
 <pre>
 BorderAndShadingConstants.LEFT = 0       左边缘边框
 BorderAndShadingConstants.TOP = 1        上边缘边框
 BorderAndShadingConstants.RIGHT = 2      右边缘边框
 BorderAndShadingConstants.BOTTOM = 3     下边缘边框
 BorderAndShadingConstants.MIDDLE_HORIZON = 4     中间水平线边框
 BorderAndShadingConstants.MIDDLE_VERTICAL = 5    中间垂直线边框
 BorderAndShadingConstants.DIAGONAL_FORWARD = 6   左上对角线边框
 BorderAndShadingConstants.DIAGONAL_BACKWARD = 7  右上对角线边框<DD><CODE>color</CODE> - 边框线颜色，如Color.red
 </pre>