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

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

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

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

    public class Replacement

extends java.lang.Object

替换文本的方法。

构造函数摘要
`Replacement()` 默认构造器。

方法摘要
`void` | `clear()` 清除替换字符的格式，即初始化替换字符格式。
`FontAttribute` | `getFontAttribute()` 获取替换文本的字体格式。
`boolean` | `getFormat()` 获得替换的文本是否设置了格式(包括字体格式，段落格式或样式等)。
`int` | `getHighlight()` 返回替换文本匹配时是否高亮显示匹配区域。
`ParagraphAttribute` | `getParagraphAttribute()` 获取替换文本的段落格式。
`java.lang.String` | `getStyle()` 获取替换文本的样式。
`FindTabStops` | `getTabStops()` 获取替换文本时的制表位集合。
`java.lang.String` | `getText()` 获得要替换的内容。
`void` | `setFontAttribute(FontAttribute fontAttribute)` 设置替换文本的字体格式。
`void` | `setHighlight(int highlightType)` 设置替换文本匹配时是否高亮显示匹配区域。
`void` | `setParagraphAttribute(ParagraphAttribute paragraphAttribute)` 设置替换文本的段落格式。
`void` | `setStyle(java.lang.String styleName)` 设置替换文本的样式。
`void` | `setTabStops(FindTabStops findTabStops)` 设置替换文本时的制表位集合。
`void` | `setText(java.lang.String findString)` 设置要替换的内容。

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

构造函数详细信息

### Replacement

    public Replacement()

  默认构造器。

方法详细信息

### clear

    public void clear()

  清除替换字符的格式，即初始化替换字符格式。

  例子:

       //请输入一些文字
       Replacement replacement = new Replacement();
       replacement.clear();
       replacement.setText("microsoft");
       System.out.println("清除格式前，text = " + replacement.getText());
       replacement.clear();
       System.out.println("清除格式后，text = " + replacement.getText());

  另请参见：
    `setText(String)`

### getFontAttribute

    public FontAttribute getFontAttribute()

  获取替换文本的字体格式。

  返回：
    FontAttribute类，即替换文本的字体格式

    例子:

         FindReplace  finding = new FindReplace();
         finding.clear();
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setFontSize(14);
         replacement.setFont(font);
         finding.setReplacement(replacement);
         FontAttribute replaceFont = replacement.getFont();
         System.out.println("替换文本是否为粗体：" + replaceFont.isBold());
         System.out.println("替换文本的字体大小为：" + replaceFont.getFontSize());

  另请参见：
    `setFont(FontAttribute)`, `FontAttribute`, `FindReplace`

