Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook.worksheets.worksheet
Class Cell

    java.lang.Object
      application.workbooks.workbook.worksheets.worksheet.Cell

public class Cell
extends java.lang.Object

该类定义了对当前单元格进行操作的一些方法，如设置和获取单元格的值，插入注释，保护单元格，设置单元格属性等。

Method Summary
`void` | `addMultiMedia(java.lang.String name)` 在当前的单元格中插入一个影音文件。
`void` | `clear()` 清除指定单元格中的全部信息，包括格式、内容、注释等。
`void` | `clearComments()` 清除指定单元格中的注释。
`void` | `clearContents()` 清除指定单元格中的内容。
`void` | `clearFormats()` 清除指定单元格中的格式。
`void` | `editComment()` 编辑当前单元格内注释。
`boolean` | `equals(Cell cell)` 比较两个单元格对象是否为同一个对象。
`void` | `floatPicture()` 浮起单元格内图片.
`java.lang.String` | `getAddress()` 获取当前单元格的地址。
`FillAttribute` | `getBackground()` 获取当前单元格填充颜色属性。
`CellAttribute` | `getCellAttribute()` 获取当前单元格的属性。
`Characters` | `getCharacters(int startPosition, int length)` 取得当前单元格中部分字符。
`int` | `getColumn()` 获取当前单元格列号。
`Comment` | `getComment()` 获取当前单元格内的注释。
`int` | `getRow()` 获取当前单元格行号。
`java.lang.String` | `getString()` 获取单元格内的字符内容。
`java.lang.Object` | `getValue()` 获取单元格的值。
`void` | `insertComment()` 在选中的单元格中插入注释。
`void` | `insertPicture(java.lang.String pictureName)` 在当前的单元格中插入一幅图片。
`void` | `linkRange(java.lang.String value)` 用指定的数据类型设置所选单元格的内容。
`void` | `protectCells()` 对当前单元格进行保护。
`void` | `protectCells(int type)` 对当前的单元格进行保护。
`void` | `setCellAttribute(CellAttribute cellAttribute)` 设置当前单元格的属性。
`void` | `setImageFitToCell(boolean isFitToCell)` 设置单元格图片调整至单元格大小。
`void` | `setImageFormat(int scale, int hAlign, int vAlign, int leftMargin, int topMargin)` 设置图片在单元格中的放置格式，采用整体缩放比例方式。
`void` | `setImageFormat(int hScale, int vScale, int hAlign, int vAlign, int leftMargin, int topMargin)` 设置图片在单元格中的放置格式，采用宽度缩放比例和高度缩放比例。
`void` | `setImageRotation(int index)` 设置单元格内图片的旋转角度。
`void` | `setValue(boolean value)` 用指定的数据类型设置所选单元格的内容。
`void` | `setValue(double value)` 用指定的数据类型设置所选单元格的内容。
`void` | `setValue(long value)` 用指定的数据类型设置所选单元格的内容。
`void` | `setValue(java.lang.Object object)` 用指定的数据类型设置所选单元格的内容。
`void` | `setValue(java.lang.String value)` 用指定的数据类型设置所选单元格的内容。
`void` | `showComment(boolean show)` 显示当前单元格内注释。
`void` | `showImage(boolean isShow)` 设置是否显示单元格中图片。
`void` | `unprotectCells()` 对当前单元格解除保护。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### addMultiMedia

    public void addMultiMedia(java.lang.String name)

  在当前的单元格中插入一个影音文件。

  Parameters:
    `name` - 带绝对路径的影音文件名

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getCell("C4").addMultiMedia("C:\\WINNT\\clock.avi");

### clear

    public void clear()

  清除指定单元格中的全部信息，包括格式、内容、注释等。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getActiveCell().clear();

  See Also:
    `clearComments()`, `clearContents()`, `clearFormats()`

### clearComments

    public void clearComments()

  清除指定单元格中的注释。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getCell("C4").clearComments();

  See Also:
    `clear()`, `clearContents()`, `clearFormats()`

### clearContents

    public void clearContents()

  清除指定单元格中的内容。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getActiveCell().clearContents();

  See Also:
    `clear()`, `clearComments()`, `clearFormats()`

### clearFormats

    public void clearFormats()

  清除指定单元格中的格式。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getActiveCell().clearFormats();

  See Also:
    `clear()`, `clearContents()`, `clearComments()`

### editComment

    public void editComment()

  编辑当前单元格内注释。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getCell("C4").editComment();

  See Also:
    `getComment(int, int)`, `insertComment()`, `showComment(boolean)`

### equals

    public boolean equals(Cell cell)

  比较两个单元格对象是否为同一个对象。

  Parameters:
    `cell` - 用于比较的单元格对象
  Returns:
    布尔型，如果两个单元格为同一个单元格对象，则返回true；否则返回false

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().equals(worksheet.getCell("C5"));

### floatPicture

    public void floatPicture()

  浮起单元格内图片.

  例子：

       Options.setShowObjectIndex(1);
       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                        .getWorksheets().getActiveWorksheet();
       Cell cell = worksheet.getActiveCell();
       cell.insertPicture("c:\\documents and settings\\administrator\\my documents\\my pictures\\样品.jpg");
       cell.floatPicture();

  See Also:
    `insertPicture(java.lang.String)`

