Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeDrawingRichText

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Positioned rich text box inside an OfficeDrawing canvas. Coordinates use the drawing's local top-left coordinate space.

Inheritance

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public OfficeDrawingRichText(IReadOnlyList<OfficeRichTextRun> runs, double x, double y, double width, double height, OfficeTextAlignment alignment = Left, double? lineHeight = null, OfficeTextVerticalAlignment verticalAlignment = Top, double rotationDegrees = 0, double? rotationCenterX = null, double? rotationCenterY = null, bool wrapText = true, bool shrinkToFit = false, bool flipHorizontal = false, bool flipVertical = false, OfficeTextPadding? padding = null, OfficeTextParagraphIndent? paragraphIndent = null) #

Creates a positioned drawing rich text box.

Parameters

runs System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRichTextRun> required
x double required
y double required
width double required
height double required
alignment OfficeIMO.Drawing.OfficeTextAlignment = Left optional
lineHeight double? = null optional
verticalAlignment OfficeIMO.Drawing.OfficeTextVerticalAlignment = Top optional
rotationDegrees double = 0 optional
rotationCenterX double? = null optional
rotationCenterY double? = null optional
wrapText bool = true optional
shrinkToFit bool = false optional
flipHorizontal bool = false optional
flipVertical bool = false optional
padding OfficeIMO.Drawing.OfficeTextPadding? = null optional
paragraphIndent OfficeIMO.Drawing.OfficeTextParagraphIndent? = null optional

Methods

public OfficeDrawingRichText Clone() #

Creates a detached copy of this positioned rich text box.

public OfficeImageFrameTransform CreateFrameTransform() #

Creates the reusable frame transform used by SVG and raster renderers.

Properties

public IReadOnlyList<OfficeRichTextRun> Runs { get; } #

Styled text runs in paint order.

public IReadOnlyList<OfficeRichTextParagraph> Paragraphs { get; } #

Independent paragraphs, or an empty collection for the original single-format run profile.

public OfficeTextAreaAlignment TextAreaAlignment { get; private set; } #

Horizontal placement of the measured paragraph area inside the padded frame.

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 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 bool WrapText { get; } #

Whether renderers should wrap text to the text box width.

public bool ShrinkToFit { get; } #

Whether renderers should reduce font sizes when text overflows the text box.

public bool FlipHorizontal { get; } #

Whether to mirror the rendered rich text horizontally around the frame center.

public bool 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 bool HasPadding { get; } #

Whether the text frame has non-zero padding.

public bool HasParagraphIndent { get; } #

Whether the text frame has non-zero paragraph indentation.

public bool HasFrameTransform { get; } #

Whether the text frame applies rotation or mirroring.