com.aspose.words

Interface IReplacingCallback

  • public interface IReplacingCallback 

Implement this interface if you want to have your own custom method called during a find and replace operation.

Example:

Shows how to insert content of one document into another during a customized find and replace operation.
public void insertDocumentAtReplace() throws Exception
{
    Document mainDoc = new Document(getMyDir() + "InsertDocument1.doc");

    FindReplaceOptions options = new FindReplaceOptions();
    options.setDirection(FindReplaceDirection.BACKWARD);
    options.setReplacingCallback(new InsertDocumentAtReplaceHandler());

    mainDoc.getRange().replace(Pattern.compile("\\[MY_DOCUMENT\\]"), "", options);
    mainDoc.save(getMyDir() + "\\Artifacts\\InsertDocumentAtReplace.doc");
}

private class InsertDocumentAtReplaceHandler implements IReplacingCallback
{
    public int replacing(ReplacingArgs e) throws Exception
    {
        Document subDoc = new Document(getMyDir() + "InsertDocument2.doc");

        // Insert a document after the paragraph, containing the match text.
        Paragraph para = (Paragraph) e.getMatchNode().getParentNode();
        insertDocument(para, subDoc);

        // Remove the paragraph with the match text.
        para.remove();

        return ReplaceAction.SKIP;
    }
}

Example:

Replaces text specified with regular expression with HTML.
public void replaceWithInsertHtml() throws Exception
{
    // Open the document.
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.writeln("Hello <CustomerName>,");

    FindReplaceOptions options = new FindReplaceOptions();
    options.setReplacingCallback(new ReplaceWithHtmlEvaluator(options));

    doc.getRange().replace(Pattern.compile(" <CustomerName>,"), "", options);

    // Save the modified document.
    doc.save(getMyDir() + "\\Artifacts\\Range.ReplaceWithInsertHtml.doc");

}

private class ReplaceWithHtmlEvaluator implements IReplacingCallback
{
    ReplaceWithHtmlEvaluator(FindReplaceOptions options)
    {
        mOptions = options;
    }

    /**
     * NOTE: This is a simplistic method that will only work well when the match
     * starts at the beginning of a run.
     */
    public int replacing(ReplacingArgs e) throws Exception
    {
        DocumentBuilder builder = new DocumentBuilder((Document) e.getMatchNode().getDocument());
        builder.moveTo(e.getMatchNode());

        // Replace '<CustomerName>' text with a red bold name.
        builder.insertHtml("<b><font color='red'>James Bond, </font></b>");
        e.setReplacement("");

        return ReplaceAction.REPLACE;
    }

    private /*final*/ FindReplaceOptions mOptions;
}

Example:

Show changes for headers and footers order
Document doc = new Document(getMyDir() + "HeaderFooter.HeaderFooterOrder.docx");

    //Assert that we use special header and footer for the first page
    //The order for this: first header\footer, even header\footer, primary header\footer
    Section firstPageSection = doc.getFirstSection();
    Assert.assertEquals(firstPageSection.getPageSetup().getDifferentFirstPageHeaderFooter(), true);

    FindReplaceOptions options = new FindReplaceOptions();
    ReplaceLog logger = new ReplaceLog();
    options.setReplacingCallback(logger);

    doc.getRange().replace(Pattern.compile("(header|footer)"), "", options);

    Assert.assertEquals(logger.getText(), "First header\r\nFirst footer\r\nSecond header\r\nSecond footer\r\nThird header\r\n" + "Third footer\r\n");

    //Prepare our string builder for assert results without "DifferentFirstPageHeaderFooter"
    logger.clearText();

    //Remove special first page
    //The order for this: primary header, default header, primary footer, default footer, even header\footer
    firstPageSection.getPageSetup().setDifferentFirstPageHeaderFooter(false);

    doc.getRange().replace(Pattern.compile("(header|footer)"), "", options);
    Assert.assertEquals(logger.getText(), "Third header\r\nFirst header\r\nThird footer\r\nFirst footer\r\nSecond header\r\nSecond footer\r\n");
}

private static class ReplaceLog implements IReplacingCallback
{
    public /*ReplaceAction*/int replacing(ReplacingArgs e)
    {
        _textBuilder.append(e.getMatchNode().getText() + "\r\n");
        return ReplaceAction.SKIP;
    }

    void clearText()
    {
        _textBuilder.setLength(0);
    }

    String getText()
    {
        return _textBuilder.toString();
    }

    private /*final*/ StringBuilder _textBuilder = new StringBuilder();
}

Method Summary
abstract intreplacing(ReplacingArgs args)
A user defined method that is called during a replace operation for each match found just before a replace is made.
 

    • Method Detail

      • replacing

        public abstract int replacing(ReplacingArgs args)
                                   throws java.lang.Exception
        A user defined method that is called during a replace operation for each match found just before a replace is made.
        Returns:
        A ReplaceAction value. A ReplaceAction value that specifies the action to be taken for the current match.

        Example:

        Replaces text specified with regular expression with HTML.
        public void replaceWithInsertHtml() throws Exception
        {
            // Open the document.
            Document doc = new Document();
            DocumentBuilder builder = new DocumentBuilder(doc);
        
            builder.writeln("Hello <CustomerName>,");
        
            FindReplaceOptions options = new FindReplaceOptions();
            options.setReplacingCallback(new ReplaceWithHtmlEvaluator(options));
        
            doc.getRange().replace(Pattern.compile(" <CustomerName>,"), "", options);
        
            // Save the modified document.
            doc.save(getMyDir() + "\\Artifacts\\Range.ReplaceWithInsertHtml.doc");
        
        }
        
        private class ReplaceWithHtmlEvaluator implements IReplacingCallback
        {
            ReplaceWithHtmlEvaluator(FindReplaceOptions options)
            {
                mOptions = options;
            }
        
            /**
             * NOTE: This is a simplistic method that will only work well when the match
             * starts at the beginning of a run.
             */
            public int replacing(ReplacingArgs e) throws Exception
            {
                DocumentBuilder builder = new DocumentBuilder((Document) e.getMatchNode().getDocument());
                builder.moveTo(e.getMatchNode());
        
                // Replace '<CustomerName>' text with a red bold name.
                builder.insertHtml("<b><font color='red'>James Bond, </font></b>");
                e.setReplacement("");
        
                return ReplaceAction.REPLACE;
            }
        
            private /*final*/ FindReplaceOptions mOptions;
        }

        Example:

        Shows how to insert content of one document into another during a customized find and replace operation.
        public void insertDocumentAtReplace() throws Exception
        {
            Document mainDoc = new Document(getMyDir() + "InsertDocument1.doc");
        
            FindReplaceOptions options = new FindReplaceOptions();
            options.setDirection(FindReplaceDirection.BACKWARD);
            options.setReplacingCallback(new InsertDocumentAtReplaceHandler());
        
            mainDoc.getRange().replace(Pattern.compile("\\[MY_DOCUMENT\\]"), "", options);
            mainDoc.save(getMyDir() + "\\Artifacts\\InsertDocumentAtReplace.doc");
        }
        
        private class InsertDocumentAtReplaceHandler implements IReplacingCallback
        {
            public int replacing(ReplacingArgs e) throws Exception
            {
                Document subDoc = new Document(getMyDir() + "InsertDocument2.doc");
        
                // Insert a document after the paragraph, containing the match text.
                Paragraph para = (Paragraph) e.getMatchNode().getParentNode();
                insertDocument(para, subDoc);
        
                // Remove the paragraph with the match text.
                para.remove();
        
                return ReplaceAction.SKIP;
            }
        }