### getAddress

    public java.lang.String getAddress()

  获取当前单元格的地址。

  Returns:
    当前单元格的地址

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().getAddress();

### getBackground

    public FillAttribute getBackground()

  获取当前单元格填充颜色属性。

  Returns:
    填充属性

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         FillAttribute fa =  worksheet.getActiveCell().getBackground();
         fa.setTexture(java.awt.Color.CYAN);

  See Also:
    `FillAttribute`

### getCellAttribute

    public CellAttribute getCellAttribute()

  获取当前单元格的属性。

  Returns:
    CellAttribute，即单元格属性对象

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getCell("C4").getCellAttribute();

  See Also:
    `CellAttribute`, `setCellAttribute(application.workbooks.workbook.worksheets.CellAttribute)`

### getCharacters

    public Characters getCharacters(int startPosition,
                                    int length)

  取得当前单元格中部分字符。

  Parameters:
    `startPosition` - 起始位置
    `length` - 选取长度

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                          .getWorksheets().getActiveWorksheet();
         Cell cell = worksheet.getCell("a1");
         cell.setValue("abcdef");
         Characters chars = cell.getCharacters(1,4);
         System.out.println(chars.toString());
         chars.setFontSize(14);
         chars.setFontBold(true);
         chars.setUnderLine(true);
         chars.setColor(java.awt.Color.RED);

  Returns:
    指定的字符
  See Also:
    `application.workbooks.workbook.worksheets.Characters`

### getColumn

    public int getColumn()

  获取当前单元格列号。

  Returns:
    当前单元格的列号

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().getColumn();

  See Also:
    `getRow()`

### getComment

    public Comment getComment()

  获取当前单元格内的注释。

  Returns:
    指定单元格内的注释
  See Also:
    `insertComment()`, `editComment()`, `showComment(boolean)`

### getRow

    public int getRow()

  获取当前单元格行号。

  Returns:
    当前单元格的行号

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().getRow();

  See Also:
    `getColumn()`

### getString

    public java.lang.String getString()

  获取单元格内的字符内容。

  Returns:
    单元格内的的字符串

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().getString();

### getValue

    public java.lang.Object getValue()

  获取单元格的值。

  Returns:
    单元格中储存的对象 此返回对象有三种可能： 1、HyperlinkAttribute 单元格中有超链接。 2、String 单元格中存在字符串。 3、object 单元格中存在图片、图表等。

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().getValue();

### insertComment

    public void insertComment()

  在选中的单元格中插入注释。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getCell("C4").insertComment();

  See Also:
    `getComment(int, int)`, `editComment()`, `showComment(boolean)`

### insertPicture

    public void insertPicture(java.lang.String pictureName)

  在当前的单元格中插入一幅图片。

  Parameters:
    `pictureName` - 带完全路径的图片的文件名

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getCell("C4").insertPicture("c:\\documents and settings\\dingwei\\my documents\\my pictures\\样品.jpg");

  See Also:
    `floatPicture()`

### linkRange

    public void linkRange(java.lang.String value)

  用指定的数据类型设置所选单元格的内容。

### protectCells

    public void protectCells()

  对当前单元格进行保护。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getCell("C4").protectCells();

  See Also:
    `unprotectCells()`

### protectCells

    public void protectCells(int type)

  对当前的单元格进行保护。

  Parameters:
    `type` - 设置保护的类型，可取的值为： 0：保护方式为锁定； 1：保护方式为隐藏公式

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getCell("C4").protectCells(1);

  See Also:
    `unprotectCells()`

### setCellAttribute

    public void setCellAttribute(CellAttribute cellAttribute)

  设置当前单元格的属性。

  Parameters:
    `cellAttribute` - 单元格属性对象

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         CellAttribute ca = new CellAttribute();
         ca.setFontColor(java.awt.Color.red);
         worksheet.getCell("C4").setCellAttribute(ca);

  See Also:
    `CellAttribute`, `getCellAttribute()`

### setImageFitToCell

    public void setImageFitToCell(boolean isFitToCell)

  设置单元格图片调整至单元格大小。

  Parameters:
    `isFitToCell` - true，调整至单元格大小；false，保持图片原大小

    例子：

         Options.setShowObjectIndex(1);
         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                              .getWorksheets().getActiveWorksheet();
         Cell cell = worksheet.getActiveCell();
         cell.insertPicture("c:\\documents and settings\\administrator\\my documents\\my pictures\\样品.jpg");
         cell.setImageFitToCell(false);

  See Also:
    `setImageRotation(int)`, `setImageFormat(int, int, int, int, int, int)`, `showImage(boolean)`