### getFormat

    public boolean getFormat()

  获得替换的文本是否设置了格式(包括字体格式，段落格式或样式等)。 注：替换时，只有查找替换文本与被查文本之间格式与文本内容都相同时才匹配。

  返回：
    布尔型值，是否设置替换文本的格式。如果设置替换的文本格式，则返回true；否则，返回false

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setFormat(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         FontAttribute font = new FontAttribute();
         font.setFontSize(14);
         replacement.setFont(font);
         replacement.setFormat(true);
         finding.setReplacement(replacement);
         baseText.replace(finding);
         boolean isFormat = replacement.getFormat();
         System.out.println("替换的文本是否设置了格式：" + isFormat);

  另请参见：
    `setFormat(boolean)`, `clear()`, `FindReplace`

### getHighlight

    public int getHighlight()

  返回替换文本匹配时是否高亮显示匹配区域。

  参数：
    `highlightType` - 替换文本匹配时匹配区域的显示方式，只能取以下三种：

              0      匹配区域采用非高亮显示；
              1      匹配区域采用高亮显示；
              2      匹配区域不考虑是否高亮显示

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setForward(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("Microsoft");
         replacement.setHighlight(1);
         finding.setReplacement(replacement);
         baseText.replace(finding);
         int isHighlight = replacement.getHighlight();
         System.out.println("替换文本匹配时是否高亮显示匹配区域：" + isHighlight);

  另请参见：
    `setHighlight(int)`, `clear()`, `FindReplace`

### getParagraphAttribute

    public ParagraphAttribute getParagraphAttribute()

  获取替换文本的段落格式。

  返回：
    ParagraphAttribute类，即替换文本的段落格式

    例子:

         FindReplace  finding = new FindReplace();
         finding.clear();
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         ParagraphAttribute paraAttribute = new ParagraphAttribute();
         paraAttribute.setAlignment(ParagraphConstants.ALIGNMENT_LEFT);
         paraAttribute.setLeftIndent(5.0f);
         replacement.setParagraph(paraAttribute);
         finding.setReplacement(replacement);
         ParagraphAttribute replacepara = replacement.getParagraph();
         System.out.println("替换文本的段落对齐方式为：" + replacepara.getAlignment());
         System.out.println("替换文本的段落左缩进为：" + replacepara.getLeftIndent());

  另请参见：
    `setParagraph(ParagraphAttribute)`, `ParagraphAttribute`, `FindReplace`

### getStyle

    public java.lang.String getStyle()

  获取替换文本的样式。

  返回：
    替换文本的样式

    例子:

         FindReplace  finding = new FindReplace();
         finding.clear();
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         replacement.setStyle("标题 2");
         finding.setReplacement(replacement);
         String style = replacement.getStyle();
         System.out.println("替换文本的样式为：" + style);

  另请参见：
    `setStyle(String)`, `FindReplace`

### getTabStops

    public FindTabStops getTabStops()

  获取替换文本时的制表位集合。

  返回：
    FindTabStops类，即替换文本时的制表位集合

    例子:

         FindTabStop findTabStop = new FindTabStop(10.0f,TabStopConstants.LEFT,1);
         FindTabStops findTabStops = new FindTabStops();
         findTabStops.add(findTabStop);
         Replacement replacement = new Replacement();
         replacement.setTabStops(findTabStops);
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setReplacement(replacement);
         finding.setFormat(true);
         FindTabStops tabStops = replacement.getTabStops();
         FindTabStop tabStop = tabStops.getTabStop(0);
         System.out.println("第一个查找制表符的段落对齐方式为：" + tabStop.getAlignment());

  另请参见：
    `setTabStops(FindTabStops)`, `FindTabStops`, `FindTabStop`, `FindReplace`

### getText

    public java.lang.String getText()

  获得要替换的内容。

  返回：
    需要替换的字符串

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.setText("永中OFFICE");
         finding.clear();
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         finding.setReplacement(replacement);
         baseText.replace(finding);
         String text = replacement.getText();
         System.out.println("需要替换的字符串为：" + text);

  另请参见：
    `setText(String)`, `clear()`, `FindReplace`

### setFontAttribute

    public void setFontAttribute(FontAttribute fontAttribute)

  设置替换文本的字体格式。

  参数：
    `fontAttribute` - 替换文本的字体格式

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setFormat(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setFontSize(14);
         replacement.setFont(font);
         finding.setReplacement(replacement);
         replacement.setFormat(true);
         finding.setReplacement(replacement);
         baseText.replace(finding);

  另请参见：
    `getFont()`, `setFormat(boolean)`, `clear()`, `FontAttribute`, `FindReplace`

### setHighlight

    public void setHighlight(int highlightType)

  设置替换文本匹配时是否高亮显示匹配区域。

  参数：
    `highlightType` - 替换文本匹配时匹配区域的显示方式，只能取以下三种：

              0      匹配区域采用非高亮显示；
              1      匹配区域采用高亮显示；
              2      匹配区域不考虑是否高亮显示

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setForward(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("Microsoft");
         replacement.setHighlight(1);
         replacement.setFormat(true);
         finding.setReplacement(replacement);
         baseText.replace(finding);

  另请参见：
    `getHighlight()`, `clear()`, `FindReplace`

### setParagraphAttribute

    public void setParagraphAttribute(ParagraphAttribute paragraphAttribute)

  设置替换文本的段落格式。

  参数：
    `paragraphAttribute` - 替换文本的段落格式

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setFormat(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         ParagraphAttribute paraAttribute = new ParagraphAttribute();
         paraAttribute.setAlignment(ParagraphConstants.ALIGNMENT_LEFT);
         paraAttribute.setLeftIndent(5.0f);
         replacement.setParagraph(paraAttribute);
         finding.setReplacement(replacement);
         replacement.setFormat(true);
         finding.setReplacement(replacement);
         baseText.replace(finding);

  另请参见：
    `getParagraph()`, `setFormat(boolean)`, `clear()`, `ParagraphAttribute`, `FindReplace`

### setStyle

    public void setStyle(java.lang.String styleName)

  设置替换文本的样式。

  参数：
    `styleName` - 替换文本的样式

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setStyle("标题 1");
         finding.setFormat(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         replacement.setStyle("标题 2");
         replacement.setFormat(true);
         finding.setReplacement(replacement);
         baseText.replace(finding);

  另请参见：
    `setStyle(String)`, `setFormat(boolean)`, `clear()`, `FindReplace`

### setTabStops

    public void setTabStops(FindTabStops findTabStops)

  设置替换文本时的制表位集合。

  参数：
    `findTabStops` - 替换文本时的制表位集合

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindTabStop findTabStop = new FindTabStop(10.0f,TabStopConstants.LEFT,1);
         FindTabStops findTabStops = new FindTabStops();
         findTabStops.add(findTabStop);
         Replacement replacement = new Replacement();
         replacement.setTabStops(findTabStops);
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setReplacement(replacement);
         finding.setFormat(true);
         baseText.replace(finding);

  另请参见：
    `getTabStops()`, `clear()`, `FindTabStops`, `FindTabStop`, `FindReplace`

### setText

    public void setText(java.lang.String findString)

  设置要替换的内容。

  参数：
    `findString` - 需要替换的字符串

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setFindWrap(1);
         finding.setText("永中OFFICE");
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("microsoft");
         finding.setReplacement(replacement);
         baseText.replace(finding);

  另请参见：
    `getText()`, `clear()`, `FindReplace`

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

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