API Reference
OfficeDrawingRichText
Positioned rich text box inside an OfficeDrawing canvas. Coordinates use the drawing's local top-left coordinate space.
Inheritance
- OfficeDrawingElement
- OfficeDrawingRichText
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 OfficeDrawingRichText.Clone
Constructors
public OfficeDrawingRichText(IReadOnlyList<OfficeRichTextRun> runs, Double x, Double y, Double width, Double height, OfficeTextAlignment alignment = Left, Nullable<Double> lineHeight = null, OfficeTextVerticalAlignment verticalAlignment = Top, Double rotationDegrees = 0, Nullable<Double> rotationCenterX = null, Nullable<Double> rotationCenterY = null, Boolean wrapText = true, Boolean shrinkToFit = false, Boolean flipHorizontal = false, Boolean flipVertical = false, Nullable<OfficeTextPadding> padding = null, Nullable<OfficeTextParagraphIndent> paragraphIndent = null) #Creates a positioned drawing rich text box.
Parameters
- runs System.Collections.Generic.IReadOnlyList{OfficeIMO.Drawing.OfficeRichTextRun}
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- alignment OfficeIMO.Drawing.OfficeTextAlignment = Left
- lineHeight System.Nullable{System.Double} = null
- verticalAlignment OfficeIMO.Drawing.OfficeTextVerticalAlignment = Top
- rotationDegrees System.Double = 0
- rotationCenterX System.Nullable{System.Double} = null
- rotationCenterY System.Nullable{System.Double} = null
- wrapText System.Boolean = true
- shrinkToFit System.Boolean = false
- flipHorizontal System.Boolean = false
- flipVertical System.Boolean = false
- padding System.Nullable{OfficeIMO.Drawing.OfficeTextPadding} = null
- paragraphIndent System.Nullable{OfficeIMO.Drawing.OfficeTextParagraphIndent} = null
Methods
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public IReadOnlyList<OfficeRichTextRun> Runs { get; } #Styled text runs in paint order.
public String PlainText { get; } #Plain text formed by concatenating all runs.
public Double X { get; } #Text box horizontal position inside the drawing.
public Double Y { get; } #Text box vertical position inside the drawing.
public Double Width { get; } #Text box width.
public Double Height { get; } #Text box height.
public OfficeTextAlignment Alignment { get; } #Horizontal text alignment inside the text box.
public Nullable<Double> LineHeight { get; } #Optional line height in drawing units. Null lets renderers use their default line height.
public OfficeTextVerticalAlignment VerticalAlignment { get; } #Vertical placement of text inside the drawing text box.
public Double RotationDegrees { get; } #Clockwise text rotation in degrees.
public Double RotationCenterX { get; } #X coordinate of the text rotation center in the drawing's local coordinate space.
public Double RotationCenterY { get; } #Y coordinate of the text rotation center in the drawing's local coordinate space.
public Boolean WrapText { get; } #Whether renderers should wrap text to the text box width.
public Boolean ShrinkToFit { get; } #Whether renderers should reduce font sizes when text overflows the text box.
public Boolean FlipHorizontal { get; } #Whether to mirror the rendered rich text horizontally around the frame center.
public Boolean FlipVertical { get; } #Whether to mirror the rendered rich text vertically around the frame center.
public OfficeTextPadding Padding { get; } #Insets applied inside the text frame before rich text layout.
public OfficeTextParagraphIndent ParagraphIndent { get; } #First-line and continuation-line offsets applied inside the rich text frame.
public Boolean HasPadding { get; } #Whether the text frame has non-zero padding.
public Boolean HasParagraphIndent { get; } #Whether the text frame has non-zero paragraph indentation.
public Boolean HasFrameTransform { get; } #Whether the text frame applies rotation or mirroring.