com.aspose.words
Class ReplaceEvaluatorArgs

java.lang.Object
    extended by com.aspose.words.ReplaceEvaluatorArgs

public class ReplaceEvaluatorArgs 
extends java.lang.Object

Provides data for a custom replace operation.
See Also:
ReplaceEvaluator, Range, Range.replace(java.lang.String, java.lang.String, boolean, boolean)

Property Getters/Setters Summary
intgetGroupIndex()
voidsetGroupIndex(int value)
           Identifies, by index, a captured group in the Match that is to be replaced with the Replacement string.
java.lang.StringgetGroupName()
voidsetGroupName(java.lang.String value)
           Identifies, by name, a captured group in the Match that is to be replaced with the Replacement string.
java.util.regex.MatchergetMatch()
           The java.util.regex.Matcher resulting from a single regular expression match during a Replace.
NodegetMatchNode()
           Gets the node that contains the beginning of the match.
intgetMatchOffset()
           Gets the zero-based starting position of the match from the start of the node that contains the beginning of the match.
java.lang.StringgetReplacement()
voidsetReplacement(java.lang.String value)
           Gets or sets the replacement string.
 

Property Getters/Setters Detail

getMatch

public java.util.regex.Matcher getMatch()
The java.util.regex.Matcher resulting from a single regular expression match during a Replace.

Matcher.start() gets the zero-based starting position of the match from the start of the find and replace range.


getMatchNode

public Node getMatchNode()
Gets the node that contains the beginning of the match.

getMatchOffset

public int getMatchOffset()
Gets the zero-based starting position of the match from the start of the node that contains the beginning of the match.

getReplacement/setReplacement

public java.lang.String getReplacement() / public void setReplacement(java.lang.String value)
Gets or sets the replacement string.

getGroupName/setGroupName

public java.lang.String getGroupName() / public void setGroupName(java.lang.String value)
Identifies, by name, a captured group in the Match that is to be replaced with the Replacement string.

When group name is null, GroupIndex is used to identify the group.

Default is null.


getGroupIndex/setGroupIndex

public int getGroupIndex() / public void setGroupIndex(int value)
Identifies, by index, a captured group in the Match that is to be replaced with the Replacement string.

GroupIndex has effect only when GroupName is null.

Default is zero.


See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.