API Reference
Class
WordParagraphBuilder
Builder for paragraphs.
Inheritance
- Object
- WordParagraphBuilder
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
- Method WordFluentDocument.Select
- Method WordParagraphBuilder.Align
- Method WordParagraphBuilder.Bold
- Method WordParagraphBuilder.Border
- Method WordParagraphBuilder.Break
- Method WordParagraphBuilder.Code
- Method WordParagraphBuilder.Indentation
- Method WordParagraphBuilder.InlineImage
- Method WordParagraphBuilder.Italic
- Method WordParagraphBuilder.Justify
- Method WordParagraphBuilder.LineSpacing
- Method WordParagraphBuilder.Link
- Method WordParagraphBuilder.Run
- Method WordParagraphBuilder.Shading
- Method WordParagraphBuilder.SpacingAfter
- Method WordParagraphBuilder.SpacingBefore
- Method WordParagraphBuilder.Strike
- Method WordParagraphBuilder.Style
- Method WordParagraphBuilder.Style
- Method WordParagraphBuilder.Tab
- Method WordParagraphBuilder.Text
- Method WordParagraphBuilder.Underline
Accepted by parameters
- Method FooterContentBuilder.Paragraph
- Method HeaderContentBuilder.Paragraph
- Method SectionBuilder.Paragraph
- Method WordFluentDocument.Find
- Method WordFluentDocument.FindRegex
- Method WordFluentDocument.FindRegex
- Method WordFluentDocument.ForEachParagraph
- Method WordFluentDocument.Paragraph
- Method WordFluentDocument.Select
Methods
public WordParagraphBuilder Align(WordParagraphAlignment alignment) #Returns:
WordParagraphBuilderSets the paragraph alignment.
Parameters
- alignment OfficeIMO.Word.WordParagraphAlignment
- Desired alignment.
public WordParagraphBuilder Bold(String text) #Returns:
WordParagraphBuilderAppends bold text (Markdown parity helper).
Parameters
- text System.String
public WordParagraphBuilder Border(Action<WordParagraphBorders> configure) #Returns:
WordParagraphBuilderConfigures borders for the paragraph.
Parameters
- configure System.Action{OfficeIMO.Word.WordParagraphBorders}
- Callback to configure individual border settings.
public WordParagraphBuilder Break(Nullable<WordBreakType> breakType = null) #Returns:
WordParagraphBuilderInserts a break into the paragraph.
Parameters
- breakType System.Nullable{OfficeIMO.Word.WordBreakType} = null
- Optional break type.
public WordParagraphBuilder Code(String text) #Returns:
WordParagraphBuilderAppends inline code using a monospace font (Markdown parity helper).
Parameters
- text System.String
public WordParagraphBuilder Indentation(Nullable<Double> left = null, Nullable<Double> firstLine = null, Nullable<Double> right = null) #Returns:
WordParagraphBuilderSets indentation values for the paragraph.
Parameters
- left System.Nullable{System.Double} = null
- Left indentation in points.
- firstLine System.Nullable{System.Double} = null
- First-line indentation in points.
- right System.Nullable{System.Double} = null
- Right indentation in points.
public WordParagraphBuilder InlineImage(String path, Nullable<Double> widthPx = null, Nullable<Double> heightPx = null, String alt = "") #Returns:
WordParagraphBuilderInserts an inline image into the paragraph.
Parameters
- path System.String
- Path to the image file.
- widthPx System.Nullable{System.Double} = null
- Optional width in pixels.
- heightPx System.Nullable{System.Double} = null
- Optional height in pixels.
- alt System.String = ""
- Alternative text.
public WordParagraphBuilder Italic(String text) #Returns:
WordParagraphBuilderAppends italic text (Markdown parity helper).
Parameters
- text System.String
public WordParagraphBuilder Justify() #Returns:
WordParagraphBuilderApplies justified alignment to the paragraph.
public WordParagraphBuilder LineSpacing(Double points) #Returns:
WordParagraphBuilderSets line spacing for the paragraph.
Parameters
- points System.Double
- Spacing in points.
public WordParagraphBuilder Link(String url, String text = null, Boolean style = false) #Returns:
WordParagraphBuilderAdds a hyperlink to the paragraph.
Parameters
- url System.String
- Destination URL.
- text System.String = null
- Optional text to display.
- style System.Boolean = false
- True to apply hyperlink style.
public WordParagraphBuilder Run(String text, Action<TextBuilder> configure = null) #Returns:
WordParagraphBuilderAdds a text run to the paragraph.
Parameters
- text System.String
- Text to add.
- configure System.Action{OfficeIMO.Word.Fluent.TextBuilder} = null
- Optional configuration for the run.
public WordParagraphBuilder Shading(OfficeColor color) #Returns:
WordParagraphBuilderApplies shading to the paragraph.
Parameters
- color OfficeIMO.Drawing.OfficeColor
- Fill color.
public WordParagraphBuilder SpacingAfter(Double points) #Returns:
WordParagraphBuilderSets spacing after the paragraph.
Parameters
- points System.Double
- Spacing in points.
public WordParagraphBuilder SpacingBefore(Double points) #Returns:
WordParagraphBuilderSets spacing before the paragraph.
Parameters
- points System.Double
- Spacing in points.
public WordParagraphBuilder Strike(String text) #Returns:
WordParagraphBuilderAppends strikethrough text (Markdown parity helper).
Parameters
- text System.String
Style 2 overloads
public WordParagraphBuilder Style(WordParagraphStyles style) #Returns:
WordParagraphBuilderApplies a built-in style to the paragraph.
Parameters
- style OfficeIMO.Word.WordParagraphStyles
- Built-in style.
public WordParagraphBuilder Style(String styleId) #Returns:
WordParagraphBuilderApplies a style by its identifier.
Parameters
- styleId System.String
- Style identifier.
public WordParagraphBuilder Text(String text, Action<TextBuilder> configure = null) #Returns:
WordParagraphBuilderAdds a text run to the paragraph.
Parameters
- text System.String
- Text to add.
- configure System.Action{OfficeIMO.Word.Fluent.TextBuilder} = null
- Optional configuration for the run.
public WordParagraphBuilder Underline(String text) #Returns:
WordParagraphBuilderAppends underlined text (Markdown parity helper).
Parameters
- text System.String
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public WordParagraph Paragraph { get; } #Gets the underlying paragraph.