Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeDrawing

OfficeIMO.Drawing

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

Dependency-free vector drawing canvas shared by OfficeIMO document packages. Coordinates are expressed in the caller's layout unit and use a local top-left origin.

Inheritance

  • object
  • OfficeDrawing

Usage

Explore 58 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.

Accepted by parameters 20

Constructors

public OfficeDrawing(double width, double height) #

Creates a drawing canvas.

Parameters

width double required
height double required

Methods

public OfficeDrawing AddActualTextDrawing(string actualText, OfficeDrawing drawing, double actualTextAnchorX, double actualTextAnchorY) #

Adds vector paint that represents one logical text string. The paint remains native while PDF and SVG exporters can expose the string once for extraction and accessibility.

Parameters

actualText string required
drawing OfficeIMO.Drawing.OfficeDrawing required
actualTextAnchorX double required
actualTextAnchorY double required
public OfficeDrawing AddBorderBox(double x, double y, double width, double height, OfficeColor? fillColor, OfficeBorderBox borders, OfficeTransform? transform = null) #

Adds a filled rectangle and independent edge borders in paint order.

Parameters

x double required
y double required
width double required
height double required
fillColor OfficeIMO.OfficeColor? required
borders OfficeIMO.Drawing.OfficeBorderBox required
transform OfficeIMO.Drawing.OfficeTransform? = null optional
AddClippedDrawing 4 overloads
public OfficeDrawing AddClippedDrawing(OfficeDrawing drawing, double x, double y, OfficeClipPath clipPath) #

Adds another drawing as a clipped nested group at a local destination offset.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
x double required
y double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
public OfficeDrawing AddClippedDrawing(OfficeDrawing drawing, double x, double y, OfficeClipPath clipPath, OfficeImageFrameTransform frameTransform) #

Adds another drawing as a clipped nested group at a local destination offset with a shared frame transform.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
x double required
y double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
frameTransform OfficeIMO.Drawing.OfficeImageFrameTransform required
public OfficeDrawing AddClippedDrawing(OfficeDrawing drawing, double x, double y, OfficeClipPath clipPath, double contentOffsetX, double contentOffsetY) #

Adds another drawing as a clipped group with an independent content offset.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
x double required
y double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
contentOffsetX double required
contentOffsetY double required
public OfficeDrawing AddClippedDrawing(OfficeDrawing drawing, double x, double y, OfficeClipPath clipPath, double contentOffsetX, double contentOffsetY, OfficeImageFrameTransform frameTransform) #

Adds another drawing as a clipped group with independent content offset and frame transform.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
x double required
y double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
contentOffsetX double required
contentOffsetY double required
frameTransform OfficeIMO.Drawing.OfficeImageFrameTransform required
public OfficeDrawing AddClippedImage(byte[] bytes, string? contentType, OfficeImageProjection projection, double clipX, double clipY, OfficeClipPath clipPath, string? alternativeText = null, double opacity = 1) #

Adds an image clipped by a drawing-local clipping path.

Parameters

bytes byte[] required
contentType string? required
projection OfficeIMO.Drawing.OfficeImageProjection required
clipX double required
clipY double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
alternativeText string? = null optional
opacity double = 1 optional
public OfficeDrawing AddClippedImageWithInterpolation(byte[] bytes, string? contentType, OfficeImageProjection projection, bool interpolate, double clipX, double clipY, OfficeClipPath clipPath, string? alternativeText = null, double opacity = 1) #

Adds an image with explicit scaling interpolation behavior, clipped by a drawing-local path.

Parameters

bytes byte[] required
contentType string? required
projection OfficeIMO.Drawing.OfficeImageProjection required
interpolate bool required
clipX double required
clipY double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
alternativeText string? = null optional
opacity double = 1 optional
AddClippedPositionedText 2 overloads
public OfficeDrawing AddClippedPositionedText(string text, double x, double y, double width, double height, double clipX, double clipY, OfficeClipPath clipPath, OfficeFontInfo? font = null, OfficeColor? color = null, OfficeTextAlignment alignment = Left, double? lineHeight = null, double? textAdvanceWidth = null) #

Adds an already-positioned single text run clipped by a drawing-local clipping path. The clipping frame is independent from the resolved glyph advance retained for rendering.

Parameters

