NamedRange.Replace Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.Excel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Replaces the specified characters in the NamedRange control with a new string.

public bool Replace (object What, object Replacement, object LookAt, object SearchOrder, object MatchCase, object MatchByte, object SearchFormat, object ReplaceFormat);

abstract member Replace : obj * obj * obj * obj * obj * obj * obj * obj -> bool

Public Function Replace (What As Object, Replacement As Object, Optional LookAt As Object, Optional SearchOrder As Object, Optional MatchCase As Object, Optional MatchByte As Object, Optional SearchFormat As Object, Optional ReplaceFormat As Object) As Boolean

Parameters

What: Object

The string you want Microsoft Office Excel to search for.

Replacement: Object

The replacement string.

LookAt: Object

Can be one of the following XlLookAt constants: xlWhole or xlPart.

SearchOrder: Object

Can be one of the following XlSearchOrder constants: xlByRows or xlByColumns.

MatchCase: Object

true to make the search case sensitive.

MatchByte: Object

You can use this argument only if you have selected or installed double-byte language support in Excel. true to have double-byte characters match only double-byte characters; false to have double-byte characters match their single-byte equivalents.

SearchFormat: Object

The search format for the method.

ReplaceFormat: Object

The replace format for the method.

Returns

Boolean

true if the specified characters are in cells within the NamedRange control; otherwise, false.

Examples

The following code example sets the value of the cells in a NamedRange control to the string "This is a sentence.", and then uses the Replace method to replace the substring "a" with "my".

This example is for a document-level customization.

private void ReplaceValue()
{
    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A1"],
        "namedRange1");

    namedRange1.Value2 = "This is a sentence.";
    namedRange1.Replace("a", "my", Excel.XlLookAt.xlPart,
        Excel.XlSearchOrder.xlByColumns, false);
}

Private Sub ReplaceValue()
    Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange _
        = Me.Controls.AddNamedRange(Me.Range("A1"), _
        "namedRange1")

    namedRange1.Value2 = "This is a sentence."
    namedRange1.Replace("a", "my", Excel.XlLookAt.xlPart, _
        Excel.XlSearchOrder.xlByColumns, False, , , )
End Sub

Remarks

Using this method does not change either the selection or the active cell.

The settings for LookAt, SearchOrder, MatchCase, and MatchByte are saved each time you use this method. If you do not specify values for these arguments the next time you call the method, the saved values are used. Setting these arguments changes the settings in the Find dialog box, and changing the settings in the Find dialog box changes the saved values that are used if you omit the arguments. To avoid problems, set these arguments explicitly each time you use this method.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to

Aracılığıyla paylaş