API Reference

Class

WordSearchResult

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Modifiers sealed

Represents the results of a find and replace operation within a document.

Inheritance

  • Object
  • WordSearchResult

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

FindRegex(System.Collections.Generic.IEnumerable{OfficeIMO.Word.WordParagraph} paragraphs, System.Text.RegularExpressions.Regex regex, System.Collections.Generic.List{OfficeIMO.Word.WordParagraph} destination) #

Searches the provided paragraphs for matches of the supplied regular expression and stores the paragraphs containing matches in the specified list.

Parameters

paragraphs System.Collections.Generic.IEnumerable{OfficeIMO.Word.WordParagraph} required
Paragraphs to search.
regex System.Text.RegularExpressions.Regex required
Regular expression pattern.
destination System.Collections.Generic.List{OfficeIMO.Word.WordParagraph} required
Collection to store paragraphs with matches.

Properties

public Int32 MatchCount { get; set; } #

Gets the total number of regular-expression matches.

public IReadOnlyList<WordParagraph> BodyParagraphs { get; } #

Body paragraphs containing one or more matches.

public IReadOnlyList<WordParagraph> TableParagraphs { get; } #

Table-cell paragraphs containing one or more matches.

public IReadOnlyList<WordParagraph> DefaultHeaderParagraphs { get; } #

Default-header paragraphs containing one or more matches.

public IReadOnlyList<WordParagraph> EvenPageHeaderParagraphs { get; } #

Even-page-header paragraphs containing one or more matches.

public IReadOnlyList<WordParagraph> FirstPageHeaderParagraphs { get; } #

First-page-header paragraphs containing one or more matches.

public IReadOnlyList<WordParagraph> DefaultFooterParagraphs { get; } #

Default-footer paragraphs containing one or more matches.

public IReadOnlyList<WordParagraph> EvenPageFooterParagraphs { get; } #

Even-page-footer paragraphs containing one or more matches.

public IReadOnlyList<WordParagraph> FirstPageFooterParagraphs { get; } #

First-page-footer paragraphs containing one or more matches.