Xceed Words for .NET v5.2 Documentation
Xceed.Document.NET Assembly / Xceed.Document.NET Namespace / Document Class / ReplaceText Method / ReplaceText(MultipleObjectReplaceTextOptions) Method
The options that will be used when replacing the SearchValues strings with NewValues DocumentElements.


In This Topic
    ReplaceText(MultipleObjectReplaceTextOptions) Method
    In This Topic
    Replaces all of the SearchValues strings with NewValues DocumentElements, using the options set via the replaceTextOptions parameter to do so.
    Syntax
    'Declaration
     
    
    Public Overloads Overrides Function ReplaceText( _
       ByVal replaceTextOptions As MultipleObjectReplaceTextOptions _
    ) As Boolean
    'Usage
     
    
    Dim instance As Document
    Dim replaceTextOptions As MultipleObjectReplaceTextOptions
    Dim value As Boolean
     
    value = instance.ReplaceText(replaceTextOptions)

    Parameters

    replaceTextOptions
    The options that will be used when replacing the SearchValues strings with NewValues DocumentElements.

    Return Value

    Returns true if at least one text replacement is done.
    Remarks
    Each SearchValue string will be replaced with its corresponding NewValue DocumentElement, using the established order to create a correspondence between the strings & the DocumentElements.
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also