com.aspose.words

Class ReplacingArgs

java.lang.Object

com.aspose.words.ReplacingArgs

public class ReplacingArgs
extends java.lang.Object

Provides data for a custom replace operation.

To learn more, visit the Find and Replace documentation article.

See Also:

IReplacingCallback, Range, Range.replace(java.lang.String, java.lang.String, com.aspose.words.FindReplaceOptions)

Method Summary

Modifier and Type	Method and Description
int	getGroupIndex() Identifies, by index, a captured group in the getMatch() that is to be replaced with the getReplacement() / setReplacement(java.lang.String) string.
java.util.regex.Matcher	getMatch() The Matcher resulting from a single regular expression match during a Replace.
Node	getMatchNode() Gets the node that contains the beginning of the match.
int	getMatchOffset() Gets the zero-based starting position of the match from the start of the node that contains the beginning of the match.
java.lang.String	getReplacement() Gets the replacement string.
void	setGroupIndex(int value) Identifies, by index, a captured group in the getMatch() that is to be replaced with the getReplacement() / setReplacement(java.lang.String) string.
void	setReplacement(java.lang.String value) Sets the replacement string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMatch

public java.util.regex.Matcher getMatch()

The 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.

Returns:

The corresponding Matcher value.

getMatchNode

public Node getMatchNode()

Gets the node that contains the beginning of the match.

Returns:

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.

Returns:

The zero-based starting position of the match from the start of the node that contains the beginning of the match.

getReplacement

public java.lang.String getReplacement()

Gets the replacement string.

Returns:

The replacement string.

setReplacement

public void setReplacement(java.lang.String value)

Sets the replacement string.

Parameters:

value - The replacement string.

getGroupIndex

public int getGroupIndex()

Identifies, by index, a captured group in the getMatch() that is to be replaced with the getReplacement() / setReplacement(java.lang.String) string.

Default is zero.

Returns:

The corresponding int value.

setGroupIndex

public void setGroupIndex(int value)

Identifies, by index, a captured group in the getMatch() that is to be replaced with the getReplacement() / setReplacement(java.lang.String) string.

Default is zero.

Parameters:

value - The corresponding int value.