API Reference
Class
WordBreak
Represents a break in the text. Be it page break, soft break, column or text wrapping
Inheritance
- WordElement
- WordBreak
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
- Property WordDocument.Breaks
- Property WordDocument.PageBreaks
- Property WordFooter.PageBreaks
- Property WordHeader.PageBreaks
- Property WordHeaderFooter.PageBreaks
- Property WordParagraph.Break
- Property WordParagraph.PageBreak
- Property WordSection.Breaks
- Property WordSection.PageBreaks
Constructors
public WordBreak(WordDocument document, Paragraph paragraph, Run run) #Create new instance of WordBreak
Parameters
- document OfficeIMO.Word.WordDocument
- paragraph DocumentFormat.OpenXml.Wordprocessing.Paragraph
- run DocumentFormat.OpenXml.Wordprocessing.Run
Methods
public Void Remove(Boolean includingParagraph = false) #Returns:
VoidRemove the break from WordDocument. By default it removes break without removing paragraph. If you want paragraph removed please use IncludingParagraph bool. Please remember a paragraph can hold multiple other elements.
Parameters
- includingParagraph System.Boolean = false
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public Nullable<BreakValues> BreakType { get; } #Get type of Break in given paragraph