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

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

## application.workbooks.workbook.documents.document
类 TextRange

    java.lang.Object
      application.workbooks.workbook.documents.document.TextRange

    public class TextRange

extends java.lang.Object

该类指定了一个文本区域，能够对一段文本进行各种操作，如格式化，插入删除文本等。

方法摘要
`void` | `changeCase(int type)` 对当前文本区域的字符串更改大小写。
`void` | `clearFormats()` 清除当前区域的属性（包括字体、段落等属性）。
`void` | `copy()` 复制当前文本区域（包括图像，域，多媒体等对象）。
`void` | `copyFormat()` 将当前区域首位置的格式复制进系统剪贴板中。
`void` | `cut()` 剪切当前文本区域（包括图像，域，多媒体等对象）。
`void` | `decreaseIndent()` 对当前区域所在段落减少缩进。
`void` | `delete()` 删除当前文本区域的内容（包括图像，域，多媒体等对象）。
`void` | `deleteHyperlink()` 清除当前区域内的所有超链接属性。
`void` | `formatStyle(Style style)` 对当前区域的字符串格式化其样式。
`BorderAttribute` | `getBorderAttribute()` 获得当前区域起始位置处的边框属性。
`WordBulletLevel` | `getBulletLevel()` 得到指定位置处的项目符号或编号信息。
`WordBulletLevel[]` | `getBulletLevelArray()` 得到当前文本区域起始位置处的项目符号或编号的列表。
`long` | `getEndOffset()` 获得区域的结束位置，该位置是区域在全文中的位置。
`FontAttribute` | `getFontAttribute()` 获得当前区域首位置的字体属性。
`Hyperlink` | `getHyperlink()` 得到当前区域首位置的超级链接的链接属性，如果当前没有超级链接，那么就得到一个默认的超级链接。
`ParagraphAttribute` | `getParagraphAttribute()` 获得当前区域所在首段落的段落属性。
`Paragraphs` | `getParagraphs()` 得到当前文本区域的段落管理器。
`ShadingAttribute` | `getShadingAttribute()` 获得当前区域起始位置处的底纹属性。
`long` | `getStartOffset()` 获得区域的开始位置，该位置是区域在全文中的位置。
`java.lang.String` | `getText()` 返回当前区域的文本。
`void` | `highlight(java.awt.Color color)` 设置当前区域的文字为高亮显示状态。
`void` | `increaseIndent()` 对当前区域所在段落增加缩进。
`void` | `insertAudio(long offset, java.lang.String filepath)` 在当前区域起始位置处插入默认大小的声音文件。
`void` | `insertAudio(java.lang.String filepath, float width, float height)` 在当前区域起始位置处插入指定大小的声音文件。
`void` | `insertAutoText(java.lang.String entryName)` 在当前区域起始位置处插入自动图文集条目。
`void` | `insertAutoText(java.lang.String entryName, FontAttribute fontAttribute)` 在当前区域起始位置处插入带有字体属性的自动图文集条目。
`void` | `insertHyperlink(Hyperlink hyperlink)` 给当前区域设置超链接属性。
`void` | `insertNumber(int number, int type)` 在当前区域首位置插入指定样式的数字。
`void` | `insertNumber(int number, int type, FontAttribute fontAttribute)` 在当前区域首位置插入指定样式指定字体格式的数字。
`void` | `insertParagraph()` 在当前文本区域的首行位置插入换行符,此时光标到达下一行。
`void` | `insertPicture(java.lang.String filepath)` 在当前区域起始位置处插入默认大小的图片。
`void` | `insertPicture(java.lang.String filepath, float width, float height)` 在当前区域起始位置处插入指定大小的图片。
`void` | `insertText(java.lang.String text)` 在当前区域的起始位置插入字符串（插入属性为起始位置的输入属性）。
`void` | `insertText(java.lang.String text, FontAttribute fontAttribute)` 在当前区域的起始位置插入带有字体属性的字符串。
`void` | `insertTime(java.lang.String type)` 在当前区域起始位置插入指定样式的时间域。
`void` | `insertTime(java.lang.String type, boolean update, boolean isSBC, FontAttribute fontAttribute)` 在当前区域起始位置插入指定样式的时间域。
`void` | `insertVideo(java.lang.String filepath)` 在当前区域起始位置处插入默认大小的影像文件。
`void` | `insertVideo(java.lang.String filepath, float width, float height)` 在当前区域起始位置处插入指定大小的影像文件。
`TextRange` | `moveEnd(long offset)` 重新定义指定文本区域。
`TextRange` | `moveStart(long offset)` 重新定义指定文本区域。
`TextRange` | `moveTo(long offset, long length)` 重新定义指定文本区域。
`void` | `paste()` 在指定位置粘贴并替换指定长度的文本（包括图像，域，多媒体等对象）。
`void` | `pasteFormat()` 对当前区域的内容应用剪贴板的格式。
`void` | `select()` 选中当前区域的文本。
`void` | `setBorderAttribute(BorderAttribute borderAttribute)` 对当前区域格式化边框。
`void` | `setBulletedNumber(WordBulletLevel wordBulletLevel, boolean isContinue)` 应用项目符号或编号列表到当前选择区域。
`void` | `setBulletedNumber(WordBulletLevel wordBulletLevel, boolean isContinue, int applyTo)` 应用项目符号和编号列表到当前选择区域。
`void` | `setFontAttribute(FontAttribute fontAttribute)` 对当前区域的字符串进行格式化。
`void` | `setOutlinedNumber(WordBulletLevel[] bulletLevelArray, boolean isContinue)` 应用多级编号列表到当前选择区域。
`void` | `setParagraphAttribute(ParagraphAttribute paragraphAttribute)` 对当前区域的字符串进行段落格式化。
`void` | `setShadingAttribute(ShadingAttribute shadingAttribute)` 对当前区域格式化文字底纹。
`void` | `tcscConverter(boolean sctc)` 对当前区域的字符串进行简繁体转换。
`void` | `updateField()` 更新当前区域内的所有域。

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

