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

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

## application.workbooks.workbook.documents.document.section
类 BaseText

    java.lang.Object
      application.workbooks.workbook.documents.document.section.AbstractText
          application.workbooks.workbook.documents.document.section.BaseText

    public class BaseText

extends AbstractText

该类表示一个正文对象，继承了AbstractText抽象类，定义了正文中常用的方法。

方法摘要
`EndNote` | `addEndNote(long offset, long length, int applyTo)` 在当前正文中插入一个尾注。
`EndNote` | `addEndNote(long offset, long length, java.lang.String customSymbol, java.lang.String fontName, int applyTo)` 在当前正文中插入一个自定义标记的尾注。
`FootNote` | `addFootNote(long offset, long length, int applyTo)` 在当前正文中插入一个脚注。
`FootNote` | `addFootNote(long offset, long length, java.lang.String customSymbol, java.lang.String fontName, int applyTo)` 在当前正文中插入一个自定义标记的脚注。
`void` | `autoFormat(long offset, long length)` 对指定位置指定长度的字符串执行自动格式化。
`void` | `createNewSummary(int type, int scale)` 把自动摘要放到一个新的文档中去。
`EndNoteOptions` | `getEndNoteOptions(long offset)` 得到正文指定位置处的尾注属性管理器。
`int` | `getEndOffset()` 返回正文在整个文档中的结束位置。
`FootNoteOptions` | `getFootNoteOptions(long offset)` 得到正文指定位置处的脚注属性管理器。
`Index` | `getIndex(long offset, long length)` 得到索引。
`IndexEntry` | `getIndexEntry(long offset, long length)` 得到标记索引项。
`long` | `getLength()` 返回正文部分的长度。
`int` | `getStartOffset()` 返回正文在整个文档中的起始位置。
`TableOfContent` | `getTableOfContent(long offset, long length)` 得到一个区域的第一个目录管理器（一个区域可能包含多个目录）。
`java.lang.String` | `getText(long offset, long length)` 返回当前章节指定范围的文本。
`void` | `gotoPosition(int type, int direction, int step, java.lang.String name)` 定位。
`void` | `insertChart()` 插入图表。
`void` | `insertIndex(long offset, Index index)` 在指定位置插入一个索引
`void` | `insertSummaryHead(int type, int scale)` 在文档头部插入自动文摘。
`void` | `insertTableOfContent(long offset, TableOfContent toc)` 在正文指定位置插入一个目录。
`void` | `markAllIndexEntry(IndexEntry indexEntry)` 标记全部索引项
`void` | `markIndexEntry(IndexEntry indexEntry)` 标记一个索引项
`void` | `pasteLink(long offset)` 实现粘贴链接功能,在执行此功能时是必须先执行复制操作，但是不能进行图片，自选图形等复制。
`void` | `pasteSpecial(long offset, int type, int format)` 选择性粘贴链接，在执行此功能时是必须先执行复制操作，但是不能进行图片，自选图形等复制。

从类 application.workbooks.workbook.documents.document.section.AbstractText 继承的方法
`changeCase, clearFormats, copy, copyFormat, cut, decreaseIndent, delete, deleteHyperlink, formatStyle, getBorderAttribute, getBulletLevel, getBulletLevelArray, getDefaultPhonetic, getFindReplace, getFontAttribute, getHyperlink, getOriginPosition, getPageIndex, getParagraph, getParagraphAttribute, getParagraphs, getParent, getRange, getRange, getShadingAttribute, getTextLength, highlight, increaseIndent, insertAudio, insertAudio, insertAutoText, insertAutoText, insertDate, insertHyperlink, insertNumber, insertNumber, insertParagraph, insertPicture, insertPicture, insertSymbol, insertSymbol, insertText, insertText, insertTime, insertVideo, insertVideo, paste, paste, pasteFormat, selectAll, setBorderAttribute, setBulletedNumber, setBulletedNumber, setFontAttribute, setFontAttribute, setOutlinedNumber, setParagraphAttribute, setParagraphAttribute, setPhoneticAttribute, setShadingAttribute, setTwoLinesInOne, tcscConverter, tcscConverter, updateField`

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

方法详细信息