text string required
Text content to draw.
x double required
Horizontal frame position in drawing units.
y double required
Vertical frame position in drawing units.
width double required
Text frame width in drawing units.
height double required
Text frame height in drawing units.
clipX double required
Horizontal clip position in drawing units.
clipY double required
Vertical clip position in drawing units.
clipPath OfficeIMO.Drawing.OfficeClipPath required
Clip path relative to clipX and clipY.
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
Optional font descriptor.
color OfficeIMO.OfficeColor? = null optional
Optional text color.
alignment OfficeIMO.Drawing.OfficeTextAlignment = Left optional
Horizontal alignment inside the frame.
lineHeight double? = null optional
Optional resolved line height.
textAdvanceWidth double? = null optional
Resolved horizontal glyph advance, or null to use width.

Returns

OfficeDrawing The current drawing.
public OfficeDrawing AddClippedPositionedText(string text, double x, double y, double width, double height, double clipX, double clipY, OfficeClipPath clipPath, OfficeImageFrameTransform frameTransform, OfficeFontInfo? font = null, OfficeColor? color = null, OfficeTextAlignment alignment = Left, double? lineHeight = null, double? textAdvanceWidth = null) #

Adds a transformed source text run inside a drawing-local clip path, retaining the resolved glyph advance and complete source text.

Parameters

text string required
x double required
y double required
width double required
height double required
clipX double required
clipY double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
frameTransform OfficeIMO.Drawing.OfficeImageFrameTransform required
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
color OfficeIMO.OfficeColor? = null optional
alignment OfficeIMO.Drawing.OfficeTextAlignment = Left optional
lineHeight double? = null optional
textAdvanceWidth double? = null optional
public OfficeDrawing AddClippedText(string text, double x, double y, double width, double height, double clipX, double clipY, OfficeClipPath clipPath, OfficeFontInfo? font = null, OfficeColor? color = null, OfficeTextAlignment alignment = Left, double? lineHeight = null, OfficeTextVerticalAlignment verticalAlignment = Top, double rotationDegrees = 0, double? rotationCenterX = null, double? rotationCenterY = null, bool wrapText = false, bool shrinkToFit = false, bool stackedText = false, bool flipHorizontal = false, bool flipVertical = false, OfficeTextPadding? padding = null, OfficeTextParagraphIndent? paragraphIndent = null) #

Adds text clipped by a drawing-local clipping path.

Parameters

text string required
x double required
y double required
width double required
height double required
clipX double required
clipY double required
clipPath OfficeIMO.Drawing.OfficeClipPath required
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
color OfficeIMO.OfficeColor? = null optional
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 = false optional
shrinkToFit bool = false optional
stackedText bool = false optional
flipHorizontal bool = false optional
flipVertical bool = false optional
padding OfficeIMO.Drawing.OfficeTextPadding? = null optional
paragraphIndent OfficeIMO.Drawing.OfficeTextParagraphIndent? = null optional
AddDrawing 2 overloads
public OfficeDrawing AddDrawing(OfficeDrawing drawing, double x, double y) #

Adds all elements from another drawing at a local destination offset and returns this drawing.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
x double required
y double required
public OfficeDrawing AddDrawing(OfficeDrawing drawing, double x, double y, OfficeImageFrameTransform frameTransform) #

Adds all elements from another drawing at a local destination offset with a shared frame transform.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
x double required
y double required
frameTransform OfficeIMO.Drawing.OfficeImageFrameTransform required
AddEffectDrawing 2 overloads
public OfficeDrawing AddEffectDrawing(OfficeDrawing drawing, OfficeTransform transform, double opacity = 1) #

Adds another drawing as one affine-transformed, isolated opacity group.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
transform OfficeIMO.Drawing.OfficeTransform required
opacity double = 1 optional
public OfficeDrawing AddEffectDrawing(OfficeDrawing drawing, OfficeTransform transform, OfficeBlendMode blendMode, OfficeDrawingSoftMask? softMask = null, double opacity = 1) #

Adds another drawing as one affine-transformed group with managed blending and an optional vector soft mask.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing required
transform OfficeIMO.Drawing.OfficeTransform required
blendMode OfficeIMO.Drawing.OfficeBlendMode required
softMask OfficeIMO.Drawing.OfficeDrawingSoftMask? = null optional
opacity double = 1 optional
public OfficeDrawing AddFont(string familyName, byte[] data, OfficeFontStyle style = Regular) #

