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

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

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

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

    public class FindReplace

extends java.lang.Object

查找替换。

方法摘要
`void` | `clear()` 清除查找替换的格式，即初始化查找替换格式。
`int` | `getFindDirect()` 判断文本查找的方式。
`FontAttribute` | `getFontAttribute()` 获取查找或替换文本的字体格式。
`boolean` | `getFormat()` 判断查找或替换的文本是否设置了格式（包括字体格式，段落格式或样式等）。
`int` | `getHighlight()` 获取查找或替换文本匹配时是否高亮显示匹配区域。
`boolean` | `getMatchCase()` 判断查找过程中是否区分大小写。
`boolean` | `getMatchWholeWord()` 判断查找过程中查找的单词是否需要完全匹配。
`boolean` | `getMatchWildcards()` 判断查找过程中查找的单词是否可以使用通配符。
`ParagraphAttribute` | `getParagraphAttribute()` 获取查找或替换文本的段落格式。
`Replacement` | `getReplacement()` 获取替换文本时的替换文本属性。
`java.lang.String` | `getStyle()` 获取查找或替换文本的样式。
`FindTabStops` | `getTabStops()` 获取查找或替换文本时的制表位集合。
`java.lang.String` | `getText()` 获取要查找的内容。
`boolean` | `isMatchByte()` 判断是否区分全角和半角
`void` | `setFindDirect(int findDirect)` 设置文本查找的方式。
`void` | `setFontAttribute(FontAttribute fontAttribute)` 设置查找或替换文本的字体格式。
`void` | `setHighlight(int highlightType)` 设置查找或替换文本匹配时是否高亮显示匹配区域。
`void` | `setMatchByte(boolean matchByte)` 区分全角和半角
`void` | `setMatchCase(boolean matchCase)` 设置查找过程中是否区分大小写。
`void` | `setMatchWholeWord(boolean matchWholeWord)` 设置查找过程中查找的单词是否完全匹配。
`void` | `setMatchWildcards(boolean matchWildcards)` 设置查找过程中查找的单词是否可以使用通配符。
`void` | `setParagraphAttribute(ParagraphAttribute paragraphAttribute)` 设置查找或替换文本的段落格式。
`void` | `setReplacement(Replacement replacement)` 设置替换文本时的替换文本属性。
`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`

方法详细信息

### clear

    public void clear()

  清除查找替换的格式，即初始化查找替换格式。

  例子:

       //请输入一些文字
       Document doc = Application.getWorkbooks().getActiveDocument();
       FindReplace  finding = new FindReplace();
       finding.setText("永中OFFICE");
       finding.setFindWrap(2);
       System.out.println("清除格式前，text = " + finding.getText());
       System.out.println("清除格式前，findWrap = " + finding.getFindWrap());
       finding.clear();
       System.out.println("清除格式后，text = " + finding.getText());
       System.out.println("清除格式后，findWrap = " + finding.getFindWrap());

  另请参见：
    `setText(String)`

### getFindDirect

    public int getFindDirect()

  判断文本查找的方式。 （注：要查找就必须创建FindReplace对象。）

  返回：
    文本查找的方式，只能取以下值之一：

         FindConstants.FORWARD    表示查找的方式为向下查找
         FindConstants.BACKWARD   表示查找方式为向上查找
         FindConstants.ALL        表示查找方式为全部查找

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setFindDirect(FindConstants.FORWARD);
         baseText.find(finding);
         int findDirect = finding.getFindDirect();
         System.out.println("文本查找的方式为:" + findDirect);

  另请参见：
    `setFindDirect(int)`, `clear()`

### getFontAttribute

    public FontAttribute getFontAttribute()

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

  返回：
    查找或替换文本的字体格式

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setFontSize(14);
         finding.setFont(font);
         finding.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);
         FontAttribute findingFont = finding.getFont();
         System.out.println("查找或替换文本是否为粗体：" + findingFont.isBold());
         System.out.println("查找或替换文本的字体大小为：" + findingFont.getFontSize());

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

### 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");
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setFontSize(14);
         finding.setFont(font);
         finding.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);
         boolean isFormat = finding.getFormat();
         System.out.println("查找或替换的文本是否设置了格式：" + isFormat);

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

### getHighlight

    public int getHighlight()

  获取查找或替换文本匹配时是否高亮显示匹配区域。

  返回：
    查找或替换文本匹配时匹配区域的显示方式，只能取以下三种值：

              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);
         finding.setFormat(true);
         finding.setHighlight(1);
         baseText.find(finding);
         int highlight = finding.getHighlight();
         System.out.println("查找或替换文本匹配时匹配区域的显示方式为：" + highlight);

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

