Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeVisualPlacementExtensions

OfficeIMO.ChartForgeX

Namespace
OfficeIMO.ChartForgeX
Assembly
OfficeIMO.ChartForgeX
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Places converted ChartForgeX artifacts on OfficeIMO document surfaces.

Inheritance

  • object
  • OfficeVisualPlacementExtensions

Methods

AddVisualArtifact 21 overloads
public static WordImage AddVisualArtifact(WordParagraph paragraph, VisualArtifact artifact, OfficeVisualConversionOptions? options = null, WordImageTextWrapping wrapping = InLineWithText) #

Inserts a visual in Word, constraining its natural width to the paragraph's content area when no size is supplied.

Parameters

paragraph OfficeIMO.Word.WordParagraph required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
wrapping OfficeIMO.Word.WordImageTextWrapping = InLineWithText optional

Returns

WordImage
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, int row, int column, VisualArtifact artifact, OfficeVisualConversionOptions? options = null, OfficeLength offsetX = default, OfficeLength offsetY = default) #

Inserts a visual anchored to a worksheet cell.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
row int required
column int required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
offsetX OfficeIMO.OfficeLength = default optional
offsetY OfficeIMO.OfficeLength = default optional

Returns

ExcelImage
public static PowerPointImage AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, double leftPoints = 0, double topPoints = 0, OfficeVisualConversionOptions? options = null) #

Inserts a visual at a slide position expressed in points.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
leftPoints double = 0 optional
topPoints double = 0 optional
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional

Returns

PowerPointImage
public static PdfContentBuilder AddVisualArtifact(PdfContentBuilder content, VisualArtifact artifact, OfficeVisualConversionOptions? options = null, OfficeAlignment? align = null, double? spacingBefore = null, double? spacingAfter = null, PdfDrawingStyle? style = null, string? linkUri = null, string? linkContents = null) #

Adds a visual to PDF flow, with proportional width constrained to the actual content frame by default.

Parameters

content OfficeIMO.Pdf.PdfContentBuilder required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
align OfficeIMO.OfficeAlignment? = null optional
spacingBefore double? = null optional
spacingAfter double? = null optional
style OfficeIMO.Pdf.PdfDrawingStyle? = null optional
linkUri string? = null optional
linkContents string? = null optional

Returns

PdfContentBuilder
public static PdfDocument AddVisualArtifact(PdfDocument document, VisualArtifact artifact, OfficeVisualConversionOptions? options = null, OfficeAlignment? align = null, double? spacingBefore = null, double? spacingAfter = null, PdfDrawingStyle? style = null, string? linkUri = null, string? linkContents = null) #

Adds a visual to an existing PDF document's flow.

Parameters

document OfficeIMO.Pdf.PdfDocument required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
align OfficeIMO.OfficeAlignment? = null optional
spacingBefore double? = null optional
spacingAfter double? = null optional
style OfficeIMO.Pdf.PdfDrawingStyle? = null optional
linkUri string? = null optional
linkContents string? = null optional

Returns

PdfDocument
public static WordImage AddVisualArtifact(WordParagraph paragraph, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, WordImageTextWrapping wrapping = InLineWithText) #

Renders and inserts a ChartForgeX artifact in a Word paragraph, returning its conversion and fidelity report.

Parameters

paragraph OfficeIMO.Word.WordParagraph required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
wrapping OfficeIMO.Word.WordImageTextWrapping = InLineWithText optional

Returns

WordImage
public static WordImage AddVisualArtifact(WordParagraph paragraph, OfficeVisualConversionResult conversion, WordImageTextWrapping wrapping = InLineWithText) #

Inserts a converted ChartForgeX artifact using its selected SVG or PNG payload in a Word paragraph.

Parameters

paragraph OfficeIMO.Word.WordParagraph required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
wrapping OfficeIMO.Word.WordImageTextWrapping = InLineWithText optional

Returns

WordImage
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, int row, int column, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, OfficeLength offsetX = default, OfficeLength offsetY = default) #

Renders and inserts a ChartForgeX artifact anchored to an Excel cell, returning its conversion and fidelity report.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
row int required
column int required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
offsetX OfficeIMO.OfficeLength = default optional
offsetY OfficeIMO.OfficeLength = default optional

Returns

ExcelImage
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, int row, int column, OfficeVisualConversionResult conversion, OfficeLength offsetX = default, OfficeLength offsetY = default) #

Inserts a converted ChartForgeX artifact using its selected SVG or PNG payload anchored to an Excel cell.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
row int required
column int required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
offsetX OfficeIMO.OfficeLength = default optional
offsetY OfficeIMO.OfficeLength = default optional

Returns

ExcelImage
public static PowerPointImage AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, double leftPoints, double topPoints, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null) #

Renders and inserts a ChartForgeX artifact on a PowerPoint slide, returning its conversion and fidelity report.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
leftPoints double required
topPoints double required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional

Returns

