概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

## application.workbooks.workbook.shapes
类 DocField

    java.lang.Object
      application.workbooks.workbook.shapes.Shape
          application.workbooks.workbook.documents.document.wpshapes.WpShape
              application.workbooks.workbook.shapes.DocField

    public class DocField

extends WpShape

该类定义了一些对当前公文域对象进行操作的一些方法。

方法摘要
`void` | `clear()` 删除公文域中的对象（文本，图片，艺术字等）。
`void` | `delete()` 删除当前的域对象。
`boolean` | `getCanDelete()` 得到公文域的属性值是否可被删除。
`boolean` | `getContentLocked()` 得到当前公文域的内容是否锁定。
`java.lang.String` | `getDocFieldText()` 得到当前公文域中的文本内容。
`java.lang.String` | `getName()` 得到公文域的名字。
`boolean` | `getPositionLocked()` 得到公文域的位置是否被锁定。
`boolean` | `getTextFitShape()` 得到公文域的尺寸是否适应文字。
`void` | `insertDocFieldTip(java.lang.String text)` 插入公文域提示信息。
`boolean` | `isDocField()` 判断当前图形对象是否是公文域。
`void` | `move(float startXOff, float startYOff, float endXOff, float endYOff)` 按指定位置移动图形对象。
`void` | `setCanDelete(boolean flag)` 设置公文域是否可被删除。
`void` | `setContentLocked(boolean flag)` 公文域的内容锁定。
`void` | `setLayoutIndex(int index)` 设置自选图形在文本中的环绕样式，如公文域已设置位置锁定，则设置嵌入文本无效。
`void` | `setName(java.lang.String name)` 设置公文域的名字。
`void` | `setPositionLocked(boolean flag)` 公文域的位置锁定。
`void` | `setText(java.lang.String text)` 将文本插入到当前公文域中。
`void` | `setTextFixShape(boolean flag)` 调整公文域的尺寸以适应文字。

从类 application.workbooks.workbook.documents.document.wpshapes.WpShape 继承的方法
`breakForwardLink, getHorAlignLeft, getHorAlignLeftByCentimeters, getNextLinkTextFrame, getPreviousLinkTextFrame, getRelativeHorizontalPosition, getRelativeVerAlignPosition, getVerAlignTop, getVerAlignTopByCentimeters, isAllOverlap, isAnchorLock, isCanSelectInProtect, isMovedByText, isSeal, isValidLinkTarget, setAllowOverlap, setAnchorLock, setCanSelectInProtect, setHorAlignLeft, setHorAlignLeftByCentimeters, setHorizonAlignment, setLevelDown, setLevelLeft, setLevelRight, setLevelUp, setLocate, setMovedByText, setNextLinkTextFrame, setRelativeHorizontalPosition, setRelativeVerAlignPosition, setSeal, setSurroundType, setVerAlignTop, setVerAlignTopByCentimeters`

从类 application.workbooks.workbook.shapes.Shape 继承的方法
`addMouseListener, beginEdit, changeConnector, changeOrder, changePicture, changeType, compressPicture, copyFormatInfo, duplicate, flipHorizontal, flipVertical, getAlternativeText, getConnectFormat, getDataObject, getEndPoint, getFillAttribute, getHalfDrag, getHeight, getLineFormat, getNodes, getPictureFormat, getPlugID, getPlugInData, getPlugSubID, getRotateAngle, getShadowFormat, getShapeContent, getShapeText, getStartPoint, getTextEffectFormat, getTextFrame, getThreeDFormat, getType, getWidth, hasTextFrame, isCanFlip, isCanGroup, isCanRotate, isConnectable, isEditable, isGroup, isLockLocation, isLockRatio, isLockSize, isPicture, isPrintShape, isSelected, isTextEffect, move, moveByValue, pasteFormatInfo, removeMouseListener, reShape, saveAs, select, setAlternativeText, setCanFlip, setCanGroup, setCanRotate, setDefaultProperties, setFillAttribute, setHalfDrag, setHeight, setLocation, setLockLocation, setLockPosition, setLockRatio, setLockSize, setPlugID, setPlugInData, setPlugSubID, setPrintShape, setRotateAngle, setRotateAngleByDegree, setWidth, stopEdit, unSelect`

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

方法详细信息

### clear

    public void clear()

  删除公文域中的对象（文本，图片，艺术字等）。

  例子：

       Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
       DocField docField = shapes.getDocField("公文域1") ;
       docField.clear() ;

### delete

    public void delete()

  删除当前的域对象。

  例子：

       Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
       DocField docField = shapes.getDocField("公文域1") ;
       docField.delete() ;

  覆盖：
    类 `Shape` 中的 `delete`

### getCanDelete

    public boolean getCanDelete()

  得到公文域的属性值是否可被删除。

  覆盖：
    类 `Shape` 中的 `getCanDelete`
  返回：
    布尔型值，如为true 可以删除 false 不可以删除。

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.getCanDelete() ;