Adds or replaces a scoped TrueType face and returns this drawing.

Parameters

familyName string required
data byte[] required
style OfficeIMO.Drawing.OfficeFontStyle = Regular optional
public OfficeDrawing AddImage(byte[] bytes, string? contentType, OfficeImageProjection projection, string? alternativeText = null, double opacity = 1) #

Adds an image using a shared placement/crop/transform projection and returns this drawing.

Parameters

bytes byte[] required
contentType string? required
projection OfficeIMO.Drawing.OfficeImageProjection required
alternativeText string? = null optional
opacity double = 1 optional
public OfficeDrawing AddImageBehindContent(byte[] bytes, string? contentType, OfficeImageProjection projection, string? alternativeText = null, double opacity = 1) #

Adds an image behind existing foreground content while keeping an initial page background underneath it.

Parameters

bytes byte[] required
contentType string? required
projection OfficeIMO.Drawing.OfficeImageProjection required
alternativeText string? = null optional
opacity double = 1 optional
public OfficeDrawing AddImagePattern(byte[] bytes, string? contentType, OfficeImagePatternLayout layout, int maximumTileCount = 16384, double opacity = 1) #

Adds a clipped repeating image pattern and returns this drawing.

Parameters

bytes byte[] required
contentType string? required
layout OfficeIMO.Drawing.OfficeImagePatternLayout required
maximumTileCount int = 16384 optional
opacity double = 1 optional
public OfficeDrawing AddImageWithInterpolation(byte[] bytes, string? contentType, OfficeImageProjection projection, bool interpolate, string? alternativeText = null, double opacity = 1) #

Adds an image using explicit scaling interpolation behavior.

Parameters

bytes byte[] required
contentType string? required
projection OfficeIMO.Drawing.OfficeImageProjection required
interpolate bool required
alternativeText string? = null optional
opacity double = 1 optional
AddPositionedText 5 overloads
public OfficeDrawing AddPositionedText(string text, double x, double y, double width, double height, OfficeFontInfo? font, OfficeColor? color, OfficeTextAlignment alignment, double? lineHeight) #

Adds an already-positioned single text run. The frame width may be clipped independently from the resolved glyph advance retained for backend-consistent positioning.

Parameters

text string required
Text content to draw.
x double required
Horizontal frame position in drawing units.
y double required
Vertical frame position in drawing units.
width double required
Clipping frame width in drawing units.
height double required
Clipping frame height in drawing units.
font OfficeIMO.Drawing.OfficeFontInfo? required
Optional font descriptor.
color OfficeIMO.OfficeColor? required
Optional text color.
alignment OfficeIMO.Drawing.OfficeTextAlignment required
Horizontal alignment inside the frame.
lineHeight double? required
Optional resolved line height.

Returns

OfficeDrawing The current drawing.
public OfficeDrawing AddPositionedText(string text, double x, double y, double width, double height, OfficeFontInfo? font = null, OfficeColor? color = null, OfficeTextAlignment alignment = Left, double? lineHeight = null, double? textAdvanceWidth = null) #

Adds an already-positioned single text run with an explicit resolved glyph advance.

Parameters

text string required
Text content to draw.
x double required
Horizontal frame position in drawing units.
y double required
Vertical frame position in drawing units.
width double required
Clipping frame width in drawing units.
height double required
Clipping frame height in drawing units.
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
Optional font descriptor.
color OfficeIMO.OfficeColor? = null optional
Optional text color.
alignment OfficeIMO.Drawing.OfficeTextAlignment = Left optional
Horizontal alignment inside the frame.
lineHeight double? = null optional
Optional resolved line height.
textAdvanceWidth double? = null optional
Resolved horizontal glyph advance, or null to use width.

Returns

OfficeDrawing The current drawing.
public OfficeDrawing AddPositionedText(string text, double x, double y, double width, double height, OfficeFontInfo? font, OfficeColor? color, OfficeTextAlignment alignment, double? lineHeight, double? textAdvanceWidth, OfficeTextDecorationStyle underlineStyle, OfficeTextDecorationStyle strikethroughStyle, OfficeTextBaseline baseline) #