PowerPointImage
public static PowerPointImage AddVisualArtifact(PowerPointSlide slide, OfficeVisualConversionResult conversion, double leftPoints = 0, double topPoints = 0) #

Inserts a converted ChartForgeX artifact using its selected SVG or PNG payload on a PowerPoint slide.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
leftPoints double = 0 optional
topPoints double = 0 optional

Returns

PowerPointImage
public static PdfContentBuilder AddVisualArtifact(PdfContentBuilder content, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, OfficeAlignment? align = null, double? spacingBefore = null, double? spacingAfter = null, PdfDrawingStyle? style = null, string? linkUri = null, string? linkContents = null) #

Renders and adds a ChartForgeX artifact to PDF flow content through the OfficeDrawing composition path.

Parameters

content OfficeIMO.Pdf.PdfContentBuilder required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
align OfficeIMO.OfficeAlignment? = null optional
spacingBefore double? = null optional
spacingAfter double? = null optional
style OfficeIMO.Pdf.PdfDrawingStyle? = null optional
linkUri string? = null optional
linkContents string? = null optional

Returns

PdfContentBuilder
public static PdfContentBuilder AddVisualArtifact(PdfContentBuilder content, OfficeVisualConversionResult conversion, OfficeAlignment? align = null, double? spacingBefore = null, double? spacingAfter = null, PdfDrawingStyle? style = null, string? linkUri = null, string? linkContents = null) #

Adds a converted ChartForgeX artifact to PDF flow content through the OfficeDrawing composition path.

Parameters

content OfficeIMO.Pdf.PdfContentBuilder required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
align OfficeIMO.OfficeAlignment? = null optional
spacingBefore double? = null optional
spacingAfter double? = null optional
style OfficeIMO.Pdf.PdfDrawingStyle? = null optional
linkUri string? = null optional
linkContents string? = null optional

Returns

PdfContentBuilder
public static PdfDocument AddVisualArtifact(PdfDocument document, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, OfficeAlignment? align = null, double? spacingBefore = null, double? spacingAfter = null, PdfDrawingStyle? style = null, string? linkUri = null, string? linkContents = null) #

Renders and adds a ChartForgeX artifact to an existing PDF document.

Parameters

document OfficeIMO.Pdf.PdfDocument required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional
align OfficeIMO.OfficeAlignment? = null optional
spacingBefore double? = null optional
spacingAfter double? = null optional
style OfficeIMO.Pdf.PdfDrawingStyle? = null optional
linkUri string? = null optional
linkContents string? = null optional

Returns

PdfDocument
public static PdfDocument AddVisualArtifact(PdfDocument document, OfficeVisualConversionResult conversion, OfficeAlignment? align = null, double? spacingBefore = null, double? spacingAfter = null, PdfDrawingStyle? style = null, string? linkUri = null, string? linkContents = null) #

Adds a converted ChartForgeX artifact to an existing PDF document.

Parameters

document OfficeIMO.Pdf.PdfDocument required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
align OfficeIMO.OfficeAlignment? = null optional
spacingBefore double? = null optional
spacingAfter double? = null optional
style OfficeIMO.Pdf.PdfDrawingStyle? = null optional
linkUri string? = null optional
linkContents string? = null optional

Returns

PdfDocument
public static PowerPointImage AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, PowerPointLayoutBox box, OfficeVisualConversionOptions? options = null) #

Inserts a visual proportionally inside a slide layout box.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
box OfficeIMO.PowerPoint.PowerPointLayoutBox required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional

Returns

PowerPointImage
public static PowerPointImage AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, PowerPointLayoutBox box, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null) #

Converts a visual and inserts it inside a slide layout box, returning the fitted conversion for inspection.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
box OfficeIMO.PowerPoint.PowerPointLayoutBox required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional

Returns

PowerPointImage
public static PowerPointImage AddVisualArtifact(PowerPointSlide slide, OfficeVisualConversionResult conversion, PowerPointLayoutBox box, OfficeImageFit fit = Contain) #

Places a reusable conversion inside a slide layout box without rendering it again.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
box OfficeIMO.PowerPoint.PowerPointLayoutBox required
fit OfficeIMO.Drawing.OfficeImageFit = Contain optional

Returns

PowerPointImage
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, string range, VisualArtifact artifact, OfficeVisualConversionOptions? options = null) #

Inserts a visual proportionally inside an authored worksheet range.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
range string required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional

Returns

ExcelImage
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, string range, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null) #

Converts and inserts a visual inside a worksheet range, returning the fitted conversion for inspection.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
range string required
artifact ChartForgeX.VisualArtifacts.VisualArtifact required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optional

Returns

ExcelImage
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, string range, OfficeVisualConversionResult conversion, OfficeImageFit fit = Contain) #

Places a reusable conversion inside a worksheet range without rendering it again.

Parameters

sheet OfficeIMO.Excel.ExcelSheet required
range string required
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult required
fit OfficeIMO.Drawing.OfficeImageFit = Contain optional

Returns

ExcelImage