### getContentLocked

    public boolean getContentLocked()

  得到当前公文域的内容是否锁定。

  返回：
    布尔型值，如为true 锁定 false 不锁定

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.getContentLocked() ;

### getDocFieldText

    public java.lang.String getDocFieldText()

  得到当前公文域中的文本内容。

  返回：
    文本内容

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.getDocFieldText() ;

### getName

    public java.lang.String getName()

  得到公文域的名字。

  覆盖：
    类 `Shape` 中的 `getName`
  返回：
    公文域的名字

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField []docField = shapes.getAllDocFields();
         System.out.println("name="+docField[0].getName());

### getPositionLocked

    public boolean getPositionLocked()

  得到公文域的位置是否被锁定。

  返回：
    布尔型值，如为true 锁定 false 不锁定

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.getPositionLocked() ;

### getTextFitShape

    public boolean getTextFitShape()

  得到公文域的尺寸是否适应文字。

  返回：
    布尔型值，如为true 适应文字 false 不适应文字

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.getTextFitShape() ;

### insertDocFieldTip

    public void insertDocFieldTip(java.lang.String text)

  插入公文域提示信息。

  参数：
    `text` - 公文域信息

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.insertDocFieldTip("抄送机关") ;

### isDocField

    public boolean isDocField()

  判断当前图形对象是否是公文域。

  覆盖：
    类 `Shape` 中的 `isDocField`
  返回：
    布尔型值，如果当前图形对象是公文域，返回true；否则，返回false

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         javax.swing.JOptionPane.showMessageDialog(null,"此对象是否公文域"+" "+docField.isDocField()) ;

### move

    public void move(float startXOff,
                     float startYOff,
                     float endXOff,
                     float endYOff)

  按指定位置移动图形对象。

  参数：
    `startXOff` - 图形对象左上角偏移的X坐标值（以象素为单位）
    `startYOff` - 图形对象左上角偏移的Y坐标值（以象素为单位）
    `endXOff` - 图形对象右下角偏移的X坐标值（以象素为单位）
    `endYOff` - 图形对象右下角偏移的Y坐标值（以象素为单位）

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.move(23.20f,22.30f,59.20f,89.10f) ;

### setCanDelete

    public void setCanDelete(boolean flag)

  设置公文域是否可被删除。

  覆盖：
    类 `Shape` 中的 `setCanDelete`
  参数：
    `flag` - 布尔型值，如为true 可以删除 false 不可以删除。

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.setCanDelete(false) ;

### setContentLocked

    public void setContentLocked(boolean flag)

  公文域的内容锁定。

  参数：
    `flag` - 布尔型值，如为true 锁定 false 不锁定

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.setContentLocked(true) ;

### setLayoutIndex

    public void setLayoutIndex(int index)

  设置自选图形在文本中的环绕样式，如公文域已设置位置锁定，则设置嵌入文本无效。

  覆盖：
    类 `WpShape` 中的 `setLayoutIndex`
  参数：
    `index` - 自选图形在文本中的环绕样式，只能取以下整形值之一：

         ShapeConstants.TIGHT_TEXT       0   自选图形嵌入在文本内，其水平对齐、环绕文字、距文字属性都无效（嵌入型）
         ShapeConstants.SQUARE_TEXT      1   自选图形被周围文本环绕，其水平对齐属性无效（四周型）
         ShapeConstants.IN_LINE_TEXT     2   自选图形在文本中独占一行，其环绕文字属性都无效（上下型）
         ShapeConstants.BEHIND_TEXT      3   自选图形隐藏在文本之下，其环绕文字、距文字属性都无效
         ShapeConstants.IN_FRONT_OF_TEXT 4   自选图形覆盖在文本之上，其环绕文字、距文字属性都无效
         ShapeConstants.WRAP_TIGHT       5   自选图形紧密型
         ShpaeConstants.WRAP_THROUGH     6   自选图形穿越型

    例子:

         //请在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         WpShapes shapes = doc.getShapes();
         Shape shape = shapes.addShape(1,180,120,290,280);
         shape.setLayoutIndex(ShapeConstants.BEHIND_TEXT);
         shape.setHorizonAlignment(1);

  另请参见：
    `WpShape.setHorizonAlignment(int)`, `WpShape.setSurroundType(int)`, `WpShapes`, `Shape`

### setName

    public void setName(java.lang.String name)

  设置公文域的名字。

  参数：
    `name` - 公文域的名字

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.setName("公文域a") ;

### setPositionLocked

    public void setPositionLocked(boolean flag)

  公文域的位置锁定。

  参数：
    `flag` - 布尔型值，如为true 锁定 false 不锁定

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.setPositionLocked(true) ;

### setText

    public void setText(java.lang.String text)

  将文本插入到当前公文域中。

  参数：
    `text` - 要插入的文本

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.setText("发文机关") ;

### setTextFixShape

    public void setTextFixShape(boolean flag)

  调整公文域的尺寸以适应文字。

  参数：
    `flag` - 布尔型值，如为true 适应文字 false 不适应文字

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocField("公文域1") ;
         docField.setTextFixShape(true) ;

概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

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