方法详细信息

### changeCase

    public void changeCase(int type)

  对当前文本区域的字符串更改大小写。

  参数：
    `type` - 更改大小写的类型。只能取以下值之一：

         ChangeCaseConstants.SENTENCECASE    表示句首字母大写
         ChangeCaseConstants.LOWERCASE       表示小写
         ChangeCaseConstants.UPPERCASE       表示大写
         ChangeCaseConstants.TITLECASE       表示词首字母大写
         ChangeCaseConstants.TOGGLECASE      对所选内容进行大小写转换，即大写字母转换为小写，小写字母转换为大写
         ChangeCaseConstants.DBCCASE         表示半角
         ChangeCaseConstants.SBCCASE         表示全角

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,6);
         range.changeCase(ChangeCaseConstants.UPPERCASE);

  抛出：
    `application.exceptions.MacroRunException` - 当指定的大小写类型不存在
  另请参见：
    `ChangeCaseConstants`

### clearFormats

    public void clearFormats()

  清除当前区域的属性（包括字体、段落等属性）。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       FontAttribute fontAttr = new FontAttribute();
       fontAttr.setBold(true);
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!",fontAttr);
       ParagraphAttribute paraAttr = new ParagraphAttribute();
       paraAttr.setAlignment(ParagraphConstants.ALIGNMENT_CENTER);
       baseText.setParagraphAttribute(0, baseText.getTextLength()-1, paraAttr,false);
       TextRange range = baseText.getRange(3,10);
       range.clearFormats();

### copy

    public void copy()

  复制当前文本区域（包括图像，域，多媒体等对象）。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(2,4);
       range.copy();
       range.paste(0);

### copyFormat

    public void copyFormat()

  将当前区域首位置的格式复制进系统剪贴板中。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       FontAttribute fontAttr = new FontAttribute();
       fontAttr.setForeground(java.awt.Color.red);
       baseText.setFontAttribute(fontAttr);
       TextRange range = baseText.getRange(2,6);
       range.copyFormat();
       range = range.moveStart(5);
       range.pasteFormat();

### cut

    public void cut()

  剪切当前文本区域（包括图像，域，多媒体等对象）。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(2,4);
       range.cut();
       range.paste(0);

### decreaseIndent

    public void decreaseIndent()

  对当前区域所在段落减少缩进。

  例子：

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(2,10);
       range.decreaseIndent();

### delete

    public void delete()

  删除当前文本区域的内容（包括图像，域，多媒体等对象）。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(2,4);
       range.delete();

### deleteHyperlink

    public void deleteHyperlink()

  清除当前区域内的所有超链接属性。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       Hyperlink hyperlink = new Hyperlink();
       hyperlink.setHyperlinkType(HyperlinkConstants.THIS_BINDER_POSITION);
       hyperlink.setShowText("this is a test!");
       hyperlink.hyperlinkToCell("工作表1!A1");
       baseText.insertHyperlink(3,6,hyperlink);
       TextRange range = baseText.getRange(4,10);
       range.deleteHyperlink();

### formatStyle

    public void formatStyle(Style style)

  对当前区域的字符串格式化其样式。

  参数：
    `style` - 样式属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         Styles styles = doc.getStyles();
         Style style = styles.getStyle("标题 1");
         TextRange range baseText.getRange(2,10);
         range.formatStyle(style);

  抛出：
    `application.exceptions.MacroRunException` - 当样式属性为空
  另请参见：
    `Style`

### getBorderAttribute

    public BorderAttribute getBorderAttribute()

  获得当前区域起始位置处的边框属性。

  返回：
    边框属性。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         BorderAttribute borderAttr = new BorderAttribute();
         borderAttr.setApplyType(BorderAndShadingConstants.APPLY_TEXT);
         borderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
         borderAttr.setBorderLineType(BorderAndShadingConstants.TOP,1);
         borderAttr.setBorderLineType(BorderAndShadingConstants.LEFT,3);
         borderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT,6);
         borderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM,8);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.TOP,Color.RED);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT,Color.CYAN);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT,Color.YELLOW);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM,Color.ORANGE);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP,8f);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT,5f);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT,3f);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM,1f);
         baseText.setBorderAttribute(2,5,borderAttr);
         TextRange range = baseText.getRange(5,2);
         BorderAttribute border = range.getBorderAttribute();
         System.out.println("当前区域的字符边框的类型是："+border.getBorderType());