Adds an already-positioned text run with typed decoration and baseline styling.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? required
color OfficeIMO.OfficeColor? required
alignment OfficeIMO.Drawing.OfficeTextAlignment required
lineHeight double? required
textAdvanceWidth double? required
underlineStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
strikethroughStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
baseline OfficeIMO.Drawing.OfficeTextBaseline required
public OfficeDrawing AddPositionedText(string text, double x, double y, double width, double height, OfficeFontInfo? font, OfficeColor? color, OfficeTextAlignment alignment, double? lineHeight, double? textAdvanceWidth, OfficeTextDecorationStyle underlineStyle, OfficeTextDecorationStyle strikethroughStyle, OfficeTextBaseline baseline, int baselineLevel) #

Adds an already-positioned text run with typed decoration and a cumulative script nesting level.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? required
color OfficeIMO.OfficeColor? required
alignment OfficeIMO.Drawing.OfficeTextAlignment required
lineHeight double? required
textAdvanceWidth double? required
underlineStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
strikethroughStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
baseline OfficeIMO.Drawing.OfficeTextBaseline required
baselineLevel int required
public OfficeDrawing AddPositionedText(string text, double x, double y, double width, double height, OfficeImageFrameTransform frameTransform, OfficeFontInfo? font = null, OfficeColor? color = null, OfficeTextAlignment alignment = Left, double? lineHeight = null, double? textAdvanceWidth = null) #

Adds a resolved source text run with its glyph advance and a destination-space rotation or mirror transform. Source text is clipped, never shortened with an ellipsis.

Parameters

text string required
x double required
y double required
width double required
height double required
frameTransform OfficeIMO.Drawing.OfficeImageFrameTransform required
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
color OfficeIMO.OfficeColor? = null optional
alignment OfficeIMO.Drawing.OfficeTextAlignment = Left optional
lineHeight double? = null optional
textAdvanceWidth double? = null optional
public OfficeDrawing AddRichText(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) #

Adds rich text inside a local drawing rectangle and returns this drawing.

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
public OfficeDrawing AddRichTextBehindContent(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) #

Adds rich text behind existing foreground content while keeping an initial page background underneath it.

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
AddRichTextParagraphs 2 overloads
public OfficeDrawing AddRichTextParagraphs(IReadOnlyList<OfficeRichTextParagraph> paragraphs, double x, double y, double width, double height, OfficeTextVerticalAlignment verticalAlignment = Top, bool wrapText = true, OfficeTextPadding? padding = null) #

Adds paragraphs with independent styles and render-time font measurement inside one text frame.

Parameters

paragraphs System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRichTextParagraph> required
x double required
y double required
width double required
height double required
verticalAlignment OfficeIMO.Drawing.OfficeTextVerticalAlignment = Top optional
wrapText bool = true optional
padding OfficeIMO.Drawing.OfficeTextPadding? = null optional
public OfficeDrawing AddRichTextParagraphs(IReadOnlyList<OfficeRichTextParagraph> paragraphs, double x, double y, double width, double height, OfficeTextAreaAlignment areaAlignment, OfficeTextVerticalAlignment verticalAlignment = Top, bool wrapText = true, OfficeTextPadding? padding = null) #

Adds independently aligned paragraphs in an intrinsically sized text area inside one drawing frame.

Parameters

paragraphs System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRichTextParagraph> required
x double required
y double required
width double required
height double required
areaAlignment OfficeIMO.Drawing.OfficeTextAreaAlignment required
verticalAlignment OfficeIMO.Drawing.OfficeTextVerticalAlignment = Top optional
wrapText bool = true optional
padding OfficeIMO.Drawing.OfficeTextPadding? = null optional
public OfficeDrawing AddShape(OfficeShape shape, double x, double y) #

Adds a shape at a local top-left coordinate and returns this drawing.

Parameters

shape OfficeIMO.Drawing.OfficeShape required
x double required
y double required
public OfficeDrawing AddShapeBehindContent(OfficeShape shape, double x, double y) #

Adds a shape behind existing foreground content while keeping an initial page background underneath it.

Parameters

