Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 571 stars PSWriteOfficePowerShell module 164 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

OfficeImageComposer

Edit on GitHub
Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Source OfficeImageComposer.cs:22
Modifiers static

Shared dependency-free image page composer for raster and SVG layer output.

Inheritance

  • Object
  • OfficeImageComposer

Methods

public static Byte[] ComposePng(Int32 width, Int32 height, OfficeColor backgroundColor, IEnumerable<OfficeImageLayer> layers, Action<OfficeRasterCanvas>? beforeLayers = null, Action<OfficeRasterCanvas>? afterLayers = null) #
OfficeImageComposer.cs:22
Returns: Byte[]

Composes raster layers onto a new image and returns encoded PNG bytes.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
backgroundColor OfficeIMO.Drawing.OfficeColor requiredposition: 2
layers System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficeImageLayer> requiredposition: 3
beforeLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? = null optionalposition: 4
afterLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? = null optionalposition: 5
ComposeRaster 3 overloads
public static OfficeRasterImage ComposeRaster(Int32 width, Int32 height, OfficeColor backgroundColor, IEnumerable<OfficeImageLayer> layers, Action<OfficeRasterCanvas>? beforeLayers = null, Action<OfficeRasterCanvas>? afterLayers = null) #
OfficeImageComposer.cs:34
Returns: OfficeRasterImage

Composes raster layers onto a new image.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
backgroundColor OfficeIMO.Drawing.OfficeColor requiredposition: 2
layers System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficeImageLayer> requiredposition: 3
beforeLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? = null optionalposition: 4
afterLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? = null optionalposition: 5
public static OfficeRasterImage ComposeRaster(Int32 width, Int32 height, OfficeColor backgroundColor, IEnumerable<OfficeImageLayer> layers, Action<OfficeRasterCanvas>? beforeLayers, Action<OfficeRasterCanvas>? afterLayers, OfficeFontFaceCollection? fonts) #
OfficeImageComposer.cs:47
Returns: OfficeRasterImage

Composes raster layers using scoped fonts for text drawn by the layer callbacks.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
backgroundColor OfficeIMO.Drawing.OfficeColor requiredposition: 2
layers System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficeImageLayer> requiredposition: 3
beforeLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? requiredposition: 4
afterLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? requiredposition: 5
fonts OfficeIMO.Drawing.OfficeFontFaceCollection? requiredposition: 6
public static OfficeRasterImage ComposeRaster(Int32 width, Int32 height, OfficeColor backgroundColor, IEnumerable<OfficeImageLayer> layers, Action<OfficeRasterCanvas>? beforeLayers, Action<OfficeRasterCanvas>? afterLayers, OfficeFontFaceCollection? fonts, CancellationToken cancellationToken) #
OfficeImageComposer.cs:61
Returns: OfficeRasterImage

Composes raster layers using scoped fonts and observes cancellation throughout raster drawing.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
backgroundColor OfficeIMO.Drawing.OfficeColor requiredposition: 2
layers System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficeImageLayer> requiredposition: 3
beforeLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? requiredposition: 4
afterLayers System.Action<OfficeIMO.Drawing.OfficeRasterCanvas>? requiredposition: 5
fonts OfficeIMO.Drawing.OfficeFontFaceCollection? requiredposition: 6
cancellationToken System.Threading.CancellationToken requiredposition: 7
public static String ComposeSvg(Int32 width, Int32 height, OfficeColor backgroundColor, IEnumerable<OfficeImageLayer> layers, Action<StringBuilder>? beforeLayers = null, Action<StringBuilder>? afterLayers = null) #
OfficeImageComposer.cs:131
Returns: String

Composes SVG layers into a root SVG document.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
backgroundColor OfficeIMO.Drawing.OfficeColor requiredposition: 2
layers System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficeImageLayer> requiredposition: 3
beforeLayers System.Action<System.Text.StringBuilder>? = null optionalposition: 4
afterLayers System.Action<System.Text.StringBuilder>? = null optionalposition: 5
public static Byte[] ComposeSvgBytes(Int32 width, Int32 height, OfficeColor backgroundColor, IEnumerable<OfficeImageLayer> layers, Action<StringBuilder>? beforeLayers = null, Action<StringBuilder>? afterLayers = null) #
OfficeImageComposer.cs:93
Returns: Byte[]

Composes SVG layers into a root SVG document and returns UTF-8 encoded bytes.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
backgroundColor OfficeIMO.Drawing.OfficeColor requiredposition: 2
layers System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficeImageLayer> requiredposition: 3
beforeLayers System.Action<System.Text.StringBuilder>? = null optionalposition: 4
afterLayers System.Action<System.Text.StringBuilder>? = null optionalposition: 5