API Reference
WordParagraphSnapshot
Text, formatting, list, border, bookmark, and pagination state for one paragraph.
Inheritance
- WordBlockSnapshot
- WordParagraphSnapshot
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 WordEndnoteSnapshot.Paragraphs
- Property WordFootnoteSnapshot.Paragraphs
- Property WordHeaderFooterSnapshot.Paragraphs
- Property WordTableCellSnapshot.Paragraphs
Constructors
public WordParagraphSnapshot() #Creates an empty paragraph snapshot.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Text { get; set; } #Gets text extracted from the paragraph's runs, including text hidden by run formatting.
public String StyleId { get; set; } #Gets the applied paragraph style identifier.
public String StyleName { get; set; } #Gets the OfficeIMO built-in paragraph-style classification, or the document style name for a custom classification when available; otherwise Custom.
public Boolean IsListItem { get; set; } #Gets whether the paragraph participates in numbering.
public Nullable<Boolean> IsOrderedList { get; set; } #Gets whether list numbering is ordered, or null when not resolved.
public Nullable<Int32> ListLevel { get; set; } #Gets the zero-based list nesting level.
public String ListStyleName { get; set; } #Gets the OfficeIMO list-style classification.
public String Alignment { get; set; } #Gets the paragraph alignment authored directly on the paragraph, without resolving inherited styles.
public Nullable<Double> IndentStartPoints { get; set; } #Gets leading indentation in points.
public Nullable<Double> IndentEndPoints { get; set; } #Gets trailing indentation in points.
public Nullable<Double> IndentFirstLinePoints { get; set; } #Gets first-line indentation in points; negative values represent hanging indents.
public Nullable<Double> SpaceAbovePoints { get; set; } #Gets spacing above the paragraph in points.
public Nullable<Double> SpaceBelowPoints { get; set; } #Gets spacing below the paragraph in points.
public Nullable<Int32> LineSpacingValue { get; set; } #Gets the raw Word line-spacing value.
public String LineSpacingRule { get; set; } #Gets the authored line-spacing rule.
public String ShadingFillColorHex { get; set; } #Gets the authored OOXML paragraph-shading fill token, typically an RGB hex value but possibly the automatic-color keyword.
public Nullable<WordShadingPattern> ShadingPattern { get; set; } #Paragraph shading pattern, when explicitly authored.
public WordParagraphBorderSnapshot LeftBorder { get; set; } #Gets the left paragraph border.
public WordParagraphBorderSnapshot RightBorder { get; set; } #Gets the right paragraph border.
public WordParagraphBorderSnapshot TopBorder { get; set; } #Gets the top paragraph border.
public WordParagraphBorderSnapshot BottomBorder { get; set; } #Gets the bottom paragraph border.
public Boolean IsRightToLeft { get; set; } #Gets directly authored right-to-left layout without resolving paragraph styles.
public Boolean KeepWithNext { get; set; } #Gets directly authored keep-with-next formatting without resolving paragraph styles.
public Boolean KeepLinesTogether { get; set; } #Gets directly authored keep-lines-together formatting without resolving paragraph styles.
public Boolean AvoidWidowAndOrphan { get; set; } #Gets directly authored widow and orphan control without resolving paragraph styles.
public Boolean PageBreakBefore { get; set; } #Gets directly authored page-break-before formatting without resolving paragraph styles.
public String BookmarkName { get; set; } #Gets the first bookmark name associated with the paragraph.
public Nullable<Int32> BookmarkId { get; set; } #Gets the first bookmark identifier associated with the paragraph.
public IReadOnlyList<WordRunSnapshot> Runs { get; } #Gets text runs in source order.
public IReadOnlyList<WordInlineFieldSnapshot> InlineFields { get; } #Simple fields and their positions among the paragraph's ordinary runs.
public IReadOnlyList<WordTabStopSnapshot> TabStops { get; } #Gets explicit paragraph tab stops.
Inherited Properties
public String Kind { get; } #public Int32 Order { get; set; } #