com.aspose.words
Class Range

java.lang.Object
    com.aspose.words.Range

public class Range 
extends java.lang.Object

public java.lang.String getText()

Gets the text of the range.

The returned string includes all control and special characters as described in ControlChar.

public FormFieldCollection getFormFields()

Returns a FormFields collection that represents all form fields in the range.

public BookmarkCollection getBookmarks()

Returns a Bookmarks collection that represents all bookmarks in the range.

public void delete()
           throws java.lang.Exception

Deletes all characters of the range.

Example:

Shows how to delete a section from a Word document.

// Open Word document.
Document doc = new Document(getMyDir() + "Range.DeleteSection.doc");

// The document contains two sections. Each section has a paragraph of text.
Assert.assertEquals("Hello1\u000cHello2\u000c", doc.getText());

// Delete the first section from the document.
doc.getSections().get(0).getRange().delete();

// Check the first section was deleted by looking at the text of the whole document again.
Assert.assertEquals("Hello2\u000c", doc.getText());

public int replace(java.lang.String oldValue, java.lang.String newValue, boolean isMatchCase, boolean isMatchWholeWord)
           throws java.lang.Exception

Replaces all occurrences of a specified string with another string.

An exception is thrown if a captured or replacement string contain one or more special characters: paragraph break, cell break, section break, field start, field separator, field end, inline picture, drawing object, footnote.

Parameters:

oldValue - A string to be replaced.

newValue - A string to replace all occurrences of oldValue.

isMatchCase - True indicates case-sensitive comparison, false indicates case-insensitive comparision.

isMatchWholeWord - True indicates the oldValue must be a standalone word.

Returns:

The number of replacements made.

Example:

Simple find and replace operation.

// Open the document.
Document doc = new Document(getMyDir() + "Range.ReplaceSimple.doc");

// Check the document contains what we are about to test.
Assert.assertEquals("Hello _CustomerName_,\r", doc.getFirstSection().getBody().getParagraphs().get(0).getText());

// Replace the text in the document.
doc.getRange().replace("_CustomerName_", "James Bond", false, false);

// Check the document contains the replaced text,
Assert.assertEquals("Hello James Bond,\r", doc.getFirstSection().getBody().getParagraphs().get(0).getText());

// Save the modified document.
doc.save(getMyDir() + "Range.SimpleReplace Out.doc");

public int replace(java.util.regex.Pattern pattern, java.lang.String replacement)
           throws java.lang.Exception

Replaces all occurrences of a character pattern specified by a regular expression with another string.

Replaces the whole match captured by the regular expression.

An exception is thrown if a captured or replacement string contain one or more special characters: paragraph break, cell break, section break, field start, field separator, field end, inline picture, drawing object, footnote.

Parameters:

pattern - A regular expression pattern used to find matches.

replacement - A string to replace all occurrences of oldValue.

Returns:

The number of replacements made.

public int replace(java.util.regex.Pattern pattern, ReplaceEvaluator evaluator, boolean isForward)
           throws java.lang.Exception

Finds all occurrences of a character pattern specified by a regular expression and calls a user defined replace evaluator method.

An exception is thrown if a captured or replacement string contain one or more special characters: paragraph break, cell break, section break, field start, field separator, field end, inline picture, drawing object, footnote.

Parameters:

pattern - A regular expression pattern used to find matches.

evaluator - The user-defined method which evaluates replacement at each step.

isForward - True to replace from the beginning of the range to the end.

Returns:

The number of replacements made.

Example:

Replaces text specified with regular expression with HTML.

public void ReplaceWithInsertHtml() throws Exception
{
    // Open the document.
    Document doc = new Document(getMyDir() + "Range.ReplaceSimple.doc");

    doc.getRange().replace(Pattern.compile("Hello"), new ReplaceWithHtmlEvaluator(), false);

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

private class ReplaceWithHtmlEvaluator implements ReplaceEvaluator
{
    /**
    * A user implemented ReplaceEvaluator.replace() method is called for each
    * match found during a replace operation.
    *
    * @return An enumerated value that specifies the action to be taken for the current match.
    */
    public int replace(Object sender, ReplaceEvaluatorArgs e) throws Exception
    {
        DocumentBuilder builder = new DocumentBuilder(e.getMatchNode().getDocument());
        builder.moveTo(e.getMatchNode());
        // Replace 'Hello' word in a document with a bold 'Hello'.
        builder.insertHtml("<b>Hello</b>");
        e.setReplacement("");
        return ReplaceAction.REPLACE;
    }
}

public void updateFields()
                 throws java.lang.Exception

Updates the values of document fields in this range. Not all field types are updated.

At the moment updates the results of DOCPROPERTY and DOCVARIABLE fields only.

---

 Search within this product

Got a question? We guarantee a prompt response to any inquiry!

© 2008 Aspose Pty Ltd. All rights reserved.