shape OfficeIMO.Drawing.OfficeShape required
x double required
y double required
AddStyledText 2 overloads
public OfficeDrawing AddStyledText(string text, double x, double y, double width, double height, OfficeFontInfo? font, OfficeColor? color, OfficeTextAlignment alignment, double? lineHeight, OfficeTextVerticalAlignment verticalAlignment, double rotationDegrees, double? rotationCenterX, double? rotationCenterY, bool wrapText, bool shrinkToFit, bool stackedText, bool flipHorizontal, bool flipVertical, OfficeTextPadding? padding, OfficeTextParagraphIndent? paragraphIndent, OfficeTextDecorationStyle underlineStyle, OfficeTextDecorationStyle strikethroughStyle, OfficeTextBaseline baseline) #

Adds text with typed decoration and baseline styling inside a local drawing rectangle.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? required
color OfficeIMO.OfficeColor? required
alignment OfficeIMO.Drawing.OfficeTextAlignment required
lineHeight double? required
verticalAlignment OfficeIMO.Drawing.OfficeTextVerticalAlignment required
rotationDegrees double required
rotationCenterX double? required
rotationCenterY double? required
wrapText bool required
shrinkToFit bool required
stackedText bool required
flipHorizontal bool required
flipVertical bool required
padding OfficeIMO.Drawing.OfficeTextPadding? required
paragraphIndent OfficeIMO.Drawing.OfficeTextParagraphIndent? required
underlineStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
strikethroughStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
baseline OfficeIMO.Drawing.OfficeTextBaseline required
public OfficeDrawing AddStyledText(string text, double x, double y, double width, double height, OfficeFontInfo? font, OfficeColor? color, OfficeTextAlignment alignment, double? lineHeight, OfficeTextVerticalAlignment verticalAlignment, double rotationDegrees, double? rotationCenterX, double? rotationCenterY, bool wrapText, bool shrinkToFit, bool stackedText, bool flipHorizontal, bool flipVertical, OfficeTextPadding? padding, OfficeTextParagraphIndent? paragraphIndent, OfficeTextDecorationStyle underlineStyle, OfficeTextDecorationStyle strikethroughStyle, OfficeTextBaseline baseline, int baselineLevel) #

Adds text with typed decoration and a cumulative script nesting level.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? required
color OfficeIMO.OfficeColor? required
alignment OfficeIMO.Drawing.OfficeTextAlignment required
lineHeight double? required
verticalAlignment OfficeIMO.Drawing.OfficeTextVerticalAlignment required
rotationDegrees double required
rotationCenterX double? required
rotationCenterY double? required
wrapText bool required
shrinkToFit bool required
stackedText bool required
flipHorizontal bool required
flipVertical bool required
padding OfficeIMO.Drawing.OfficeTextPadding? required
paragraphIndent OfficeIMO.Drawing.OfficeTextParagraphIndent? required
underlineStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
strikethroughStyle OfficeIMO.Drawing.OfficeTextDecorationStyle required
baseline OfficeIMO.Drawing.OfficeTextBaseline required
baselineLevel int required
AddText 2 overloads
public OfficeDrawing AddText(string text, double x, double y, double width, double height, OfficeFontInfo? font, OfficeColor? color, OfficeTextAlignment alignment, double? lineHeight) #

Adds unrotated text using the original public text-box contract.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? required
color OfficeIMO.OfficeColor? required
alignment OfficeIMO.Drawing.OfficeTextAlignment required
lineHeight double? required
public OfficeDrawing AddText(string text, double x, double y, double width, double height, OfficeFontInfo? font = null, OfficeColor? color = null, OfficeTextAlignment alignment = Left, double? lineHeight = null, OfficeTextVerticalAlignment verticalAlignment = Top, double rotationDegrees = 0, double? rotationCenterX = null, double? rotationCenterY = null, bool wrapText = false, bool shrinkToFit = false, bool stackedText = false, bool flipHorizontal = false, bool flipVertical = false, OfficeTextPadding? padding = null, OfficeTextParagraphIndent? paragraphIndent = null) #

