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

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

## application.workbooks.workbook.shapes
类 TextEffectFormat

    java.lang.Object
      application.workbooks.workbook.shapes.TextEffectFormat

    public class TextEffectFormat

extends java.lang.Object

该类定义了对艺术字对象进行操作的一些方法，如设置艺术字的类型，对齐方式，艺术字形状和艺术字模式等。

方法摘要
`int` | `getAlignType()` 获取艺术字的对齐方式。
`int` | `getMode()` 获取当前艺术字的形状。
`double` | `getPitch()` 获取艺术字的字间距。
`java.lang.String` | `getText()` 获取艺术字文本。
`int` | `getType()` 得到当前艺术字的类型(当除艺术字大小以外的任何属性改变时，艺术字的类型都会变为-1)。
`boolean` | `isEqualHeight()` 判断艺术字是否相同高度。
`boolean` | `isErect()` 判断艺术字是否为垂直竖排。
`void` | `setAlignType(int alignType)` 设置艺术字的对齐方式。
`void` | `setEqualHeight(boolean equal)` 设置艺术字为相同高度。
`void` | `setErect(boolean isErect)` 设置艺术字是否垂直竖排。
`void` | `setMode(int mode)` 设置当前艺术字的形状。
`void` | `setPitch(int type, double pitch)` 设置艺术字的字间距。
`void` | `setText(java.lang.String text)` 设置艺术字文本。
`void` | `setText(java.lang.String text, java.lang.String fontName, int fontStyle, int fontSize)` 设置艺术字文本。
`void` | `setType(int type)` 设置当前艺术字的类型。

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

方法详细信息

### getAlignType

    public int getAlignType()

  获取艺术字的对齐方式。

  返回：
    艺术字的对齐方式，为整型数值，如果艺术字的文本对齐方式为“左对齐”，返回1；如果艺术字的文本对齐方式为“居中对齐”，返回2；如果艺术字的文本对齐方式为“右对齐”，返回3；如果艺术字的文本对齐方式为“伸展对齐”，返回4

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字是第"+txteffect.getAlignType()+"种对齐方式") ;

### getMode

    public int getMode()

  获取当前艺术字的形状。

  返回：
    艺术字的形状，为整型数值

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的形状是"+txteffect.getMode());

### getPitch

    public double getPitch()

  获取艺术字的字间距。

  返回：
    艺术字的字间距，为double型

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的间距是"+txteffect.getPitch()) ;

### getText

    public java.lang.String getText()

  获取艺术字文本。

  返回：
    艺术字文本

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的文本内容是"+txteffect.getText()) ;

### getType

    public int getType()

  得到当前艺术字的类型(当除艺术字大小以外的任何属性改变时，艺术字的类型都会变为-1)。

  返回：
    艺术字的类型，为整型数值，取值0-29：

                      0-5    对应艺术字库的第一行第一到第六个
                      6-11   对应艺术字库的第二行第一到第六个
                      12-17  对应艺术字库的第三行第一到第六个
                      18-23  对应艺术字库的第四行第一到第六个
                      24-29  对应艺术字库的第五行第一到第六个

         例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的类型是"+txteffect.getType()+"种") ;

### isEqualHeight

    public boolean isEqualHeight()

  判断艺术字是否相同高度。

  返回：
    布尔型值，如果艺术字为相同高度，返回true；否则，返回false

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字字母高度是否等高"+txteffect.isEqualHeight()) ;

### isErect

    public boolean isErect()

  判断艺术字是否为垂直竖排。

  返回：
    布尔型值，如果艺术字垂直竖排，返回true；否则，返回false

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字是否竖排"+txteffect.isErect()) ;

### setAlignType

    public void setAlignType(int alignType)

  设置艺术字的对齐方式。

  参数：
    `alignType` - 对齐类型索引值，如为1，表示左对齐；如为2，表示居中对齐；如为3，表示右对齐；如为4，表示伸展对齐

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setAlignType(1) ;

### setEqualHeight

    public void setEqualHeight(boolean equal)

  设置艺术字为相同高度。

  参数：
    `equal` - 布尔型值，如为true，设置艺术字为相同高度；否则，不设置相同高度

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setEqualHeight(true) ;

### setErect

    public void setErect(boolean isErect)

  设置艺术字是否垂直竖排。

  参数：
    `isErect` - 布尔型值，如为true，设置艺术字垂直竖排；否则，水平方向排列

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setErect(true) ;

### setMode

    public void setMode(int mode)

  设置当前艺术字的形状。

  参数：
    `mode` - 艺术字的形状类型，取值1-40

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setMode(2) ;

  抛出：
    `MacroRunException` - 当参数不在1-40之间时

### setPitch

    public void setPitch(int type,
                         double pitch)

  设置艺术字的字间距。

  参数：
    `pitch` - 艺术字的间距，为double型
    `type` - 艺术字的间距类型，为整型, 取值0-5，0-4为系统定义的间距, 5是自定义间距，间距大小由pitch确定, 对应如下：

                      0    非常紧密(0.8f)
                      1    紧密(0.9f)
                      2    一般(1.0f)
                      3    松散(1.2f)
                      4    非常松散(1.5f)
                      5    用户自定义间距, 由pitch值确定

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setPitch(1,2.0) ;

### setText

    public void setText(java.lang.String text)

  设置艺术字文本。

  参数：
    `text` - 艺术字的文本

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setText("春夏秋冬") ;

  抛出：
    `MacroRunException` - 当参数text越界

### setText

    public void setText(java.lang.String text,
                        java.lang.String fontName,
                        int fontStyle,
                        int fontSize)

  设置艺术字文本。

  参数：
    `text` - 艺术字的文本
    `fontName` - 字体的名称
    `fontStyle` - 字型，为整型数值，1表示黑体，2表示斜体，3表示黑体加斜，0和其余整数表示常规
    `fontSize` - 字体的大小

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setText("中华人民共和国","宋体",2,72) ;

  抛出：
    `MacroRunException` - 当参数text，或fontStyle，或fontSize越界

### setType

    public void setType(int type)

  设置当前艺术字的类型。

  参数：
    `type` - 艺术字的类型，为整型数值,取值0-29，超出范围不重新设置，函数直接退出。对应如下：

                      0-5    对应艺术字库的第一行第一到第六个
                      6-11   对应艺术字库的第二行第一到第六个
                      12-17  对应艺术字库的第三行第一到第六个
                      18-23  对应艺术字库的第四行第一到第六个
                      24-29  对应艺术字库的第五行第一到第六个

    例子：

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setType(10) ;

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

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

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