NamedRange.Replace Method

Article
06/14/2013

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

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

Syntax

'Declaration
Function Replace ( _
    What As Object, _
    Replacement As Object, _
    LookAt As Object, _
    SearchOrder As Object, _
    MatchCase As Object, _
    MatchByte As Object, _
    SearchFormat As Object, _
    ReplaceFormat As Object _
) As Boolean

bool Replace(
    Object What,
    Object Replacement,
    Object LookAt,
    Object SearchOrder,
    Object MatchCase,
    Object MatchByte,
    Object SearchFormat,
    Object ReplaceFormat
)

Parameters

What
Type: System.Object

The string you want Microsoft Office Excel to search for.

Replacement
Type: System.Object

The replacement string.

LookAt
Type: System.Object

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

SearchOrder
Type: System.Object

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

MatchCase
Type: System.Object

true to make the search case sensitive.

MatchByte
Type: System.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
Type: System.Object

The search format for the method.

ReplaceFormat
Type: System.Object

The replace format for the method.

Return Value

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

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.

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

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);
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via