API Reference
OdtParagraph
An XML-backed ODT paragraph or heading.
Inheritance
- Object
- OdtParagraph
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 OdtContentBlock.Paragraph
- Method OdtDocument.AddHeading
- Method OdtDocument.AddPageBreak
- Method OdtDocument.AddParagraph
- Property OdtDocument.Paragraphs
- Method OdtHeaderFooter.AddParagraph
- Property OdtHeaderFooter.Paragraphs
- Method OdtListItem.AddParagraph
- Property OdtListItem.Paragraphs
- Method OdtParagraph.AddBookmark
- Method OdtParagraph.AddBookmarkEnd
- Method OdtParagraph.AddBookmarkStart
- Method OdtParagraph.AddText
- Method OdtParagraph.TransformTextCase
- Method OdtSection.AddHeading
- Method OdtSection.AddParagraph
- Property OdtSection.Paragraphs
- Method OdtTableCell.AddParagraph
- Property OdtTableCell.Paragraphs
Accepted by parameters
Methods
public OdtParagraph AddBookmark(String name) #OdtParagraphAppends a collapsed bookmark.
Parameters
- name System.String
public OdtParagraph AddBookmarkEnd(String name) #OdtParagraphAppends a bookmark range end marker.
Parameters
- name System.String
public OdtParagraph AddBookmarkStart(String name) #OdtParagraphAppends a bookmark range start marker.
Parameters
- name System.String
public OdtHyperlink AddHyperlink(String text, String href) #OdtHyperlinkAppends a hyperlink without resolving or fetching its target.
Parameters
- text System.String
- href System.String
public OdtImage AddImage(Byte[] data, String fileName, OdfLength width, OdfLength height, OdtImageAnchor anchor = Inline) #OdtImageAppends an inline or paragraph-anchored image.
Parameters
- data System.Byte[]
- fileName System.String
- width OfficeIMO.OpenDocument.OdfLength
- height OfficeIMO.OpenDocument.OdfLength
- anchor OfficeIMO.OpenDocument.OdtImageAnchor = Inline
public OdtSpan AddSpan(String text = null) #OdtSpanAppends a styled text span.
Parameters
- text System.String = null
public OdtParagraph AddText(String text) #OdtParagraphAppends plain text while encoding ODF whitespace semantics.
Parameters
- text System.String
public OdtParagraph TransformTextCase(OfficeTextCase textCase, CultureInfo culture = null) #OdtParagraphChanges stored paragraph text casing while preserving spans, hyperlinks, bookmarks, and images.
Parameters
- textCase OfficeIMO.Drawing.OfficeTextCase
- culture System.Globalization.CultureInfo = null
Inherited Methods
Properties
public String Text { get; set; } #Plain text with ODF spaces, tabs, and line breaks decoded.
public String StyleName { get; set; } #Referenced paragraph style name.
public Boolean IsHeading { get; } #True when this block is a heading.
public Nullable<Int32> HeadingLevel { get; set; } #Heading outline level, or null for a normal paragraph.
public IReadOnlyList<OdtSpan> Spans { get; } #Inline text spans in this paragraph.
public IReadOnlyList<OdtHyperlink> Hyperlinks { get; } #Hyperlinks in this paragraph.
public IReadOnlyList<OdtInlineNode> InlineNodes { get; } #Direct inline nodes in document order. Use this syntax view when mixed plain text, spans, links, images, or bookmark markers must be processed without flattening.
public IReadOnlyList<OdtImage> Images { get; } #Embedded image frames in this paragraph.
public Boolean PageBreakBefore { get; set; } #Controls whether this paragraph starts on a new page.
public Nullable<Boolean> Bold { get; set; } #Explicit or inherited bold state.
public Nullable<Boolean> Italic { get; set; } #Explicit or inherited italic state.
public Nullable<Boolean> Underline { get; set; } #Explicit or inherited underline state.
public Nullable<OdfTextDecorationStyle> UnderlineStyle { get; set; } #Explicit or inherited native underline style.
public Nullable<OdfTextDecorationType> UnderlineType { get; set; } #Explicit or inherited native underline line count.
public Boolean UsesNonSolidUnderlineStyle { get; } #Whether the effective underline uses a non-solid ODF decoration style.
public Nullable<Boolean> StrikeThrough { get; set; } #Explicit or inherited strike-through state.
public Nullable<OdfTextDecorationStyle> LineThroughStyle { get; set; } #Explicit or inherited native line-through style.
public Nullable<OdfTextDecorationType> LineThroughType { get; set; } #Explicit or inherited native line-through line count.
public Boolean UsesNonSolidLineThroughStyle { get; } #Whether the effective line-through uses a non-solid ODF decoration style.
public Nullable<OdfLength> FontSize { get; set; } #Explicit or inherited font size.
public Nullable<OdfTextPosition> TextPosition { get; set; } #Explicit or inherited baseline placement.
public Nullable<OdfTextTransform> TextTransform { get; set; } #Explicit or inherited display-time case transformation.
public Nullable<Boolean> SmallCaps { get; set; } #Explicit or inherited small-cap display formatting.
public Nullable<OdfColor> Color { get; set; } #Explicit or inherited text color.
public Nullable<OdfColor> TextBackgroundColor { get; set; } #Explicit or inherited text background color.
public String FontFamily { get; set; } #Explicit or inherited font family.
public Nullable<OdfColor> BackgroundColor { get; set; } #Explicit or inherited paragraph background color.
public Nullable<OdtParagraphAlignment> Alignment { get; set; } #Explicit or inherited horizontal paragraph alignment.
public String WritingMode { get; set; } #Effective ODF writing-mode token, such as lr-tb or rl-tb.
public Boolean IsRightToLeft { get; } #Whether the effective horizontal paragraph writing mode is right-to-left.
public Nullable<OdfLength> LineHeight { get; set; } #Effective paragraph line height, including absolute and percentage values.
public Nullable<OdfLength> IndentStart { get; set; } #Explicit or inherited paragraph start indentation.
public Nullable<OdfLength> IndentEnd { get; set; } #Explicit or inherited paragraph end indentation.
public Nullable<OdfLength> FirstLineIndent { get; set; } #Explicit or inherited first-line indentation.
public Nullable<OdfLength> SpaceAbove { get; set; } #Explicit or inherited spacing above the paragraph.
public Nullable<OdfLength> SpaceBelow { get; set; } #Explicit or inherited spacing below the paragraph.