Xceed Logo
Shop
Xceed Words for .NET v5.2 Documentation
Xceed.Document.NET Assembly / Xceed.Document.NET Namespace / ReplaceTextOptionsBase Class


In This Topic
    ReplaceTextOptionsBase Class
    In This Topic
    Base class containing all the options that are available when text is replaced in a Document.
    Object Model
    ReplaceTextOptionsBase ClassFormatting Class
    Syntax
    'Declaration
 

    Public MustInherit Class ReplaceTextOptionsBase 
    'Usage
 

    Dim instance As ReplaceTextOptionsBase
    public abstract class ReplaceTextOptionsBase
    Inheritance Hierarchy

    System.Object
       Xceed.Document.NET.ReplaceTextOptionsBase
          Xceed.Document.NET.FunctionReplaceTextOptions
          Xceed.Document.NET.MultipleReplaceTextOptionsBase
          Xceed.Document.NET.ObjectReplaceTextOptions
          Xceed.Document.NET.StringReplaceTextOptionsBase

    Public Properties
     NameDescription
    Public PropertyContainerLocationGets or sets the Container(s) that will be parsed when replacing text in a Document. The default value is All.  
    Public PropertyEndIndexGets or sets the index that pinpoints the location where the text search will end. The default value is -1.  
    Public PropertyFormattingToMatchGets or sets the formatting that the existing text must have in order to be replaced. The default value is null.  
    Public PropertyFormattingToMatchOptionsGets or sets how the existing formatting needs to be matched in order for the text replacement to occur. The default setting is SubsetMatch.  
    Public PropertyRegExOptionsGets or sets the options for the regular expression. The default setting is None.  
    Public PropertyRemoveEmptyParagraphGets or sets if empty Paragraphs should be removed once the text replacement is done. The default value is true.  
    Public PropertyStartIndexGets or sets the index that pinpoints the location where the text search will start. The default value is -1.  
    Public PropertyStopAfterOneReplacementGets or sets if the text search will be stopped once the first text replacement is completed. The default value is false.  
    Public PropertyTrackChangesGets or sets if the changes, in this case the text replacement, will be tracked. The default value is false.  
    Top
    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

    Reference

    ReplaceTextOptionsBase Members
    Xceed.Document.NET Namespace

    Send Feedback