### getBulletLevel

    public WordBulletLevel getBulletLevel()

  得到指定位置处的项目符号或编号信息。说明：如果指定位置处是多级编号，则返回这个多级编号列表中的某一级别的编号信息。

  参数：
    `offset` - 指定位置
  返回：
    指定位置处的项目符号或编号信息

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         WordBulletLevel bullet = doc.getWordBulletLevel(BulletNumberConstants.LIST_NUMBER,2);
         baseText.setBulletedNumber(0,10,bullet,false);
         TextRange range = baseText.getRange(4,6);
         WordBulletLevel bullet = range.getBulletLevel();
         System.out.println("bullet = "+bullet);

### getBulletLevelArray

    public WordBulletLevel[] getBulletLevelArray()

  得到当前文本区域起始位置处的项目符号或编号的列表。 说明：如果起始位置处是项目符号或编号，则此列表返回长度为1的项目符号或编号数组。 如果起始位置处是多级编号，则此列表为一长度为9的项目符号或编号数组。每一数组项代表编号列表的级别。

  返回：
    当前文本区域起始位置处的项目符号或编号的列表

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         WordBulletLevel[] levels = doc.getBulletLevelArray(2);
         baseText.setOutlinedNumber(2,20,levels,true);
         TextRange range = baseText.getRange(5,5);
         WordBulletLevel[] bullets = range.getBulletLevelArray();
         for (int i = 0; i < bullets.length; i++)
         {
            System.out.println("得到的" + i + "级编号管理器为：" + bullets[i]);
         }

### getEndOffset

    public long getEndOffset()

  获得区域的结束位置，该位置是区域在全文中的位置。

  返回：
    区域的结束位置。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         Paragraphs ps = baseText.getParagraphs();
         Paragraph p = ps.getParagraph(0);
         System.out.println("当前段落区域的结束位置为："+p.getRange().getEndOffset());

### getFontAttribute

    public FontAttribute getFontAttribute()

  获得当前区域首位置的字体属性。

  返回：
    字体属性。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FontAttribute fontAttr = new FontAttribute();
         fontAttr.setFontSize(18.0);
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!",fontAttr);
         TextRange range = baseText.getRange(5，1);
         FontAttribute curFont = range.getFontAttribute();
         System.out.println("指定区域的字体大小是："+ curFont.getFontSize());

### getHyperlink

    public Hyperlink getHyperlink()

  得到当前区域首位置的超级链接的链接属性，如果当前没有超级链接，那么就得到一个默认的超级链接。

  返回：
    Hyperlink 超链接属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,5);
         Hyperlink hyperlink = range.getHyperlink();
         hyperlink.setHyperlinkType(HyperlinkConstants.THIS_BINDER_POSITION);
         hyperlink.setShowText("this is a test!");
         hyperlink.hyperlinkToCell("工作表1!A1");
         range.insertHyperlink(hyperlink);

  另请参见：
    `Hyperlink`

### getParagraphAttribute

    public ParagraphAttribute getParagraphAttribute()

  获得当前区域所在首段落的段落属性。

  返回：
    段落属性。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(5,15);
         ParagraphAttribute paraAttr = range.getParagraphAttribute();
         System.out.println("当前区域首段落对齐方式是："+paraAttr.getAlignment());

### getParagraphs

    public Paragraphs getParagraphs()

  得到当前文本区域的段落管理器。说明：这个管理器只管理当前文本区域内的所有段落。

  返回：
    段落管理器

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,30);
         Paragraphs paras = range.getParagraphs();
         System.out.println("当前文本区域的段落数为："+paras.getCount());

  抛出：
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域

### getShadingAttribute

    public ShadingAttribute getShadingAttribute()

  获得当前区域起始位置处的底纹属性。

  返回：
    底纹属性。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         ShadingAttribute shadingAttr = new ShadingAttribute();
         shadingAttr.setTextureIndex(15);
         baseText.setShadingAttribute(2,10,shadingAttr);
         TextRange range = baseText.getRange(5,2);
         ShadingAttribute shading = range.getShadingAttribute();
         System.out.println("当前区域的字符底纹索引是："+shading.getTextureIndex());

### getStartOffset

    public long getStartOffset()

  获得区域的开始位置，该位置是区域在全文中的位置。

  返回：
    区域的开始位置。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         Paragraphs ps = baseText.getParagraphs();
         Paragraph p = ps.getParagraph(1);
         System.out.println("当前段落区域的起始位置为："+p.getRange().getStartOffset());

### getText

    public java.lang.String getText()

  返回当前区域的文本。

  返回：
    当前区域的文本

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,6);
         String str = range.getText();
         System.out.println("当前区域的文本是："+ str);

