API Reference
WordFluentDocument
Provides a fluent API wrapper around WordDocument.
Inheritance
- Object
- WordFluentDocument
Constructors
public WordFluentDocument(WordDocument document) #Initializes a new instance of the WordFluentDocument class.
Parameters
- document OfficeIMO.Word.WordDocument
- The underlying WordDocument.
Methods
public WordFluentDocument Callout(String kind, String title, String body) #WordFluentDocumentCreates a simple callout block (Markdown parity: Callout(kind,title,body)).
Parameters
- kind System.String
- title System.String
- body System.String
public WordFluentDocument Code(String language, String content) #WordFluentDocumentAdds a monospace code paragraph (alias mirrors MarkdownDoc.Code).
Parameters
- language System.String
- Optional language hint (not used for styling).
- content System.String
- Code text.
public WordDocument End() #WordDocumentEnds fluent configuration and returns the underlying WordDocument.
Returns
The wrapped WordDocument for further processing.
public WordFluentDocument Find(String text, Action<ParagraphBuilder> action, StringComparison stringComparison = OrdinalIgnoreCase) #WordFluentDocumentFinds paragraphs containing the specified text.
Parameters
- text System.String
- Text to search for.
- action System.Action{OfficeIMO.Word.Fluent.ParagraphBuilder}
- Action executed for each matching paragraph.
- stringComparison System.StringComparison = OrdinalIgnoreCase
- String comparison option.
public WordFluentDocument FindRegex(String pattern, Action<ParagraphBuilder> action) #WordFluentDocumentFinds runs matching the specified regular expression pattern.
Parameters
- pattern System.String
- Regular expression pattern.
- action System.Action{OfficeIMO.Word.Fluent.ParagraphBuilder}
- Action executed for each matching run.
public WordFluentDocument ForEachParagraph(Action<ParagraphBuilder> action) #WordFluentDocumentExecutes an action for each paragraph in the document.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.ParagraphBuilder}
- Action to execute for every paragraph.
public WordFluentDocument ForEachRun(Action<RunBuilder> action) #WordFluentDocumentExecutes an action for each run in the document.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.RunBuilder}
- Action to execute for every run.
public WordFluentDocument ForEachSection(Action<Int32, WordSection> action) #WordFluentDocumentExecutes an action for each section in the document.
Parameters
- action System.Action{System.Int32,OfficeIMO.Word.WordSection}
- Action to execute for every section with its 1-based index.
public WordFluentDocument H1(String text) #WordFluentDocumentAdds a heading paragraph styled as Heading 1 (alias mirrors MarkdownDoc.H1).
Parameters
- text System.String
public WordFluentDocument H2(String text) #WordFluentDocumentAdds a heading paragraph styled as Heading 2 (alias mirrors MarkdownDoc.H2).
Parameters
- text System.String
public WordFluentDocument H3(String text) #WordFluentDocumentAdds a heading paragraph styled as Heading 3 (alias mirrors MarkdownDoc.H3).
Parameters
- text System.String
public WordFluentDocument H4(String text) #WordFluentDocumentAdds a heading paragraph styled as Heading 4 (alias mirrors MarkdownDoc.H4).
Parameters
- text System.String
public WordFluentDocument H5(String text) #WordFluentDocumentAdds a heading paragraph styled as Heading 5 (alias mirrors MarkdownDoc.H5).
Parameters
- text System.String
public WordFluentDocument H6(String text) #WordFluentDocumentAdds a heading paragraph styled as Heading 6 (alias mirrors MarkdownDoc.H6).
Parameters
- text System.String
public WordFluentDocument Header(Action<HeadersBuilder> action) #WordFluentDocumentConfigures document headers.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.HeadersBuilder}
- Action that receives a HeadersBuilder.
public WordFluentDocument Image(Action<ImageBuilder> action) #WordFluentDocumentAdds or modifies an image.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.ImageBuilder}
- Action that receives an ImageBuilder.
public async Task<WordFluentDocument> ImageAsync(Func<ImageBuilder, Task> action) #Task<WordFluentDocument>Adds or modifies an image asynchronously.
Parameters
- action System.Func{OfficeIMO.Word.Fluent.ImageBuilder,System.Threading.Tasks.Task}
- Async action that receives an ImageBuilder.
public WordFluentDocument Info(Action<InfoBuilder> action) #WordFluentDocumentProvides fluent access to document information.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.InfoBuilder}
- Action that receives an InfoBuilder.
public WordFluentDocument List(Action<ListBuilder> action) #WordFluentDocumentAdds or modifies a list.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.ListBuilder}
- Action that receives a ListBuilder.
public WordFluentDocument Ol(Action<ListBuilder> action) #WordFluentDocumentAdds a numbered list using the list builder (alias mirrors MarkdownDoc.Ol).
Parameters
- action System.Action{OfficeIMO.Word.Fluent.ListBuilder}
public WordFluentDocument P(String text) #WordFluentDocumentAdds a plain paragraph (Markdown-style alias of ParagraphBuilder>)).
Parameters
- text System.String
- Text to insert.
public WordFluentDocument PageSetup(Action<PageSetupBuilder> action) #WordFluentDocumentConfigures document-wide page setup defaults.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.PageSetupBuilder}
- Action that receives a PageSetupBuilder.
public WordFluentDocument Paragraph(Action<ParagraphBuilder> action) #WordFluentDocumentAdds a new paragraph and allows fluent configuration of its contents.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.ParagraphBuilder}
- Action that receives a ParagraphBuilder.
public IEnumerable<WordParagraph> Paragraphs() #IEnumerable<WordParagraph>Returns all paragraphs in the document.
public WordFluentDocument Section(Action<SectionBuilder> action) #WordFluentDocumentConfigures document sections.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.SectionBuilder}
- Action that receives a SectionBuilder.
public IEnumerable<WordSection> Sections() #IEnumerable<WordSection>Returns all sections in the document.
public IEnumerable<ParagraphBuilder> Select(Func<ParagraphBuilder, Boolean> predicate) #IEnumerable<ParagraphBuilder>Selects paragraphs that match the specified predicate.
Parameters
- predicate System.Func{OfficeIMO.Word.Fluent.ParagraphBuilder,System.Boolean}
- Filter predicate.
public WordFluentDocument Table(Action<TableBuilder> action) #WordFluentDocumentAdds or modifies a table.
Parameters
- action System.Action{OfficeIMO.Word.Fluent.TableBuilder}
- Action that receives a TableBuilder.
public IEnumerable<WordTable> Tables() #IEnumerable<WordTable>Returns all tables in the document.
public WordFluentDocument TocAtTop(String title = "Contents", Int32 minLevel = 1, Int32 maxLevel = 3, Int32 titleLevel = 2) #WordFluentDocumentInserts a Table of Contents near the top of the document (Markdown parity: TocAtTop).
Parameters
- title System.String = "Contents"
- Heading shown above the TOC.
- minLevel System.Int32 = 1
- Minimum heading level to include.
- maxLevel System.Int32 = 3
- Maximum heading level to include.
- titleLevel System.Int32 = 2
- Heading level for the title (1..6).
public WordFluentDocument TocHere(String title = "Contents", Int32 minLevel = 1, Int32 maxLevel = 3, Int32 titleLevel = 3) #WordFluentDocumentAppends a Table of Contents at the end (Markdown parity: TocHere).
Parameters
- title System.String = "Contents"
- minLevel System.Int32 = 1
- maxLevel System.Int32 = 3
- titleLevel System.Int32 = 3
public WordFluentDocument Ul(Action<ListBuilder> action) #WordFluentDocumentAdds a bulleted list using the list builder (alias mirrors MarkdownDoc.Ul).
Parameters
- action System.Action{OfficeIMO.Word.Fluent.ListBuilder}
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object