Adds text inside a local drawing rectangle and returns this drawing.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
color OfficeIMO.OfficeColor? = null optional
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 = false optional
shrinkToFit bool = false optional
stackedText bool = false optional
flipHorizontal bool = false optional
flipVertical bool = false optional
padding OfficeIMO.Drawing.OfficeTextPadding? = null optional
paragraphIndent OfficeIMO.Drawing.OfficeTextParagraphIndent? = null optional
public OfficeDrawing AddTextBehindContent(string text, double x, double y, double width, double height, OfficeFontInfo? font = null, OfficeColor? color = null, OfficeTextAlignment alignment = Left, double? lineHeight = null, OfficeTextVerticalAlignment verticalAlignment = Top, double rotationDegrees = 0, double? rotationCenterX = null, double? rotationCenterY = null, bool wrapText = false, bool shrinkToFit = false, bool stackedText = false, bool flipHorizontal = false, bool flipVertical = false, OfficeTextPadding? padding = null, OfficeTextParagraphIndent? paragraphIndent = null) #

Adds text behind existing foreground content while keeping an initial page background underneath it.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
color OfficeIMO.OfficeColor? = null optional
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 = false optional
shrinkToFit bool = false optional
stackedText bool = false optional
flipHorizontal bool = false optional
flipVertical bool = false optional
padding OfficeIMO.Drawing.OfficeTextPadding? = null optional
paragraphIndent OfficeIMO.Drawing.OfficeTextParagraphIndent? = null optional
AddTilingPattern 2 overloads
public OfficeDrawing AddTilingPattern(OfficeDrawing tile, OfficeImagePlacement area, double horizontalStep, double verticalStep, OfficeTransform? transform = null, double originX = 0, double originY = 0, int maximumTileCount = 16384, double opacity = 1) #

Adds a clipped, transform-aware vector tiling pattern.

Parameters

tile OfficeIMO.Drawing.OfficeDrawing required
area OfficeIMO.Drawing.OfficeImagePlacement required
horizontalStep double required
verticalStep double required
transform OfficeIMO.Drawing.OfficeTransform? = null optional
originX double = 0 optional
originY double = 0 optional
maximumTileCount int = 16384 optional
opacity double = 1 optional
public OfficeDrawing AddTilingPattern(OfficeDrawing tile, OfficeImagePlacement area, double horizontalStep, double verticalStep, bool repeatX, bool repeatY, OfficeTransform? transform = null, double originX = 0, double originY = 0, int maximumTileCount = 16384, double opacity = 1) #

Adds a clipped, transform-aware vector tiling pattern with independent axis repetition.

Parameters

tile OfficeIMO.Drawing.OfficeDrawing required
area OfficeIMO.Drawing.OfficeImagePlacement required
horizontalStep double required
verticalStep double required
repeatX bool required
repeatY bool required
transform OfficeIMO.Drawing.OfficeTransform? = null optional
originX double = 0 optional
originY double = 0 optional
maximumTileCount int = 16384 optional
opacity double = 1 optional
public OfficeDrawing AddVerticalText(string text, double x, double y, double width, double height, OfficeFontInfo? font = null, OfficeColor? color = null) #

Adds top-to-bottom text whose glyph substitutions and advances come from the selected shaping provider.

Parameters

text string required
x double required
y double required
width double required
height double required
font OfficeIMO.Drawing.OfficeFontInfo? = null optional
color OfficeIMO.OfficeColor? = null optional
public OfficeDrawing Clone() #

Creates a detached copy of this drawing and all positioned elements.

public OfficeImageExportResult ToImage(OfficeImageExportFormat format, OfficeImageExportOptions? options = null, CancellationToken cancellationToken = default) #

Exports a detached drawing through the shared density, encoding, font, diagnostic and safety contracts. Options define the drawing's logical units per inch.

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Drawing.OfficeImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Properties

public double Width { get; } #

Drawing width in the caller's layout unit.

public double Height { get; } #

Drawing height in the caller's layout unit.

public IReadOnlyList<OfficeDrawingShape> Shapes { get; } #

Positioned shapes in paint order.

public IReadOnlyList<OfficeDrawingImage> Images { get; } #

Positioned images in paint order.

public IReadOnlyList<OfficeDrawingImagePattern> ImagePatterns { get; } #

Clipped image patterns in paint order.

public IReadOnlyList<OfficeDrawingElement> Elements { get; } #

Positioned drawing elements in paint order.

public OfficeFontFaceCollection Fonts { get; private set; } #

Scoped TrueType faces embedded or rasterized with this drawing.