### highlight

    public void highlight(java.awt.Color color)

  设置当前区域的文字为高亮显示状态。

  参数：
    `color` - 高亮显示的颜色

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,6);
         range.highlight(java.awt.Color.yellow);

  抛出：
    `application.exceptions.MacroRunException` - 当高亮颜色为空值

### increaseIndent

    public void increaseIndent()

  对当前区域所在段落增加缩进。

  例子：

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(2,10);
       range.increaseIndent();

### insertAudio

    public void insertAudio(long offset,
                            java.lang.String filepath)

  在当前区域起始位置处插入默认大小的声音文件。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入声音。

  参数：
    `filepath` - 插入声音文件的文件路径（绝对路径）

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,2);
         range.insertAudio("d:\\audio.mp3");

  抛出：
    `application.exceptions.MacroRunException` - 当声音文件路径不存在
  另请参见：
    `insertAudio(String,float,float)`

### insertAudio

    public void insertAudio(java.lang.String filepath,
                            float width,
                            float height)

  在当前区域起始位置处插入指定大小的声音文件。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入声音。

  参数：
    `filepath` - 插入声音文件的文件路径（绝对路径）
    `width` - 插入声音文件的宽度(以磅为单位，取值返回为0～49994.08磅之间)
    `height` - 插入声音文件的高度(以磅为单位，取值返回为0～49994.08磅之间)

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,2);
         range.insertAudio("d:\\audio.mp3",100f,100f);

  抛出：
    `application.exceptions.MacroRunException` - 当声音文件路径不存在
    `application.exceptions.MacroRunException` - 当声音文件图标宽度，高度小于0或大于49994.08
  另请参见：
    `#insertAudio(String)`

### insertAutoText

    public void insertAutoText(java.lang.String entryName)

  在当前区域起始位置处插入自动图文集条目。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入自动图文集条目。

  参数：
    `entryName` - 需要插入的条目。只能取以下值之一：

              AutoTextConstants.PAGE                        "- 页码 -"
              AutoTextConstants.AUTHOR_PAGE_DATE            "作者名，页码和日期"
              AutoTextConstants.CONFIDENTIAL_PAGE_DATE      "机密，页码和日期"
              AutoTextConstants.CREATED_BY                  "创建者"
              AutoTextConstants.CREATED_ON                  "创建时间"
              AutoTextConstants.FILENAME                    "文件名称"
              AutoTextConstants.FILENAME_PATH               "文件名称和路径"
              AutoTextConstants.PRINT_TIME                  "最近打印时间"
              AutoTextConstants.PAGE_X_OF_Y                 "第 X 页共 Y 页"

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,2);
         range.insertAutoText(AutoTextConstants.CONFIDENTIAL_PAGE_DATE);

  抛出：
    `application.exceptions.MacroRunException` - 当插入的条目常量不存在或为空
  另请参见：
    `insertAutoText(String,FontAttribute)`, `AutoTextConstants`

### insertAutoText

    public void insertAutoText(java.lang.String entryName,
                               FontAttribute fontAttribute)

  在当前区域起始位置处插入带有字体属性的自动图文集条目。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入自动图文集条目。

  参数：
    `entryName` - 需要插入的条目。只能取以下值之一：

              AutoTextConstants.PAGE                        "- 页码 -"
              AutoTextConstants.AUTHOR_PAGE_DATE            "作者名，页码和日期"
              AutoTextConstants.CONFIDENTIAL_PAGE_DATE      "机密，页码和日期"
              AutoTextConstants.CREATED_BY                  "创建者"
              AutoTextConstants.CREATED_ON                  "创建时间"
              AutoTextConstants.FILENAME                    "文件名称"
              AutoTextConstants.FILENAME_PATH               "文件名称和路径"
              AutoTextConstants.PRINT_TIME                  "最近打印时间"
              AutoTextConstants.PAGE_X_OF_Y                 "第 X 页共 Y 页"

    `fontAttribute` - 需要插入自动图文集条目的字体属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setFontSize(18);
         TextRange range = baseText.getRange(10,2);
         range.insertAutoText(AutoTextConstants.CONFIDENTIAL_PAGE_DATE,font);

  抛出：
    `application.exceptions.MacroRunException` - 当插入的条目常量不存在或为空
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `insertAutoText(String)`, `AutoTextConstants`

### insertHyperlink

    public void insertHyperlink(Hyperlink hyperlink)

  给当前区域设置超链接属性。

  参数：
    `hyperLink` - 超链接属性。

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,5);
         Hyperlink hyperlink = range.getHyperlink();
         hyperlink.setHyperlinkType(HyperlinkConstants.THIS_BINDER_POSITION);
         hyperlink.setShowText("this is a test!");
         hyperlink.hyperlinkToCell("工作表1!A1");
         range.insertHyperlink(hyperlink);

