Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeVisualPlacementExtensions

Namespace OfficeIMO.ChartForgeX
Assembly OfficeIMO.ChartForgeX
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) #
Returns: WordImage

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 requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 2
wrapping OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 3
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, Int32 row, Int32 column, VisualArtifact artifact, OfficeVisualConversionOptions? options = null, Int32 offsetXPixels = 0, Int32 offsetYPixels = 0) #
Returns: ExcelImage

Inserts a visual anchored to a worksheet cell.

Parameters

sheet OfficeIMO.Excel.ExcelSheet requiredposition: 0
row System.Int32 requiredposition: 1
column System.Int32 requiredposition: 2
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 3
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 4
offsetXPixels System.Int32 = 0 optionalposition: 5
offsetYPixels System.Int32 = 0 optionalposition: 6
public static PowerPointPicture AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, Double leftPoints = 0, Double topPoints = 0, OfficeVisualConversionOptions? options = null) #
Returns: PowerPointPicture

Inserts a visual at a slide position expressed in points.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
leftPoints System.Double = 0 optionalposition: 2
topPoints System.Double = 0 optionalposition: 3
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 4
public static PdfContentBuilder AddVisualArtifact(PdfContentBuilder content, VisualArtifact artifact, OfficeVisualConversionOptions? options = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
Returns: PdfContentBuilder

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

Parameters

content OfficeIMO.Pdf.PdfContentBuilder requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 2
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 3
spacingBefore System.Double? = null optionalposition: 4
spacingAfter System.Double? = null optionalposition: 5
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 6
linkUri System.String? = null optionalposition: 7
linkContents System.String? = null optionalposition: 8
public static PdfDocument AddVisualArtifact(PdfDocument document, VisualArtifact artifact, OfficeVisualConversionOptions? options = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
Returns: PdfDocument

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

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 2
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 3
spacingBefore System.Double? = null optionalposition: 4
spacingAfter System.Double? = null optionalposition: 5
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 6
linkUri System.String? = null optionalposition: 7
linkContents System.String? = null optionalposition: 8
public static WordImage AddVisualArtifact(WordParagraph paragraph, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, WordImageTextWrapping wrapping = InLineWithText) #
Returns: WordImage

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

Parameters

paragraph OfficeIMO.Word.WordParagraph requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 2
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 3
wrapping OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 4
public static WordImage AddVisualArtifact(WordParagraph paragraph, OfficeVisualConversionResult conversion, WordImageTextWrapping wrapping = InLineWithText) #
Returns: WordImage

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

Parameters

paragraph OfficeIMO.Word.WordParagraph requiredposition: 0
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 1
wrapping OfficeIMO.Word.WordImageTextWrapping = InLineWithText optionalposition: 2
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, Int32 row, Int32 column, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, Int32 offsetXPixels = 0, Int32 offsetYPixels = 0) #
Returns: ExcelImage

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet requiredposition: 0
row System.Int32 requiredposition: 1
column System.Int32 requiredposition: 2
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 3
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 4
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 5
offsetXPixels System.Int32 = 0 optionalposition: 6
offsetYPixels System.Int32 = 0 optionalposition: 7
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, Int32 row, Int32 column, OfficeVisualConversionResult conversion, Int32 offsetXPixels = 0, Int32 offsetYPixels = 0) #
Returns: ExcelImage

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet requiredposition: 0
row System.Int32 requiredposition: 1
column System.Int32 requiredposition: 2
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 3
offsetXPixels System.Int32 = 0 optionalposition: 4
offsetYPixels System.Int32 = 0 optionalposition: 5
public static PowerPointPicture AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, Double leftPoints, Double topPoints, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null) #
Returns: PowerPointPicture

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

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
leftPoints System.Double requiredposition: 2
topPoints System.Double requiredposition: 3
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 4
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 5
public static PowerPointPicture AddVisualArtifact(PowerPointSlide slide, OfficeVisualConversionResult conversion, Double leftPoints = 0, Double topPoints = 0) #
Returns: PowerPointPicture

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

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide requiredposition: 0
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 1
leftPoints System.Double = 0 optionalposition: 2
topPoints System.Double = 0 optionalposition: 3
public static PdfContentBuilder AddVisualArtifact(PdfContentBuilder content, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
Returns: PdfContentBuilder

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

Parameters

content OfficeIMO.Pdf.PdfContentBuilder requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 2
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 3
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 4
spacingBefore System.Double? = null optionalposition: 5
spacingAfter System.Double? = null optionalposition: 6
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 7
linkUri System.String? = null optionalposition: 8
linkContents System.String? = null optionalposition: 9
public static PdfContentBuilder AddVisualArtifact(PdfContentBuilder content, OfficeVisualConversionResult conversion, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
Returns: PdfContentBuilder

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

Parameters

content OfficeIMO.Pdf.PdfContentBuilder requiredposition: 0
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 1
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 2
spacingBefore System.Double? = null optionalposition: 3
spacingAfter System.Double? = null optionalposition: 4
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 5
linkUri System.String? = null optionalposition: 6
linkContents System.String? = null optionalposition: 7
public static PdfDocument AddVisualArtifact(PdfDocument document, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
Returns: PdfDocument

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

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 2
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 3
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 4
spacingBefore System.Double? = null optionalposition: 5
spacingAfter System.Double? = null optionalposition: 6
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 7
linkUri System.String? = null optionalposition: 8
linkContents System.String? = null optionalposition: 9
public static PdfDocument AddVisualArtifact(PdfDocument document, OfficeVisualConversionResult conversion, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
Returns: PdfDocument

Adds a converted ChartForgeX artifact to an existing PDF document.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 1
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 2
spacingBefore System.Double? = null optionalposition: 3
spacingAfter System.Double? = null optionalposition: 4
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 5
linkUri System.String? = null optionalposition: 6
linkContents System.String? = null optionalposition: 7
public static PowerPointPicture AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, PowerPointLayoutBox box, OfficeVisualConversionOptions? options = null) #
Returns: PowerPointPicture

Inserts a visual proportionally inside a slide layout box.

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
box OfficeIMO.PowerPoint.PowerPointLayoutBox requiredposition: 2
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 3
public static PowerPointPicture AddVisualArtifact(PowerPointSlide slide, VisualArtifact artifact, PowerPointLayoutBox box, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null) #
Returns: PowerPointPicture

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

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide requiredposition: 0
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 1
box OfficeIMO.PowerPoint.PowerPointLayoutBox requiredposition: 2
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 3
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 4
public static PowerPointPicture AddVisualArtifact(PowerPointSlide slide, OfficeVisualConversionResult conversion, PowerPointLayoutBox box, OfficeImageFit fit = Contain) #
Returns: PowerPointPicture

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

Parameters

slide OfficeIMO.PowerPoint.PowerPointSlide requiredposition: 0
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 1
box OfficeIMO.PowerPoint.PowerPointLayoutBox requiredposition: 2
fit OfficeIMO.Drawing.OfficeImageFit = Contain optionalposition: 3
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, String range, VisualArtifact artifact, OfficeVisualConversionOptions? options = null) #
Returns: ExcelImage

Inserts a visual proportionally inside an authored worksheet range.

Parameters

sheet OfficeIMO.Excel.ExcelSheet requiredposition: 0
range System.String requiredposition: 1
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 2
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 3
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, String range, VisualArtifact artifact, out OfficeVisualConversionResult conversion, OfficeVisualConversionOptions? options = null) #
Returns: ExcelImage

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet requiredposition: 0
range System.String requiredposition: 1
artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 2
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 3
options OfficeIMO.ChartForgeX.OfficeVisualConversionOptions? = null optionalposition: 4
public static ExcelImage AddVisualArtifact(ExcelSheet sheet, String range, OfficeVisualConversionResult conversion, OfficeImageFit fit = Contain) #
Returns: ExcelImage

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

Parameters

sheet OfficeIMO.Excel.ExcelSheet requiredposition: 0
range System.String requiredposition: 1
conversion OfficeIMO.ChartForgeX.OfficeVisualConversionResult requiredposition: 2
fit OfficeIMO.Drawing.OfficeImageFit = Contain optionalposition: 3