### getMatchCase

    public boolean getMatchCase()

  判断查找过程中是否区分大小写。

  返回：
    布尔型值，如果查找过程中区分大小写，返回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 EIO");
         finding.setForward(true);
         finding.setMatchCase(true);
         baseText.find(finding);
         boolean isMatchCase = finding.getMatchCase();
         System.out.println("查找过程中是否区分大小写：" + isMatchCase);

  另请参见：
    `setMatchCase(boolean)`, `clear()`

### getMatchWholeWord

    public boolean getMatchWholeWord()

  判断查找过程中查找的单词是否需要完全匹配。

  返回：
    布尔型值，如果查找时整个单词匹配，返回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 EIO");
         finding.setForward(true);
         finding.setMatchWholeWord(true);
         baseText.find(finding);
         boolean isMatchWholeWord = finding.getMatchWholeWord();
         System.out.println("查找过程中查找的单词是否需要完全匹配：" + isMatchWholeWord);

  另请参见：
    `setMatchWholeWord(boolean)`, `clear()`

### getMatchWildcards

    public boolean getMatchWildcards()

  判断查找过程中查找的单词是否可以使用通配符。

  返回：
    布尔型值，如果查找过程中可以使用通配符，返回true；否则，返回false

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("*eio");
         finding.setForward(true);
         finding.setMatchWildcards(true);
         baseText.find(finding);
         boolean isMatchWildcards = finding.getMatchWildcards();
         System.out.println("查找过程中是否可以使用通配符：" + isMatchWildcards);

  另请参见：
    `setMatchWildcards(boolean)`, `clear()`

### getParagraphAttribute

    public ParagraphAttribute getParagraphAttribute()

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

  返回：
    查找或替换文本的段落格式

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         ParagraphAttribute paraAttribute = new ParagraphAttribute();
         paraAttribute.setAlignment(ParagraphConstants.ALIGNMENT_LEFT);
         paraAttribute.setLeftIndent(5.0f);
         finding.setParagraph(paraAttribute);
         finding.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);
         ParagraphAttribute  findingpara = finding.getParagraph();
         System.out.println("查找或替换文本的段落对齐方式为：" + findingpara.getAlignment());
         System.out.println("查找或替换文本的段落左缩进为：" + findingpara.getLeftIndent());

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

### getReplacement

    public Replacement getReplacement()

  获取替换文本时的替换文本属性。 (注：不仅可以把文本内容替换掉，还可以把文本属性（字体或段落格式或样式等）替换掉。)

  返回：
    替换文本时的替换文本属性

    例子:

         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);
         finding.setFormat(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("office");
         finding.setReplacement(replacement);
         baseText.replace(finding);
         Replacement replace = finding.getReplacement();
         System.out.println("替换文本为：" + replace.getText());
         System.out.println("替换文本是否粗体：" + replace.getFont().isBold());

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

### getStyle

    public java.lang.String getStyle()

  获取查找或替换文本的样式。

  返回：
    查找或替换文本的样式

    例子:

         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.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);
         String style = finding.getStyle();
         System.out.println("查找或替换文本的样式为：" + style);

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

### getTabStops

    public FindTabStops getTabStops()

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

  返回：
    查找或替换文本时的制表位集合

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         FindTabStop findTabStop1 = new FindTabStop(10.0f,TabStopConstants.LEFT,1);
         FindTabStop findTabStop2 = new FindTabStop(20.0f,TabStopConstants.CENTER,1);
         FindTabStops findTabStops = new FindTabStops();
         findTabStops.add(findTabStop1);
         findTabStops.add(findTabStop2);
         finding.setTabStops(findTabStops);
         finding.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);
         FindTabStops tabStops = finding.getTabStops();
         FindTabStop tabStop1 = tabStops.getTabStop(0);
         FindTabStop tabStop2 = tabStops.getTabStop(1);
         System.out.println("第一个查找制表符的段落对齐方式为：" + tabStop1.getAlignment());
         System.out.println("第二个查找制表符的前导符索引为：" + tabStop1.getLeader());

  另请参见：
    `setTabStops(FindTabStops)`, `setFormat(boolean)`, `clear()`, `FindTabStops`, `FindTabStop`

### getText

    public java.lang.String getText()

  获取要查找的内容。 (注：要查找就必须初始化FindReplace类。)

  返回：
    要查找的内容

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         baseText.find(finding);
         String findstr = find.getText();
         System.out.println("要查找的内容为：" + findstr);

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