### insertNumber

    public void insertNumber(int number,
                             int type)

  在当前区域首位置插入指定样式的数字。

  参数：
    `number` - 具体插入的数字
    `type` - 插入数字的样式。只能取以下值之一：

              FieldConstants.DEFAULT      使用默认数字样式
              FieldConstants.Arabic       数字样式为“1,2,3,...”
              FieldConstants.alphabetic   数字样式为“a,b,c,...”
              FieldConstants.ALPHABETIC   数字样式为“A,B,C,...”
              FieldConstants.roman        数字样式为“i,ii,iii,...”
              FieldConstants.ROMAN        数字样式为“I,II,III,...”
              FieldConstants.ORDINAL      数字样式为“1st,2nd,3rd,...”
              FieldConstants.CARDTEXT     数字样式为“One,Two,Three,...”
              FieldConstants.ORDTEXT      数字样式为“First,Second,Third,...”
              FieldConstants.CHINESENUM3  数字样式为“一,二,三(简),...”
              FieldConstants.CHINESENUM2  数字样式为“壹,贰,叁 ,...”
              FieldConstants.ZODIAC1      数字样式为“(1),(2),(3),...”
              FieldConstants.ZODIAC2      数字样式为“①,②,③,...”
              FieldConstants.GB1          数字样式为“壹,贰,叁,...”
              FieldConstants.GB2          数字样式为“甲,乙,丙,...”
              FieldConstants.GB3          数字样式为“子,丑,寅,...”
              FieldConstants.GB4          数字样式为“[一],[二],[三],...”
              FieldConstants.ARABIC_DASH  数字样式为"- 1 -,- 2 -,- 3 -,…"
              FieldConstants.DBCHAR       数字样式为“全角,...”
              FieldConstants.SBCHAR       数字样式为“半角,...”
              FieldConstants.DBNUM1       数字样式为“一,二,三,...”
              FieldConstants.DBNUM2       数字样式为“一,十,百,...”
              FieldConstants.DBNUM3       数字样式为“壱,弐,参,...”
              FieldConstants.DBNUM4       数字样式为“一,二,三,万,...”
              FieldConstants.AIUEO        数字样式为“ア,...”
              FieldConstants.IROHA        数字样式为“イ,...”

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(10,5);
         range.insertNumber(5,FieldConstants.ZODIAC2);

  抛出：
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域

### insertNumber

    public void insertNumber(int number,
                             int type,
                             FontAttribute fontAttribute)

  在当前区域首位置插入指定样式指定字体格式的数字。

  参数：
    `number` - 具体插入的数字
    `fontAttribute` - 插入数字的指定字体格式
    `type` - 插入数字的样式。只能取以下值之一：

              FieldConstants.DEFAULT      使用默认数字样式
              FieldConstants.Arabic       数字样式为“1,2,3,...”
              FieldConstants.alphabetic   数字样式为“a,b,c,...”
              FieldConstants.ALPHABETIC   数字样式为“A,B,C,...”
              FieldConstants.roman        数字样式为“i,ii,iii,...”
              FieldConstants.ROMAN        数字样式为“I,II,III,...”
              FieldConstants.ORDINAL      数字样式为“1st,2nd,3rd,...”
              FieldConstants.CARDTEXT     数字样式为“One,Two,Three,...”
              FieldConstants.ORDTEXT      数字样式为“First,Second,Third,...”
              FieldConstants.CHINESENUM3  数字样式为“一,二,三(简),...”
              FieldConstants.CHINESENUM2  数字样式为“壹,贰,叁 ,...”
              FieldConstants.ZODIAC1      数字样式为“(1),(2),(3),...”
              FieldConstants.ZODIAC2      数字样式为“①,②,③,...”
              FieldConstants.GB1          数字样式为“壹,贰,叁,...”
              FieldConstants.GB2          数字样式为“甲,乙,丙,...”
              FieldConstants.GB3          数字样式为“子,丑,寅,...”
              FieldConstants.GB4          数字样式为“[一],[二],[三],...”
              FieldConstants.ARABIC_DASH  数字样式为"- 1 -,- 2 -,- 3 -,…"
              FieldConstants.DBCHAR       数字样式为“全角,...”
              FieldConstants.SBCHAR       数字样式为“半角,...”
              FieldConstants.DBNUM1       数字样式为“一,二,三,...”
              FieldConstants.DBNUM2       数字样式为“一,十,百,...”
              FieldConstants.DBNUM3       数字样式为“壱,弐,参,...”
              FieldConstants.DBNUM4       数字样式为“一,二,三,万,...”
              FieldConstants.AIUEO        数字样式为“ア,...”
              FieldConstants.IROHA        数字样式为“イ,...”

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         FontAttribute fontAttr = new FontAttribute();
         fontAttr.setFontSize(18.0);
         TextRange range = baseText.getRange(10,5);
         range.insertNumber(5,FieldConstants.ZODIAC2,fontAttr);

  抛出：
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域

### insertParagraph

    public void insertParagraph()

  在当前文本区域的首行位置插入换行符,此时光标到达下一行。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(6,1);
       range.insertParagraph();