### addEndNote

    public EndNote addEndNote(long offset,
                              long length,
                              int applyTo)

  在当前正文中插入一个尾注。 说明：插入尾注的类型为编号格式，编号格式索引根据EndNoteOptions属性集得到。

  参数：
    `offset` - 标记为当前插入尾注区域的起始位置
    `length` - 标记为当前插入尾注区域的长度
    `applyTo` - 将更改应用于，只能取以下值之一：

         NoteConstants.APPLY_TO_WHOLE = 0;    将更改应用于整篇文档
         NoteConstants.APPLY_TO_SECTION = 1;  将更改应用于本节
         NoteConstants.APPLY_TO_TEXT = 2;     将更改应用于所选文字

  返回：
    返回插入的尾注

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndoNoteOptions endnoteOptions = baseText.getEndNoteOptions(10);
         endnoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         EndNote endNote = baseText.addEndNote(10, 5, NoteConstants.APPLY_TO_WHOLE);
         endNote.insertText(0,"this is a endnote");

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
    `MacroRunException` - 当将更改应用于的类型常量不存在
  另请参见：
    `EndNote`, `EndNoteOptions`

### addEndNote

    public EndNote addEndNote(long offset,
                              long length,
                              java.lang.String customSymbol,
                              java.lang.String fontName,
                              int applyTo)

  在当前正文中插入一个自定义标记的尾注。

  参数：
    `offset` - 标记为当前插入尾注区域的起始位置
    `length` - 标记为当前插入尾注区域的长度
    `customSymbol` - 自定义标记 说明：如果参数为NULL，则插入编号格式类型的尾注，编号格式索引根据EndNoteOptions属性集得到。
    `fontName` - 自定义标记的字体属性名 说明：如果参数为NULL或字体名在系统中不存在，则取默认字体“永中宋体”
    `applyTo` - 将更改应用于，只能取以下值之一：

         NoteConstants.APPLY_TO_WHOLE = 0;    将更改应用于整篇文档
         NoteConstants.APPLY_TO_SECTION = 1;  将更改应用于本节
         NoteConstants.APPLY_TO_TEXT = 2;     将更改应用于所选文字

  返回：
    返回插入的尾注

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNote endNote = baseText.addEndNote(10, 5, "AB", "Forte", NoteConstants.APPLY_TO_WHOLE);
         endNote.insertText(0,"this is a endnote");

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
    `MacroRunException` - 当将更改应用于的类型常量不存在
  另请参见：
    `EndNote`

### addFootNote

    public FootNote addFootNote(long offset,
                                long length,
                                int applyTo)

  在当前正文中插入一个脚注。 说明：插入脚注的类型为编号格式，编号格式索引根据FootNoteOptions属性集得到。

  参数：
    `offset` - 标记为当前插入脚注区域的起始位置
    `length` - 标记为当前插入脚注区域的长度
    `applyTo` - 将更改应用于，只能取以下值之一：

         NoteConstants.APPLY_TO_WHOLE = 0;    将更改应用于整篇文档
         NoteConstants.APPLY_TO_SECTION = 1;  将更改应用于本节
         NoteConstants.APPLY_TO_TEXT = 2;     将更改应用于所选文字

  返回：
    返回插入的脚注

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         FootNoteOptions footnoteOptions = baseText.getFootNoteOptions(10);
         footnoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         FootNote footNote = baseText.addFootNote(10, 5, NoteConstants.APPLY_TO_WHOLE);
         footNote.insertText(0,"this is a footnote");

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
    `MacroRunException` - 当将更改应用于的类型常量不存在
  另请参见：
    `FootNote`, `FootNoteOptions`

### addFootNote

    public FootNote addFootNote(long offset,
                                long length,
                                java.lang.String customSymbol,
                                java.lang.String fontName,
                                int applyTo)

  在当前正文中插入一个自定义标记的脚注。

  参数：
    `offset` - 标记为当前插入脚注区域的起始位置
    `length` - 标记为当前插入脚注区域的长度
    `customSymbol` - 自定义标记 说明：如果参数为NULL，则插入编号格式类型的尾注，编号格式索引根据FootNoteOptions属性集得到。
    `fontName` - 自定义标记的字体属性名 说明：如果参数为NULL或字体名在系统中不存在，则取默认字体“永中宋体”
    `applyTo` - 将更改应用于，只能取以下值之一：

         NoteConstants.APPLY_TO_WHOLE = 0;    将更改应用于整篇文档
         NoteConstants.APPLY_TO_SECTION = 1;  将更改应用于本节
         NoteConstants.APPLY_TO_TEXT = 2;     将更改应用于所选文字

  返回：
    返回插入的脚注

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         FootNote footNote = baseText.addFootNote(10, 5, "AB", "Forte", NoteConstants.APPLY_TO_WHOLE);
         footNote.insertText(0,"this is a footnote");

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
    `MacroRunException` - 当将更改应用于的类型常量不存在
  另请参见：
    `FootNote`