### setImageFormat

    public void setImageFormat(int scale,
                               int hAlign,
                               int vAlign,
                               int leftMargin,
                               int topMargin)

  设置图片在单元格中的放置格式，采用整体缩放比例方式。

  Parameters:
    `scale` - 整体缩放比例 取值范围10~400
    `hAlign` - 水平对齐方式，取值范围0~2

         LEFT   表示靠左
         CENTER 表示居中
         RIGHT  表示靠右

    `vAlign` - 垂直对齐方式，取值范围0~2

         UP     表示靠上
         CENTER 表示居中
         DOWN   表示靠下

    `leftMargin` - 左缩进，单位：磅
    `topMargin` - 上缩进，单位：磅

    例子：

         Options.setShowObjectIndex(1);
         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                              .getWorksheets().getActiveWorksheet();
         Cell cell = worksheet.getActiveCell();
         cell.insertPicture("c:\\documents and settings\\administrator\\my documents\\my pictures\\样品.jpg");
         cell.setImageFitToCell(false);
         cell.setImageFormat(300,BulletNumberConstants.LEFT,BulletNumberConstants.UP,0,0);

  See Also:
    `BulletNumberConstants`, `setImageRotation(int)`, `setImageFitToCell(boolean)`, `showImage(boolean)`

### setImageFormat

    public void setImageFormat(int hScale,
                               int vScale,
                               int hAlign,
                               int vAlign,
                               int leftMargin,
                               int topMargin)

  设置图片在单元格中的放置格式，采用宽度缩放比例和高度缩放比例。

  Parameters:
    `hScale` - 宽度缩放比例，取值范围10~400
    `vScale` - 高度缩放比例，取值范围10~400
    `hAlign` - 水平对齐方式，取值范围0~2

         LEFT   表示靠左
         CENTER 表示居中
         RIGHT  表示靠右

    `vAlign` - 垂直对齐方式，取值范围0~2

         UP     表示靠上
         CENTER 表示居中
         DOWN   表示靠下

    `leftMargin` - 左缩进，单位：磅
    `topMargin` - 上缩进，单位：磅

    例子：

         Options.setShowObjectIndex(1);
         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                              .getWorksheets().getActiveWorksheet();
         Cell cell = worksheet.getActiveCell();
         cell.insertPicture("c:\\documents and settings\\administrator\\my documents\\my pictures\\样品.jpg");
         cell.setImageFitToCell(false);
         cell.setImageFormat(100,100,BulletNumberConstants.LEFT,BulletNumberConstants.UP,0,0);

  See Also:
    `BulletNumberConstants`, `setImageRotation(int)`, `setImageFitToCell(boolean)`, `showImage(boolean)`

### setImageRotation

    public void setImageRotation(int index)

  设置单元格内图片的旋转角度。

  Parameters:
    `index` - 旋转角度的索引，取值范围0~3

         0表示旋转0度
         1表示旋转90度
         2表示旋转180度
         3表示旋转270度

    例子：

         Options.setShowObjectIndex(1);
         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                              .getWorksheets().getActiveWorksheet();
         Cell cell = worksheet.getActiveCell();
         cell.insertPicture("c:\\documents and settings\\administrator\\my documents\\my pictures\\样品.jpg");
         cell.setImageRotation(1);

  See Also:
    `setImageFitToCell(boolean)`, `setImageFormat(int, int, int, int, int, int)`, `showImage(boolean)`

### setValue

    public void setValue(boolean value)

  用指定的数据类型设置所选单元格的内容。

  Parameters:
    `value` - 布尔型值

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().setValue(true);

### setValue

    public void setValue(double value)

  用指定的数据类型设置所选单元格的内容。

  Parameters:
    `value` - 双精度型值

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().setValue(3.14159265357);

### setValue

    public void setValue(long value)

  用指定的数据类型设置所选单元格的内容。

  Parameters:
    `value` - 长整型值

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().setValue(1.3);

### setValue

    public void setValue(java.lang.Object object)

  用指定的数据类型设置所选单元格的内容。

  Parameters:
    `object` - Object（对象）数据类型值

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().setValue(new File("c:/test.bmp"));

### setValue

    public void setValue(java.lang.String value)

  用指定的数据类型设置所选单元格的内容。

  Parameters:
    `value` - 未经解析的基本字符串

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getActiveCell().setValue("ABC");

### showComment

    public void showComment(boolean show)

  显示当前单元格内注释。

  Parameters:
    `show` - 布尔型，如为true，则显示注释；否则不显示注释

    例子：

         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         worksheet.getCell("C4").showComment(true);

  See Also:
    `editComment()`, `getComment(int, int)`, `insertComment()`

### showImage

    public void showImage(boolean isShow)

  设置是否显示单元格中图片。

  Parameters:
    `isShow` - true，显示单元格中图片；false，不显示

    例子：

         Options.setShowObjectIndex(1);
         Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                              .getWorksheets().getActiveWorksheet();
         Cell cell = worksheet.getActiveCell();
         cell.insertPicture("c:\\documents and settings\\administrator\\my documents\\my pictures\\样品.jpg");
         cell.showImage(false);

  See Also:
    `setImageFitToCell(boolean)`, `setImageFormat(int, int, int, int, int, int)`, `setImageRotation(int)`

### unprotectCells

    public void unprotectCells()

  对当前单元格解除保护。

  例子：

       Worksheet worksheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       worksheet.getCell("C4").unprotectCells();

  See Also:
    `protectCells()`

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

版权所有 2001-2004 无锡永中科技有限公司