### isMatchByte

    public boolean isMatchByte()

  判断是否区分全角和半角

  返回：
    是否区分全角和半角(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.setForward(true);
         finding.setFormat(true);
         System.out.println(finding.isMatchByte());

### setFindDirect

    public void setFindDirect(int findDirect)

  设置文本查找的方式。 (注：从当前位置向下查找完后会自动跳到文本首位置继续向下查找，而从当前位置向上查找完后，查找就此结束。 要查找就必须创建FindReplace对象。)

  参数：
    `findDirect` - 文本查找的方式，只能取以下值之一：

         FindConstants.FORWARD    表示查找的方式为向下查找
         FindConstants.BACKWARD   表示查找方式为向上查找
         FindConstants.ALL        表示查找方式为全部查找

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("永中OFFICE");
         finding.setFindDirect(FindConstants.FORWARD);
         baseText.find(finding);

  另请参见：
    `getFindDirect()`, `clear()`

### 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");
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setFontSize(14);
         finding.setFont(font);
         finding.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);

  另请参见：
    `setFormat(boolean)`, `clear()`, `setText(String)`, `setParagraph(ParagraphAttribute)`, `setStyle(String)`, `FontAttribute`

### 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);
         finding.setFormat(true);
         finding.setHighlight(1);
         baseText.find(finding);

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

### setMatchByte

    public void setMatchByte(boolean matchByte)

  区分全角和半角

  参数：
    `matchByte` - 区分全角和半角(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.setForward(true);
         finding.setFormat(true);
         finding.setMatchByte(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("office");
         finding.setReplacement(replacement);
         baseText.replace(finding);
         Replacement replace = finding.getReplacement();
         System.out.println("替换文本为：" + replace.getText());
         System.out.println("替换文本是否粗体：" + replace.getFont().isBold());

### setMatchCase

    public void setMatchCase(boolean matchCase)

  设置查找过程中是否区分大小写。

  参数：
    `matchCase` - 布尔型值，如为true，查找时区分大小写；否则，查找时不区分大小写

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("office EIO");
         finding.setForward(true);
         finding.setMatchCase(true);
         baseText.find(finding);

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

### setMatchWholeWord

    public void setMatchWholeWord(boolean matchWholeWord)

  设置查找过程中查找的单词是否完全匹配。

  参数：
    `matchWholeWord` - 布尔型值，如为true，查找时整个单词匹配；否则，查找时不整个单词匹配

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("office EIO");
         finding.setForward(true);
         finding.setMatchWholeWord(true);
         baseText.find(finding);

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

### setMatchWildcards

    public void setMatchWildcards(boolean matchWildcards)

  设置查找过程中查找的单词是否可以使用通配符。

  参数：
    `matchWildcards` - 布尔型值，如为true，查找过程中可以使用通配符；否则，查找过程中不使用通配符

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         finding.setText("*eio");
         finding.setForward(true);
         finding.setMatchWildcards(true);
         baseText.find(finding);

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

### 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");
         ParagraphAttribute paraAttribute = new ParagraphAttribute();
         paraAttribute.setAlignment(ParagraphConstants.ALIGNMENT_LEFT);
         paraAttribute.setLeftIndent(5.0f);
         finding.setParagraph(paraAttribute);
         finding.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);

  另请参见：
    `setFormat(boolean)`, `clear()`, `setText(String)`, `setFont(FontAttribute)`, `setStyle(String)`, `ParagraphAttribute`

### setReplacement

    public void setReplacement(Replacement replacement)

  设置替换文本时的替换文本属性。 (注：不仅可以把文本内容替换掉，还可以把文本属性（字体或段落格式或样式等）替换掉。)

  参数：
    `replacement` - 替换文本时的替换文本属性

    例子:

         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);
         finding.setFormat(true);
         Replacement replacement = new Replacement();
         replacement.clear();
         replacement.setText("office");
         finding.setReplacement(replacement);
         baseText.replace(finding);

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

### 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.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);

  另请参见：
    `getStyle()`, `setFormat(boolean)`, `clear()`, `setText(String)`, `setFont(FontAttribute)`, `setParagraph(ParagraphAttribute)`

### setTabStops

    public void setTabStops(FindTabStops findTabStops)

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

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

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FindReplace  finding = new FindReplace();
         finding.clear();
         FindTabStop findTabStop1 = new FindTabStop(10.0f,TabStopConstants.LEFT,1);
         FindTabStop findTabStop2 = new FindTabStop(20.0f,TabStopConstants.CENTER,1);
         FindTabStops findTabStops = new FindTabStops();
         findTabStops.add(findTabStop1);
         findTabStops.add(findTabStop2);
         finding.setTabStops(findTabStops);
         finding.setForward(true);
         finding.setFormat(true);
         baseText.find(finding);

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

### setText

    public void setText(java.lang.String findString)

  设置要查找的内容。 (注：要查找就必须初始化FindReplace类。)

  参数：
    `findString` - 需要查找的字符串

    例子:

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

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

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

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