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.shapes
Class DocField

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

All Implemented Interfaces:
  application.resource.com.ComExceptionConstants

public class DocField
extends WpShape

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

Field Summary

Fields inherited from interface application.resource.com.ComExceptionConstants
`CANNOT_EDIT, CANNOT_MAKE_ARROW, DELETE_DOCFIELD, DELETE_SHAPE, DIRECTRY_NOT_FIND, ERROR_DOCFIELD, ERROR_MACRO_NAME, FILE_NOT_FIND, LOCKED_DOCFIELD, LOCKED_POSITION_DOCFIELD, NO_ARROW_STYLE, NO_BOOK_NAME, NO_BUILDER, NO_CONNECTOR_TYPE, NO_DOCFIELDNAME, NO_MACRO_FOUND, NO_OBJECT, NO_PATH_NAME, NO_PRINT_PREVIEW, NO_PRODUCT, NO_Seal, NO_Seal_File, NO_SELECTED_OBJECT, NO_SHAPE, NO_TOOLBAR, NO_UNDO_TIMES, NO_WINDOW, NO_WORKBOOK, NO_WORKBOOK_TYPE, NOT_CONNECT, NOT_IMAGE, NOT_PRESENTATION, NOT_SUPPORT_DIALOG_SHOW, NOT_SUPPORT_DIALOG_TYPE, NOT_TEXT_EFFECT, Repeat_Name, Seal_Sign, SHAPE_TYPE_ERROR, WRONG_FREEFORM_TYPE`

Method Summary
`void` | `clear()` 删除公文域中的文本。
`void` | `delete()` 删除当前的图形对象。
`boolean` | `getCanDelete()` 得到公文域是否可被删除。
`boolean` | `getContentLocked()` 得到当前公文域的内容是否锁定。
`java.lang.String` | `getDocFieldName()` 得到公文域的名字。
`java.lang.String` | `getDocFieldText()` 得到当前公文域中的文本内容。
`java.lang.String` | `getName()` 得到公文域的名字。
`boolean` | `getPositionLocked()` 得到公文域的位置是否被锁定。
`boolean` | `getTextFitShape()` 得到公文域的尺寸是否适应文字。
`int` | `getType()` 获取自选图形的类型。
`void` | `insertDocFieldTip(java.lang.String text)` 插入公文域提示信息。
`boolean` | `isDocField()` 判断当前图形对象是否是公文域。
`void` | `move(double startXOff, double startYOff, double endXOff, double endYOff)` 按指定位置移动图形对象。
`void` | `moveByValue(float xStartOffset, float yStartOffset, float xEndOffset, float yEndOffset)` 根据指定偏移数值移动图形对象。
`void` | `setCanDelete(boolean flag)` 设置公文域是否可被删除。
`void` | `setContentLocked(boolean flag)` 公文域的内容锁定。
`void` | `setDocFieldName(java.lang.String name)` 设置公文域的名字。
`void` | `setPositionLocked(boolean flag)` 公文域的位置锁定。
`void` | `setText(java.lang.String text)` 将文本插入到当前公文域中。
`void` | `setTextFixShape(boolean flag)` 调整公文域的尺寸以适应文字。
`void` | `setTextFixShape(int index, boolean flag)` 调整公文域的尺寸以适应文字。

Methods inherited from class application.workbooks.workbook.documents.document.wpshapes.WpShape
`setAnchorLock, setHorizonAlignment, setLayoutIndex, setLevelDown, setLevelLeft, setLevelRight, setLevelUp, setLocate, setSurroundType`

Methods inherited from class application.workbooks.workbook.shapes.Shape
`changeConnector, changeOrder, changeType, copyFormatInfo, duplicate, flipHorizontal, flipVertical, getConnectFormat, getEndPoint, getFillFormat, getHalfDrag, getHeight, getHeightDoubleValue, getIndex, getLineFormat, getOrientationIndex, getPictureFormat, getRotateAngle, getShadowFormat, getStartPoint, getText, getTextBoxAnchorPoint, getTextEffectFormat, getThreeDFormat, getWidth, getWidthDoubleValue, isConnectable, isEditable, isPicture, isPrintShape, isRatio, isSeal, isSelected, isTextEffect, pasteFormatInfo, reShape, reShape, select, selectToEdit, setHalfDrag, setHeight, setObjectPosition, setOrientationIndex, setPosition, setPrintShape, setRatio, setRotateAngle, setRotateAngleByDegree, setSign, setTextBoxAnchorPoint, setTextBoxMarginBottom, setTextBoxMarginLeft, setTextBoxMarginRight, setTextBoxMarginTop, setVerifySeal, setWidth, unSelect`

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