### insertPicture

    public void insertPicture(java.lang.String filepath)

  在当前区域起始位置处插入默认大小的图片。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入图片。

  参数：
    `filepath` - 插入图片的文件路径（绝对路径）

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,0);
         range.insertPicture("d:\\sample.jpg");

  抛出：
    `application.exceptions.MacroRunException` - 当图片文件路径不存在
  另请参见：
    `insertPicture(String,float,float)`

### insertPicture

    public void insertPicture(java.lang.String filepath,
                              float width,
                              float height)

  在当前区域起始位置处插入指定大小的图片。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入图片。

  参数：
    `filepath` - 插入图片的文件路径（绝对路径）
    `width` - 插入图片的宽度(以磅为单位，取值返回为0～49994.08磅之间)
    `height` - 插入图片的高度(以磅为单位，取值返回为0～49994.08磅之间)

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(10,0);
         range.insertPicture("d:\\sample.jpg",200f,200f);

  抛出：
    `application.exceptions.MacroRunException` - 当图片文件不存在或为空
    `application.exceptions.MacroRunException` - 当图片宽度，高度小于0或大于49994.08
  另请参见：
    `insertPicture(String)`

### insertText

    public void insertText(java.lang.String text)

  在当前区域的起始位置插入字符串（插入属性为起始位置的输入属性）。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入字符串。

  参数：
    `text` - 需要插入的字符串

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"无锡永中科技有限公司");
         TextRange range = baseText.getRange(0,2);
         range.insertText("Test API");

  抛出：
    `application.exceptions.MacroRunException` - 当字符串为空
  另请参见：
    `insertText(String,FontAttribute)`

### insertText

    public void insertText(java.lang.String text,
                           FontAttribute fontAttribute)

  在当前区域的起始位置插入带有字体属性的字符串。

  参数：
    `text` - 需要插入的字符串
    `fontAttribute` - 插入字符串的字体属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setForeground(Color.red);
         baseText.insertText(0,"无锡永中科技有限公司");
         TextRange range = baseText.getRange(0,2);
         range.insertText("Test API",font);

  抛出：
    `application.exceptions.MacroRunException` - 当字符串为空
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `insertText(long,String)`, `FontAttribute`

### insertTime

    public void insertTime(java.lang.String type)

  在当前区域起始位置插入指定样式的时间域。

  参数：
    `type` - 插入时间域的类型。只能取以下值之一：

              DateTimeConstants.TIME_hh_mm         时间格式为“14:30”
              DateTimeConstants.TIME_h_mm_PM       时间格式为“2:30 PM”
              DateTimeConstants.TIME_hh_mm_ss      时间格式为“14:30:00”
              DateTimeConstants.TIME_h_mm_ss_PM    时间格式为“2:30:00 PM”
              DateTimeConstants.TIME_HH_MM         时间格式为“14时30分”
              DateTimeConstants.TIME_HH_MM_SS      时间格式为“14时30分00秒”
              DateTimeConstants.TIME_PM_H_M        时间格式为“下午2时30分”
              DateTimeConstants.TIME_PM_H_MM_SS    时间格式为“下午2时30分00秒”
              DateTimeConstants.TIME_HHHH_MMMM     时间格式为“十四时三十分”
              DateTimeConstants.TIME_PM_HH_MMMM    时间格式为“下午二时三十分”

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,0);
         range.insertTime(DateTimeConstants.TIME_HH_MM);

### insertTime

    public void insertTime(java.lang.String type,
                           boolean update,
                           boolean isSBC,
                           FontAttribute fontAttribute)

  在当前区域起始位置插入指定样式的时间域。

  参数：
    `type` - 插入时间域的类型。只能取以下值之一：

              DateTimeConstants.TIME_hh_mm         时间格式为“14:30”
              DateTimeConstants.TIME_h_mm_PM       时间格式为“2:30 PM”
              DateTimeConstants.TIME_hh_mm_ss      时间格式为“14:30:00”
              DateTimeConstants.TIME_h_mm_ss_PM    时间格式为“2:30:00 PM”
              DateTimeConstants.TIME_HH_MM         时间格式为“14时30分”
              DateTimeConstants.TIME_HH_MM_SS      时间格式为“14时30分00秒”
              DateTimeConstants.TIME_PM_H_M        时间格式为“下午2时30分”
              DateTimeConstants.TIME_PM_H_MM_SS    时间格式为“下午2时30分00秒”
              DateTimeConstants.TIME_HHHH_MMMM     时间格式为“十四时三十分”
              DateTimeConstants.TIME_PM_HH_MMMM    时间格式为“下午二时三十分”

    `update` - 布尔型值，是否更新域。如果为true，则更新域；否则，不更新域
    `isSBC` - 是否是全角字符,当update为false时才可用

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,0);
         FontAttribute fontAttr = new FontAttribute();
         fontAttr.setFontSize(18.0);
         range.insertTime(DateTimeConstants.TIME_HH_MM,true,false,fontAttr);

  抛出：
    `application.exceptions.MacroRunException` - 当offset小于0或大于文档长度

