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


In This Topic
    StringReplaceTextOptions Class
    In This Topic
    Contains the options that are available when replacing a string with another string in a Document.
    Object Model
    StringReplaceTextOptions ClassFormatting ClassFormatting Class
    Syntax
    'Declaration
 

    Public Class StringReplaceTextOptions 
   Inherits StringReplaceTextOptionsBase
    'Usage
 

    Dim instance As StringReplaceTextOptions
    public class StringReplaceTextOptions : StringReplaceTextOptionsBase
    Remarks
    This class derives from ReplaceTextOptionsBase.
    Inheritance Hierarchy

    System.Object
       Xceed.Document.NET.ReplaceTextOptionsBase
          Xceed.Document.NET.StringReplaceTextOptionsBase
             Xceed.Document.NET.StringReplaceTextOptions

    Public Constructors
     NameDescription
    Public ConstructorStringReplaceTextOptions Constructor  
    Top
    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. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertyEndIndexGets or sets the index that pinpoints the location where the text search will end. The default value is -1. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertyEscapeRegExGets or sets if the text that will be replaced needs to be escaped (by using the Regex.Escape(String) method). The default setting is true. (Inherited from Xceed.Document.NET.StringReplaceTextOptionsBase)
    Public PropertyFormattingToMatchGets or sets the formatting that the existing text must have in order to be replaced. The default value is null. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    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. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertyNewFormattingGets or sets the Formatting that will be applied to the new text that will be inserted. The default value is null.  
    Public PropertyNewValueGets or sets the string that will replace all occurences of the SearchValue. The default value is null. (Inherited from Xceed.Document.NET.StringReplaceTextOptionsBase)
    Public PropertyRegExOptionsGets or sets the options for the regular expression. The default setting is None. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertyRemoveEmptyParagraphGets or sets if empty Paragraphs should be removed once the text replacement is done. The default value is true. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertySearchValueGets or sets the string that will be replaced by the NewValue. The default value is null. (Inherited from Xceed.Document.NET.StringReplaceTextOptionsBase)
    Public PropertyStartIndexGets or sets the index that pinpoints the location where the text search will start. The default value is -1. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertyStopAfterOneReplacementGets or sets if the text search will be stopped once the first text replacement is completed. The default value is false. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertyTrackChangesGets or sets if the changes, in this case the text replacement, will be tracked. The default value is false. (Inherited from Xceed.Document.NET.ReplaceTextOptionsBase)
    Public PropertyUseRegExSubstitutionsGets or sets if RegEx-like replacement should be performed (in other words, if the NewValue contains RegEx substitutions). The default setting is false. (Inherited from Xceed.Document.NET.StringReplaceTextOptionsBase)
    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

    StringReplaceTextOptions Members
    Xceed.Document.NET Namespace

    Send Feedback