Method Detail

### 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() ;
       Shape shape = shapes.getShape(2) ;
       shape.delete() ;

  Overrides:
    `delete` in class `Shape`

### getCanDelete

    public boolean getCanDelete()

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

  Overrides:
    `getCanDelete` in class `Shape`
  Returns:
    布尔型值，如为true 可以删除 false 不可以删除。

    例子:

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

### getContentLocked

    public boolean getContentLocked()

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

  Returns:
    布尔型值，如为true 锁定 false 不锁定

    例子:

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

### getDocFieldName

    public java.lang.String getDocFieldName()

  得到公文域的名字。

  Returns:
    公文域的名字

    例子:

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

### getDocFieldText

    public java.lang.String getDocFieldText()

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

  Returns:
    文本内容

    例子:

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

### getName

    public java.lang.String getName()

  得到公文域的名字。

  Overrides:
    `getName` in class `Shape`
  Returns:
    公文域的名字

    例子:

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

### getPositionLocked

    public boolean getPositionLocked()

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

  Returns:
    布尔型值，如为true 锁定 false 不锁定

    例子:

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

### getTextFitShape

    public boolean getTextFitShape()

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

  Returns:
    布尔型值，如为true 适应文字 false 不适应文字

    例子:

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

### getType

    public int getType()

  获取自选图形的类型。

  Overrides:
    `getType` in class `Shape`
  Returns:
    自选图形的类型

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape(3) ;
         shape.getType() ;

### insertDocFieldTip

    public void insertDocFieldTip(java.lang.String text)

  插入公文域提示信息。

  Parameters:
    `text` - 公文域信息

    例子:

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

### isDocField

    public boolean isDocField()

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

  Overrides:
    `isDocField` in class `Shape`
  Returns:
    布尔型值，如果当前图形对象是公文域，返回true；否则，返回false

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape(1) ;
         javax.swing.JOptionPane.showMessageDialog(null,"此对象是否公文域"+" "+shape.isSeal()) ;

### move

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

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

  Overrides:
    `move` in class `Shape`
  Parameters:
    `startXOff` - 图形对象左上角偏移的X坐标值（以象素为单位）
    `startYOff` - 图形对象左上角偏移的Y坐标值（以象素为单位）
    `endXOff` - 图形对象右下角偏移的X坐标值（以象素为单位）

### moveByValue

    public void moveByValue(float xStartOffset,
                            float yStartOffset,
                            float xEndOffset,
                            float yEndOffset)

  根据指定偏移数值移动图形对象。

  Overrides:
    `moveByValue` in class `Shape`

### setCanDelete

    public void setCanDelete(boolean flag)

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

  Overrides:
    `setCanDelete` in class `Shape`
  Parameters:
    `flag` - 布尔型值，如为true 可以删除 false 不可以删除。

    例子:

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

### setContentLocked

    public void setContentLocked(boolean flag)

  公文域的内容锁定。

  Parameters:
    `flag` - 布尔型值，如为true 锁定 false 不锁定

    例子:

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

### setDocFieldName

    public void setDocFieldName(java.lang.String name)

  设置公文域的名字。

  Parameters:
    `name` - 公文域的名字

    例子:

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

### setPositionLocked

    public void setPositionLocked(boolean flag)

  公文域的位置锁定。

  Parameters:
    `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)

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

  Parameters:
    `text` - 要插入的文本

    例子:

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

### setTextFixShape

    public void setTextFixShape(boolean flag)

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

  Parameters:
    `flag` - 布尔型值，如为true 适应文字 false 不适应文字

    例子:

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

### setTextFixShape

    public void setTextFixShape(int index,
                                boolean flag)

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

  Parameters:
    `index` - 整型值，设置文本锁定点
    `flag` - 布尔型值，如为true 适应文字 false 不适应文字

    例子:

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

Overview | Package | Class | Tree | Index | Help

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

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