Xceed Logo
Shop
Xceed Words for .NET v5.1 Documentation
Xceed.Document.NET Assembly / Xceed.Document.NET Namespace / ObjectReplaceTextOptions Class
Members


In This Topic
    ObjectReplaceTextOptions Class
    In This Topic

    Contains the options that are available when replacing a string with an object in a Document.

    Currently, the supported objects are Pictures, Tables and Hyperlinks.

    Syntax
    'Declaration
 
Public Class ObjectReplaceTextOptions 
   Inherits ReplaceTextOptionsBase
    'Usage
 
Dim instance As ObjectReplaceTextOptions
    public class ObjectReplaceTextOptions : ReplaceTextOptionsBase
    Remarks
    This class derives from ReplaceTextOptionsBase.
    Inheritance Hierarchy

    System.Object
       Xceed.Document.NET.ReplaceTextOptionsBase
          Xceed.Document.NET.ObjectReplaceTextOptions

    Public Constructors
     NameDescription
    Public ConstructorObjectReplaceTextOptions 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.  
    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 PropertyNewObjectGets or sets the object that will replace the text. The default value is null.  
    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 NewObject. The default value is null.  
    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)
    Top
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows 11, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    ObjectReplaceTextOptions Members
    Xceed.Document.NET Namespace

    Send Feedback