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

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

## application.workbooks.workbook.shapes
类 DocFieldRange

    java.lang.Object
      application.workbooks.workbook.shapes.ShapeRange
          application.workbooks.workbook.documents.document.wpshapes.WpShapeRange
              application.workbooks.workbook.shapes.DocFieldRange

    public class DocFieldRange

extends WpShapeRange

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

方法摘要
`void` | `clear()` 删除公文域中的文本。
`void` | `delete()` 删除当前的图形对象。
`DocField[]` | `getAllDocFields()` 得到当前选择中所有公文域对象。
`boolean` | `getCanDelete()` 得到公文域是否可被删除。
`boolean` | `getContentLocked()` 得到公文域的内容是否锁定。
`java.lang.String` | `getDocFieldName()` 得到公文域的名字。
`java.lang.String` | `getDocFieldText()` 得到公文域中的文本内容。
`boolean` | `getPositionLocked()` 得到公文域的位置是否锁定。
`boolean` | `getTextFixShape()` 得到当前公文域的尺寸是否适应文字。
`void` | `insertDocFieldTip(java.lang.String text)` 插入公文域提示信息。
`void` | `setCanDelete(boolean flag)` 设置公文域是否可被删除。
`void` | `setContentLocked(boolean flag)` 公文域的内容锁定。
`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.WpShapeRange 继承的方法
`getHorAlignLeft, getHorAlignLeftByCentimeters, getRelativeHorizontalPosition, getRelativeVerAlignPosition, getVerAlignTop, getVerAlignToptByCentimeters, isAllOverlap, isMovedByText, setAllowOverlap, setAnchorLock, setHorAlignLeft, setHorAlignLeftByCentimeters, setHorizonAlignment, setLayoutIndex, setLevelDown, setLevelLeft, setLevelRight, setLevelUp, setLocate, setMovedByText, setRelativeHorizontalPosition, setRelativeVerAlignPosition, setSurroundType, setVerAlignTop, setVerAlignTopByCentimeters`

从类 application.workbooks.workbook.shapes.ShapeRange 继承的方法
`beginEdit, changeConnector, changeOrder, changeType, copyFormatInfo, deleteSelect, duplicate, flipHorizontal, flipVertical, getActiveText, getConnectFormat, getDataObject, getFillAttribute, getHeightDoubleValue, getImage, getLineFormat, getNodes, getPictureFormat, getPlugID, getPlugInData, getPlugSubID, getPrintCount, getRotateAngle, getShadowFormat, getShapeContent, getTextEffectFormat, getThreeDFormat, getWidthDoubleValue, group, isCanFlip, isCanGroup, isCanMoveLocation, isCanRotate, isGroup, isLockLocation, isLockRatio, isLockSize, isPicture, move, pasteFormatInfo, reGroup, reShape, select, setAlignBottom, setAlignHorizontallyCenter, setAlignLeft, setAlignRight, setAlignTop, setAlignVerticallyCenter, setAutoSize, setCanFlip, setCanGroup, setCanMoveLocation, setCanRotate, setDefaultProperties, setFillAttribute, setHalfDrag, setHeight, setImage, setLocation, setLockLocation, setLockRatio, setLockSize, setOrientationIndex, setPlugID, setPlugInData, setPlugSubID, setPosition, setPrintCount, setPrintShape, setRotateAngle, setRotateAngleByDegree, setTextBoxAnchorPoint, setTextRotateWithShape, setWidth, setWordWrap, stopEdit, unGroup, unSelect`

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

方法详细信息

### clear

    public void clear()

  删除公文域中的文本。

  例子：

       Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
       DocFieldRange docField = shapes.getDocFieldRange() ;
       docField.clear() ;

### delete

    public void delete()

  删除当前的图形对象。

  例子：

       Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
       DocFieldRange docFieldRange = shapes.getDocFieldRange();
       docFieldRange.delete() ;

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

### getAllDocFields

    public DocField[] getAllDocFields()

  得到当前选择中所有公文域对象。

  返回：
    公文域对象

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docFieldRange = shapes.getDocFieldRange() ;
         DocField[] docField = docFieldRange.getAllDocFields() ;

### getCanDelete

    public boolean getCanDelete()

  得到公文域是否可被删除。

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docFieldRange = shapes.getDocFieldRange() ;
         docField.getCanDelete() ;

### getContentLocked

    public boolean getContentLocked()

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

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.getContentLocked() ;

### getDocFieldName

    public java.lang.String getDocFieldName()

  得到公文域的名字。

  返回：
    公文域的名字

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.getDocFieldName() ;

### getDocFieldText

    public java.lang.String getDocFieldText()

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

  返回：
    文本的文本

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.getText() ;

### getPositionLocked

    public boolean getPositionLocked()

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

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.getPositionLocked() ;

### getTextFixShape

    public boolean getTextFixShape()

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

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.getTextFixShape() ;

### insertDocFieldTip

    public void insertDocFieldTip(java.lang.String text)

  插入公文域提示信息。

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.insertDocFieldTip("抄送机关") ;

### setCanDelete

    public void setCanDelete(boolean flag)

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

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocField docField = shapes.getDocFieldRange() ;
         docField.setCanDelete(false) ;

### setContentLocked

    public void setContentLocked(boolean flag)

  公文域的内容锁定。

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.setContentLocked(true) ;

### setName

    public void setName(java.lang.String name)

  设置公文域的名字。

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.setName("公文域a") ;

### setPositionLocked

    public void setPositionLocked(boolean flag)

  公文域的位置锁定。

  覆盖：
    类 `ShapeRange` 中的 `setPositionLocked`
  参数：
    `flag` - 布尔型值，如为true 锁定 false 不锁定

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.setPositionLocked(true) ;

### setText

    public void setText(java.lang.String text)

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

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

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.setText("发文机关") ;

### setTextFixShape

    public void setTextFixShape(boolean flag)

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

  覆盖：
    类 `ShapeRange` 中的 `setTextFixShape`
  参数：
    `flag` - 布尔型值，如为true 适应文字 false 不适应文字

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         DocFieldRange docField = shapes.getDocFieldRange() ;
         docField.setTextFixShape(true) ;

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

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