GrapeCity.Documents.Word.FindReplaceOptions

Class FindReplaceOptions

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents options for a find and replace operation.

public class FindReplaceOptions : FindOptions

Inheritance

object

FindOptions

FindReplaceOptions

Inherited Members

FindOptions.SearchBackwards

FindOptions.IgnoreCase

FindOptions.UseCultureInvariant

FindOptions.RegularExpressions

FindOptions.FormattingOptions

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

FindReplaceOptions(DocumentBase)

Initializes a new instance of the FindReplaceOptions class.

public FindReplaceOptions(DocumentBase document)

Parameters

document DocumentBase

The target document for the find/replace operation.

Properties

RemoveEmptyRuns

Gets or sets a value indicating whether empty runs that appeared as the result of a replace operation should be removed.

The default is false.

public bool RemoveEmptyRuns { get; set; }

Property Value

bool

Remarks

Specifying an empty search string and setting this property to true will remove all empty runs.

ReplacedCallback

Gets or sets a callback action that is called for each found instance after the replacement has been done.

public Action<ReplacedArgs> ReplacedCallback { get; set; }

Property Value

Action<ReplacedArgs>

ReplacingCallback

Gets or sets a callback function that is called for each found instance prior to the replacement. The return value of the function specifies the action that should be taken.

public Func<ReplacingArgs, ReplaceAction> ReplacingCallback { get; set; }

Property Value

Func<ReplacingArgs, ReplaceAction>