### insertVideo

    public void insertVideo(java.lang.String filepath)

  在当前区域起始位置处插入默认大小的影像文件。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入影像。

  参数：
    `filepath` - 插入影像文件的文件路径（绝对路径）

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,2);
         range.insertVideo("d:\\vedio.avi");

  抛出：
    `application.exceptions.MacroRunException` - 当影像文件路径不存在
  另请参见：
    `insertVideo(String,float,float)`

### insertVideo

    public void insertVideo(java.lang.String filepath,
                            float width,
                            float height)

  在当前区域起始位置处插入指定大小的影像文件。 说明：如果如果区域已被选中（可以是界面上的操作，也可能是调用了Range的select方法），则删除选中内容再插入影像。

  参数：
    `filepath` - 插入影像文件的文件路径（绝对路径）
    `width` - 插入影像文件的宽度(以磅为单位，取值返回为0～49994.08磅之间)
    `height` - 插入影像文件的高度(以磅为单位，取值返回为0～49994.08磅之间)

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(6,2);
         range.insertVideo("d:\\vedio.avi",100f,100f);

  抛出：
    `application.exceptions.MacroRunException` - 当影像文件路径不存在
    `application.exceptions.MacroRunException` - 当影像文件图标宽度，高度小于0或大于49994.08
  另请参见：
    `insertVideo(String)`

### moveEnd

    public TextRange moveEnd(long offset)

  重新定义指定文本区域。说明：这个方法是将原文本区域的结束位置偏移到新的文档位置中。

  参数：
    `offset` - 偏移量
  返回：
    返回新文本区域

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,4);
         range = range.moveEnd(10);
         System.out.println("返回新指定文本区域的内容："+range.getText());

### moveStart

    public TextRange moveStart(long offset)

  重新定义指定文本区域。说明：这个方法是将原文本区域的起始位置偏移到新的文档位置中。

  参数：
    `offset` - 偏移量
  返回：
    返回新文本区域

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,4);
         range = range.moveStart(10);
         System.out.println("返回新指定文本区域的内容："+range.getText());

### moveTo

    public TextRange moveTo(long offset,
                            long length)

  重新定义指定文本区域。

  参数：
    `offset` - 移动区域的偏移量（从原文本区域的起始位置开始算起）
    `length` - 新文本区域的长度
  返回：
    返回重新定义的文本区域

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         TextRange range = baseText.getRange(2,4);
         range = range.moveTo(10,5);
         System.out.println("返回新指定文本区域的内容："+range.getText());

### paste

    public void paste()

  在指定位置粘贴并替换指定长度的文本（包括图像，域，多媒体等对象）。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(2,4);
       range.copy();
       range = range.moveTo(10,0)
       range.paste();

### pasteFormat

    public void pasteFormat()

  对当前区域的内容应用剪贴板的格式。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       FontAttribute fontAttr = new FontAttribute();
       fontAttr.setForeground(java.awt.Color.red);
       baseText.setFontAttribute(2,6,fontAttr);
       TextRange range = baseText.getRange(2,6);
       range.copyFormat();
       range = range.moveStart(5);
       range.pasteFormat();

### select

    public void select()

  选中当前区域的文本。

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       TextRange range = baseText.getRange(2,10);
       range.select();

### setBorderAttribute

    public void setBorderAttribute(BorderAttribute borderAttribute)

  对当前区域格式化边框。

  参数：
    `borderAttribute` - 要设置的边框属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         BorderAttribute borderAttr = new BorderAttribute();
         borderAttr.setBorderType(BorderAndShadingConstants.BORDERTYPE_SHADOW);
         borderAttr.setBorderLineType(BorderAndShadingConstants.TOP,1);
         borderAttr.setBorderLineType(BorderAndShadingConstants.LEFT,3);
         borderAttr.setBorderLineType(BorderAndShadingConstants.RIGHT,6);
         borderAttr.setBorderLineType(BorderAndShadingConstants.BOTTOM,8);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.TOP,Color.RED);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.LEFT,Color.CYAN);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.RIGHT,Color.YELLOW);
         borderAttr.setBorderLineColor(BorderAndShadingConstants.BOTTOM,Color.ORANGE);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.TOP,8f);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.LEFT,5f);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.RIGHT,3f);
         borderAttr.setBorderLineWidth(BorderAndShadingConstants.BOTTOM,1f);
         TextRange range = baseText.getRange(5,20);
         range.setBorderAttribute(borderAttr);

  抛出：
    `application.exceptions.MacroRunException` - 当边框属性为空
  另请参见：
    `BorderAttribute`

### setBulletedNumber

    public void setBulletedNumber(WordBulletLevel wordBulletLevel,
                                  boolean isContinue)

  应用项目符号或编号列表到当前选择区域。

  参数：
    `wordBulletLevel` - 列表对象，此对象的列表类型必须为项目符号或编号
    `isContinue` - 布尔型值，是否继续。如果为true，在对话盒中选择的是继续；如果为false，则选择重新开始

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         WordBulletLevel bullet = doc.getWordBulletLevel(BulletNumberConstants.LIST_BULLET,2);
         TextRange range = baseText.getRange(2,20);
         range.setBulletedNumber(bullet,true);

  抛出：
    `application.exceptions.MacroRunException` - 当列表对象为空或列表类型不是项目符号或编号
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `WordBulletLevel`