### autoFormat

    public void autoFormat(long offset,
                           long length)

  对指定位置指定长度的字符串执行自动格式化。

  使用前可以先调用 application.workbooks.workbook.autotext.AutoFormat中的静态方法进行设置Flag

  覆盖：
    类 `AbstractText` 中的 `autoFormat`
  参数：
    `offset` - 需要格式化的字符串位置（起始位置为0）
    `length` - 需要格式化的字符串长度

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"1/2");
         AutoFormat.setReplaceFractionFlag(true);
         baseText.autoFormat(0,baseText.getTextLength());
         //请在文本末光标位置处按空格即可看见效果了

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `AutoFormat`

### createNewSummary

    public void createNewSummary(int type,
                                 int scale)

  把自动摘要放到一个新的文档中去。

  覆盖：
    类 `AbstractText` 中的 `createNewSummary`
  参数：
    `type` - 生成摘要的类型

    SummaryConstants.CREATE_BY_PERCENT 按百分比生成 SummaryConstants.CREATE_BY_SENTENCE 按句子的数目生成

    `scale` - 此值的含义由生成摘要的类型决定，可以有以下两种含义之一：

         如果摘要类型为SummaryConstants.CREATE_BY_PERCENT，此值表示摘要长度占文档总长的百分比（范围为0％～100％）
         如果摘要类型为SummaryConstants.CREATE_BY_SENTENCE，此值表示生成自动摘要的句子数（范围为0～原文档的句子总数）

    例子:

         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!\nthis is a test!\nthis is a test!");
         baseText.createNewSummary(SummaryConstants.CREATE_BY_PERCENT,20);

  抛出：
    `MacroRunException` - 当生成摘要类型不存在。
    `MacroRunException` - 当以百分比生成摘要，摘要内容占原文的比例超出规定范围
    `MacroRunException` - 当以句子数生成摘要，摘要内容的句子数超出原句总数
  另请参见：
    `insertSummaryHead(int, int)`, `SummaryConstants`

### getEndNoteOptions

    public EndNoteOptions getEndNoteOptions(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!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         endNoteOptions.setPosition(NoteConstants.BELLOW_WORD);
         baseText.addEndNote(10, 2);

  另请参见：
    `EndNoteOptions`, `EndNote`

### getEndOffset

    public int getEndOffset()

  返回正文在整个文档中的结束位置。

  返回：
    结束位置 例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         System.out.println("End offset is " + baseText.getEndOffset());

### getFootNoteOptions

    public FootNoteOptions getFootNoteOptions(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!\n this is a test!\n this is a test!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions(10);
         footNoteOptions.setPosition(NoteConstants.BELLOW_WORD);
         baseText.addFootNote(10, 2);

  另请参见：
    `FootNoteOptions`, `FootNote`

### getIndex

    public Index getIndex(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!\n this is a test!\n this is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(10,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `Index`, `IndexEntry`

### getIndexEntry

    public IndexEntry getIndexEntry(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!\n this is a test!\n this is a test!");
         IndexEntry entry1 = baseText.getIndexEntry(2,4);
         entry1.setMainEntry("索引项1");
         baseText.markIndexEntry(entry1);

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `IndexEntry`

### getLength

    public long getLength()

  返回正文部分的长度。

  指定者：
    类 `AbstractText` 中的 `getLength`
  返回：
    正文部分的长度

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test! this is a test");
         System.out.println("当前正文的长度是："+baseText.getLength());

### getStartOffset

    public int getStartOffset()

  返回正文在整个文档中的起始位置。

  返回：
    起始位置 例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         System.out.println("start offset is " + baseText.getStartOffset());

### getTableOfContent

    public TableOfContent getTableOfContent(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!\n this is a test!\n this is a test!");
          Styles styles = doc.getStyles();
          Style style1 = styles.getStyle("标题 1");
          Style style2 = styles.getStyle("标题 2");
          baseText.formatStyle(0, 15, style1);
          baseText.formatStyle(20, 5, style2);
          TableOfContent toc = baseText.getTableOfContent(0,10);
          baseText.insertTableOfContent(0,toc);

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当offset + length 大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `TableOfContent`

### getText

    public java.lang.String getText(long offset,
                                    long length)

  返回当前章节指定范围的文本。

  指定者：
    类 `AbstractText` 中的 `getText`
  参数：
    `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!\n this is a test!\n this is a test!");
         System.out.println("指定的文本为："+baseText.getText(2,6));

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度
    `MacroRunException` - 当offset + length 大于文档长度

### gotoPosition

    public void gotoPosition(int type,
                             int direction,
                             int step,
                             java.lang.String name)

  定位。

  参数：
    `type` - 需要定位的类型

         FindConstants.PAGE       表示 定位到页（参数name无效，设为""）
         FindConstants.SECTION    表示 定位到节（参数name无效，设为""）
         FindConstants.LINE       表示 定位到行（参数name无效，设为""）
         FindConstants.BOOKMARK   表示 定位到书签（参数name表示书签名）
         FindConstants.COMMENT    表示 定位到注释（参数name表示审阅者的姓名）
         FindConstants.FOOTNOTE   表示 定位到脚注（参数name无效，设为""）
         FindConstants.ENDNOTE    表示 定位到尾注（参数name无效，设为""）
         FindConstants.FIELD      表示 定位到域（参数name表示域名，可参考定位对话盒）
         FindConstants.TABLE      表示 定位到表格（参数name无效，设为""）
         FindConstants.GRAPHIC    表示 定位到图形（参数name无效，设为""）
         FindConstants.HEADING    表示 定位到标题（参数name无效，设为""）
         FindConstants.OBJECT     表示 定位到对象（参数name无效，设为""）
         FindConstants.CHART      表示 定位到图表（参数name无效，设为""）
         FindConstants.PASTELINK  表示 定位到粘贴链接（参数name无效，设为""）
         FindConstants.EQUATION   表示 定位到科教编辑器（参数name无效，设为""）
         ......

    `direction` - 需要定位的方向

         FindConstants.PREVIOUS      表示 定位到到前一个位置
         FindConstants.NEXT          表示 定位到下一个位置
         FindConstants.ABSOLUTE      表示 定位到绝对位置

    `step` - 需要定位的步长
    `name` - 需要定位的名称

         如果定位注释  name表示注释的作者
         如果定位书签  name表示书签的名字
         如果定位域   name表示域的类型 .例如 表示编辑时间域。name 需要有<>
         如果是其它域，那么 name设置无效，可以设置任何值

               例如 如果定位到 第10行
               gotoPosition(FindConstants.LINE,FindConstants.ABSOLUTE,10,"");
               如果在当前位置向前定位3行
               gotoPosition(FindConstants.LINE,FindConstants.PREVIOUS,3,"");
               如果在当前位置向后定位3行
               gotoPosition(FindConstants.LINE,FindConstants.NEXT,3,"");
               如果定位到名字为 bookMarkName 的书签上
               gotoPosition(FindConstants.BOOKMARK,0,0,"bookMarkName");

         例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         baseText.gotoPosition(FindConstants.LINE,FindConstants.ABSOLUTE,5,"");

  抛出：
    `MacroRunException` - 当需要定位的类型常量不存在
    `MacroRunException` - 当需要定位的方向常量不存在
    `MacroRunException` - 当需要定位的步长常量不存在
    `MacroRunException` - 当需要定位的名称为空，如果没有名称应该设为空字符串
  另请参见：
    `FindConstants`

### insertChart

    public void insertChart()

  插入图表。

  例子：

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       baseText.insertChart();

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

### insertIndex

    public void insertIndex(long offset,
                            Index index)

  在指定位置插入一个索引

  参数：
    `offset` - 指定位置
    `index` - 索引，可通过getIndex方法得到当前的索引

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当索引对象为空
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `Index`, `IndexEntry`

### insertSummaryHead

    public void insertSummaryHead(int type,
                                  int scale)

  在文档头部插入自动文摘。

  覆盖：
    类 `AbstractText` 中的 `insertSummaryHead`
  参数：
    `type` - 生成摘要的类型

    SummaryConstants.CREATE_BY_PERCENT 按百分比生成 SummaryConstants.CREATE_BY_SENTENCE 按句子的数目生成

    `scale` - 此值的含义由生成摘要的类型决定，可以有以下两种含义之一：

         如果摘要类型为SummaryConstants.CREATE_BY_PERCENT，此值表示摘要长度占文档总长的百分比（范围为0％～100％）
         如果摘要类型为SummaryConstants.CREATE_BY_SENTENCE，此值表示生成自动摘要的句子数（范围为0～原文档的句子总数）

    例子:

         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!\nthis is a test!\nthis is a test!");
         baseText.insertSummaryHead(SummaryConstants.CREATE_BY_PERCENT,20);

  抛出：
    `MacroRunException` - 当指定区域中存在保护区域
    `MacroRunException` - 当生成摘要类型不存在
    `MacroRunException` - 当以百分比生成摘要，摘要内容占原文的比例超出规定范围
    `MacroRunException` - 当以句子数生成摘要，摘要内容的句子数超出原句总数
  另请参见：
    `createNewSummary(int, int)`, `SummaryConstants`

### insertTableOfContent

    public void insertTableOfContent(long offset,
                                     TableOfContent toc)

  在正文指定位置插入一个目录。

  参数：
    `offset` - 指定位置
    `toc` - 目录管理器，可通过getTableOfContent方法得到当前的目录管理器

    例子：

          Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
          Section section = doc.getSection(0);
          BaseText baseText = section.getBaseText();
          baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
          Styles styles = doc.getStyles();
          Style style1 = styles.getStyle("标题 1");
          Style style2 = styles.getStyle("标题 2");
          baseText.formatStyle(0, 15, style1);
          baseText.formatStyle(20, 5, style2);
          TableOfContent toc = baseText.getTableOfContent(0,10);
          baseText.insertTableOfContent(0,toc);

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当目录管理器对象为空
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `TableOfContent`

### markAllIndexEntry

    public void markAllIndexEntry(IndexEntry indexEntry)

  标记全部索引项

  参数：
    `indexEntry` - 索引项，可通过getIndex方法得到当前的索引项

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         IndexEntry entry1 = baseText.getIndexEntry(2,4);
         entry1.setMainEntry("索引项1");
         IndexEntry entry2 = baseText.getIndexEntry(16,4);
         entry2.setMainEntry("索引项2");
         baseText.markAllIndexEntry(entry1);
         baseText.markAllIndexEntry(entry2);

  抛出：
    `MacroRunException` - 当索引项对象为空

### markIndexEntry

    public void markIndexEntry(IndexEntry indexEntry)

  标记一个索引项

  参数：
    `indexEntry` - 索引项，可通过getIndex方法得到当前的索引项

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         IndexEntry entry1 = baseText.getIndexEntry(2,4);
         entry1.setMainEntry("索引项1");
         baseText.markIndexEntry(entry1);

  抛出：
    `MacroRunException` - 当索引项对象为空

### pasteLink

    public void pasteLink(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! this is a test");
         baseText.copy(2,6);
         baseText.pasteLink(0);

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `PasteSpecialConstants`

### pasteSpecial

    public void pasteSpecial(long offset,
                             int type,
                             int format)

  选择性粘贴链接，在执行此功能时是必须先执行复制操作，但是不能进行图片，自选图形等复制。

  参数：
    `offset` - 光标位置
    `type` - 粘贴类型

         PasteSpecialConstants.PASTE_NORMAL          粘贴
         PasteSpecialConstants.PASTE_LINK            粘贴链接
         PasteSpecialConstants.PASTE_HYPERLINK       作为超级链接

    `format` - 粘贴格式

         PasteSpecialConstants.PASTE_PLAINTEXT       未格式化文本
         PasteSpecialConstants.PASTE_RICHTEXT        格式化文本
         PasteSpecialConstants.PASTE_SHEET           工作表对象
         PasteSpecialConstants.PASTE_SLIDE           幻灯片对象

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test! this is a test");
         FontAttribute fontAttr = new FontAttribute();
         fontAttr.setForeground(java.awt.Color.red);
         baseText.setFontAttribute(2,6,fontAttr);
         baseText.copy(2,6);
         baseText.pasteSpecial(0,PasteSpecialConstants.PASTE_LINK,PasteSpecialConstants.PASTE_RICHTEXT);

  抛出：
    `MacroRunException` - 当offset小于0或大于文档长度。
    `MacroRunException` - 粘贴类型的常量不存在
    `MacroRunException` - 粘贴格式的常量不存在
    `MacroRunException` - 当指定区域中存在保护区域
  另请参见：
    `PasteSpecialConstants`

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

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

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