### setBulletedNumber

    public void setBulletedNumber(WordBulletLevel wordBulletLevel,
                                  boolean isContinue,
                                  int applyTo)

  应用项目符号和编号列表到当前选择区域。

  参数：
    `wordBulletLevel` - 列表对象，此对象的列表类型必须为项目符号或编号
    `isContinue` - 布尔型值，是否继续。如果为true，在对话盒中选择的是继续；如果为false，则选择重新开始
    `applyTo` - 列表应用范围，只能取以下值之一：

         BulletNumberConstants.APPLY_TO_WHOLE_LIST = 0     整个列表
         BulletNumberConstants.APPLY_TO_AFTER_INSERT = 1   插入点之后
         ABulletNumberConstants.PPLY_TO_SELECTED_RANGE = 2 所选文字/当前段

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         WordBulletLevel bullet = doc.getWordBulletLevel(BulletNumberConstants.LIST_BULLET,2);
         TextRange range = baseText.getRange(2,20);
         range.setBulletedNumber(bullet,true,BulletNumberConstants.APPLY_TO_WHOLE_LIST);

  抛出：
    `application.exceptions.MacroRunException` - 当列表对象为空或列表类型不是项目符号或编号
    `application.exceptions.MacroRunException` - 当列表应用范围的常量不存在
  另请参见：
    `WordBulletLevel`

### setFontAttribute

    public void setFontAttribute(FontAttribute fontAttribute)

  对当前区域的字符串进行格式化。

  参数：
    `fontAttribute` - 格式化字符的字体属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setForeground(Color.red);
         TextRange range = baseText.getRange(5，10);
         range.setFontAttribute(font);

  抛出：
    `application.exceptions.MacroRunException` - 当字体属性为空
  另请参见：
    `FontAttribute`

### setOutlinedNumber

    public void setOutlinedNumber(WordBulletLevel[] bulletLevelArray,
                                  boolean isContinue)

  应用多级编号列表到当前选择区域。

  参数：
    `bulletLevelArray[]` - 多级编号列表对象，用数组表示，其中数组中的每一项表示多级编号对象中每一级的编号信息
    `isContinue` - 布尔型值，是否继续。如果为true，在对话盒中选择的是继续；如果为false，则选择重新开始

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         WordBulletLevel[] levels = baseText.getBulletLevelArray(3);
         TextRange range = baseText.getRange(5,5);
         range.setOutlinedNumber(levels,true);

  抛出：
    `application.exceptions.MacroRunException` - 当列表对象数组为空或数组项为空或其列表类型不是多级编号
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `WordBulletLevel`

### setParagraphAttribute

    public void setParagraphAttribute(ParagraphAttribute paragraphAttribute)

  对当前区域的字符串进行段落格式化。

  参数：
    `paragraphAttribute` - 格式化字符的段落属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         ParagraphAttribute paraAttr = new ParagraphAttribute();
         paraAttr.setAlignment(ParagraphConstants.ALIGNMENT_CENTER);
         TextRange range = baseText.getRange(5,15);
         range.setParagraphAttribute(paraAttr);

  抛出：
    `application.exceptions.MacroRunException` - 当段落属性为空
  另请参见：
    `ParagraphAttribute`

### setShadingAttribute

    public void setShadingAttribute(ShadingAttribute shadingAttribute)

  对当前区域格式化文字底纹。

  参数：
    `shadingAttribute` - 要设置的底纹属性

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         ShadingAttribute shadingAttr = new ShadingAttribute();
         shadingAttr.setTextureIndex(15);
         TextRange range = baseText.getRange(2,10);
         range.setShadingAttribute(shadingAttr);

  抛出：
    `application.exceptions.MacroRunException` - 当底纹属性为空
  另请参见：
    `ShadingAttribute`

### tcscConverter

    public void tcscConverter(boolean sctc)

  对当前区域的字符串进行简繁体转换。

  参数：
    `sctc` - 布尔型值，如果为true，则表示简体转换到繁体；否则，表示繁体转换到简体

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"中华人民共和国");
         TextRange range = baseText.getRange(0,6);
         range.tcscConverter(true);

### updateField

    public void updateField()

  更新当前区域内的所有域。

  例子：

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       final BaseText baseText = section.getBaseText();
       baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
       Fields fields = doc.getFields();
       fields.insert(5,baseText,FieldConstants.FIELDTYPE_CREATE_DATE,"CREATEDATE \\@ \"HH:mm:ss\" \\* MERGEFORMAT ");
       TextRange range = baseText.getRange(0,30);
       javax.swing.Timer timer = new javax.swing.Timer(1000,new ActionListener(){
           void actionPerformed(ActionEvent e)
           {
               range.updateField();
           }
       });
       timer.start();

  抛出：
    `application.exceptions.MacroRunException` - 当指定区域中存在保护区域

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

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