Class

PowerPointSlide

OfficeIMO.PowerPoint

Edit on GitHub

Namespace: OfficeIMO.PowerPoint
Assembly: OfficeIMO.PowerPoint
Source revision: 0eef6a5756b9 with working tree changes
Source: PowerPointSlide.cs:77

Represents a single slide in a presentation.

Inheritance

object
PowerPointSlide

Usage

Explore 33 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 12

Property PowerPointCompositionResult.Slides
Property PowerPointCustomShow.Slides
Method PowerPointDocument.AddSlide
Method PowerPointDocument.AddSlides
Method PowerPointDocument.DuplicateSlide
Method PowerPointDocument.ImportSlide
Method PowerPointDocument.ImportSlides
Property PowerPointDocument.Slides
Property PowerPointPaginatedTableResult.Slides
Property PowerPointSlideCompositionContext.Slide
Property PowerPointSlideLayout.Slides
Property PowerPointTablePaginationOptions.ConfigureSlide

Accepted by parameters 21

Method PowerPointAutoShape.SetHyperlink parameter targetSlide
Method PowerPointChart.SetHyperlink parameter targetSlide
Method PowerPointConnectionShape.SetHyperlink parameter targetSlide
Method PowerPointCustomShow.AddSlide parameter slide
Method PowerPointCustomShow.InsertSlide parameter slide
Method PowerPointCustomShow.RemoveSlide parameter slide
Method PowerPointCustomShow.SetSlides parameter slides
Method PowerPointDocument.AddClassicComment parameter slide
Method PowerPointDocument.AddCustomShow parameter slides
Method PowerPointDocument.AddModernComment parameter slide
Method PowerPointDocument.GetClassicComments parameter slide
Method PowerPointDocument.GetModernComments parameter slide
Method PowerPointGroupShape.SetHyperlink parameter targetSlide
Method PowerPointImage.SetHyperlink parameter targetSlide
Method PowerPointMedia.SetHyperlink parameter targetSlide
Method PowerPointOleObject.SetHyperlink parameter targetSlide
Method PowerPointShape.SetHyperlink parameter targetSlide
Method PowerPointSmartArt.SetHyperlink parameter targetSlide
Method PowerPointTable.SetHyperlink parameter targetSlide
Method PowerPointTextBox.SetHyperlink parameter targetSlide
Method PowerPointTextRun.SetHyperlink parameter targetSlide

Methods

AddAudio 2 overloads

public PowerPointMedia AddAudio(string audioPath, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Media.cs:50

Adds an embedded audio file to the slide.

Parameters

audioPath string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointMedia

public PowerPointMedia AddAudio(Stream audio, string contentType, string extension, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Media.cs:64

Adds an embedded audio stream to the slide.

Parameters

audio System.IO.Stream required
contentType string required
extension string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointMedia

AddChart 2 overloads

public PowerPointChart AddChart(OfficeChartType chartKind, OfficeChartData data) #

PowerPointSlide.SharedCharts.cs:8

Adds an editable native chart with the format's default title, size and placement.

Parameters

chartKind OfficeIMO.OfficeChartType required
data OfficeIMO.Drawing.OfficeChartData required

Returns

PowerPointChart

public PowerPointChart AddChart(OfficeChartType chartKind, OfficeChartData data, OfficeChartOptions? options) #

PowerPointSlide.SharedCharts.cs:15

Adds a native chart from the shared OfficeIMO chart contract. Supports all shared chart kinds, per-series combo kinds, and primary or secondary value axes where the selected families are compatible.

Parameters

chartKind OfficeIMO.OfficeChartType required
data OfficeIMO.Drawing.OfficeChartData required
options OfficeIMO.OfficeChartOptions? required

Returns

PowerPointChart

AddChart``1 2 overloads

public PowerPointChart AddChart<T>(OfficeChartType type, IEnumerable<T?> data, string category, params string[] series) #

PowerPointSlide.TypedCharts.cs:14

Adds an editable native chart using property names, including names supplied with nameof.

Type Parameters

T

Parameters

type OfficeIMO.OfficeChartType required
data System.Collections.Generic.IEnumerable<T?> required
category string required
series string[] required

Returns

PowerPointChart

public PowerPointChart AddChart<T>(OfficeChartType type, IEnumerable<T?> data, string category, OfficeChartOptions? options, params string[] series)

PowerPointSlide.TypedCharts.cs:24

Adds an editable native chart using property names and shared or format-specific options.

Type Parameters

T

Parameters

type OfficeIMO.OfficeChartType required
data System.Collections.Generic.IEnumerable<T?> required
category string required
options OfficeIMO.OfficeChartOptions? required
series string[] required

Returns

PowerPointChart

AddChart``2 2 overloads

public PowerPointChart AddChart<T, TCategory>(OfficeChartType type, IEnumerable<T?> data, Func<T?, TCategory?> category, params OfficeSeries[] series)

PowerPointSlide.TypedCharts.cs:9

Adds an editable native chart from typed category data and numeric series.

Type Parameters

T
TCategory

Parameters

type OfficeIMO.OfficeChartType required
data System.Collections.Generic.IEnumerable<T?> required
category System.Func<T?, TCategory?> required
series OfficeIMO.OfficeSeries[] required

Returns

PowerPointChart

public PowerPointChart AddChart<T, TCategory>(OfficeChartType type, IEnumerable<T?> data, Func<T?, TCategory?> category, OfficeChartOptions? options, params OfficeSeries[] series)

PowerPointSlide.TypedCharts.cs:19

Adds an editable native chart from typed data with a title, size and optional format-specific placement.

Type Parameters

T
TCategory

Parameters

type OfficeIMO.OfficeChartType required
data System.Collections.Generic.IEnumerable<T?> required
category System.Func<T?, TCategory?> required
options OfficeIMO.OfficeChartOptions? required
series OfficeIMO.OfficeSeries[] required

Returns

PowerPointChart

public PowerPointClassicAnimation AddClassicAnimation(PowerPointShape shape, PowerPointClassicAnimationEffect effect, PowerPointClassicAnimationOptions? options = null)

PowerPointSlide.ClassicAnimations.cs:21

Adds or replaces the classic animation for a shape on this slide.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
effect OfficeIMO.PowerPoint.PowerPointClassicAnimationEffect required
options OfficeIMO.PowerPoint.PowerPointClassicAnimationOptions? = null optional

Returns

PowerPointClassicAnimation

AddCommandAnimation 2 overloads

public PowerPointTimelineAction AddCommandAnimation(PowerPointShape shape, string command, PowerPointTimelineOptions? options = null)

PowerPointSlide.AnimationTimeline.cs:77

Adds a native command action targeted at a shape.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
command string required
options OfficeIMO.PowerPoint.PowerPointTimelineOptions? = null optional

Returns

PowerPointTimelineAction

public PowerPointTimelineAction AddCommandAnimation(PowerPointShape shape, string command, PowerPointAnimationCommand type, PowerPointTimelineOptions? options = null)

PowerPointSlide.AnimationTimeline.cs:83

Adds a native command action of the requested command type.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
command string required
type OfficeIMO.PowerPoint.PowerPointAnimationCommand required
options OfficeIMO.PowerPoint.PowerPointTimelineOptions? = null optional

Returns

PowerPointTimelineAction

AddConnector 3 overloads

public PowerPointConnectionShape AddConnector(PowerPointShape from, PowerPointShape to, PowerPointConnectorKind kind) #

PowerPointSlide.Connectors.cs:13

Adds a connector glued to the closest facing connection sites of two shapes. Moving or resizing either shape through this API keeps the connector attached.

Parameters

from OfficeIMO.PowerPoint.PowerPointShape required
to OfficeIMO.PowerPoint.PowerPointShape required
kind OfficeIMO.PowerPoint.PowerPointConnectorKind required

Returns

PowerPointConnectionShape

public PowerPointConnectionShape AddConnector(PowerPointShape from, int fromSite, PowerPointShape to, int toSite, PowerPointConnectorKind kind)

PowerPointSlide.Connectors.cs:25

Adds a connector glued to the given connection sites (see PowerPointShape.ConnectionSites). Moving or resizing either shape through this API keeps the connector attached.

Parameters

from OfficeIMO.PowerPoint.PowerPointShape required
fromSite int required
to OfficeIMO.PowerPoint.PowerPointShape required
toSite int required
kind OfficeIMO.PowerPoint.PowerPointConnectorKind required

Returns

PowerPointConnectionShape

public PowerPointConnectionShape AddConnector(OfficeLength startX, OfficeLength startY, OfficeLength endX, OfficeLength endY, PowerPointConnectorKind kind)

PowerPointSlide.Connectors.cs:43

Adds a free connector between two points.

Parameters

startX OfficeIMO.OfficeLength required
startY OfficeIMO.OfficeLength required
endX OfficeIMO.OfficeLength required
endY OfficeIMO.OfficeLength required
kind OfficeIMO.PowerPoint.PowerPointConnectorKind required

Returns

PowerPointConnectionShape

public PowerPointAutoShape AddCustomGeometry(OfficeShape geometry, OfficeLength left, OfficeLength top, OfficeLength width, OfficeLength height, string? name = null)

PowerPointSlide.CustomGeometry.cs:20

Adds an editable PowerPoint custom-geometry shape from a shared drawing path or polygon. The shared descriptor supplies the geometry and basic fill/stroke styling; the supplied bounds control its size and placement on the slide.

Parameters

geometry OfficeIMO.Drawing.OfficeShape required
left OfficeIMO.OfficeLength required
top OfficeIMO.OfficeLength required
width OfficeIMO.OfficeLength required
height OfficeIMO.OfficeLength required
name string? = null optional

Returns

PowerPointAutoShape

public PowerPointAutoShape AddEllipse(OfficeLength left, OfficeLength top, OfficeLength width, OfficeLength height, string? name = null)

PowerPointSlide.Shapes.cs:77

Adds an ellipse shape.

Parameters

left OfficeIMO.OfficeLength required
top OfficeIMO.OfficeLength required
width OfficeIMO.OfficeLength required
height OfficeIMO.OfficeLength required
name string? = null optional

Returns

PowerPointAutoShape

AddImage 5 overloads

public PowerPointImage AddImage(string imagePath, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Images.cs:14

Adds an image from the given file path.

Parameters

imagePath string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointImage

public PowerPointImage AddImage(Stream image, OfficeImageFormat imageType, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Images.cs:86

Adds an image from the provided stream.

Parameters

image System.IO.Stream required: Stream containing the image data.
imageType OfficeIMO.Drawing.OfficeImageFormat required: Image format of the stream.
left OfficeIMO.OfficeLength? = null optional: Left position as a physical length.
top OfficeIMO.OfficeLength? = null optional: Top position as a physical length.
width OfficeIMO.OfficeLength? = null optional: Width as a physical length.
height OfficeIMO.OfficeLength? = null optional: Height as a physical length.

Returns

PowerPointImage

public PowerPointImage AddImage(string imagePath, PowerPointLayoutBox layout) #

PowerPointSlide.Images.cs:149

Adds an image using a layout box.

Parameters

imagePath string required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointImage

public PowerPointImage AddImage(Stream image, OfficeImageFormat imageType, PowerPointLayoutBox layout) #

PowerPointSlide.Images.cs:156

Adds an image from a stream using a layout box.

Parameters

image System.IO.Stream required
imageType OfficeIMO.Drawing.OfficeImageFormat required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointImage

public PowerPointImage AddImage(PowerPointImageAsset asset, PowerPointLayoutBox bounds) #

PowerPointSlide.SemanticImages.cs:9

Adds a semantic image with deterministic fit/fill behavior, focal-point crop, and alternative text.

Parameters

asset OfficeIMO.PowerPoint.PowerPointImageAsset required
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointImage

public PowerPointAutoShape AddLine(OfficeLength startX, OfficeLength startY, OfficeLength endX, OfficeLength endY, string? name = null)

PowerPointSlide.Shapes.cs:85

Adds a line shape from the specified start and end points.

Parameters

startX OfficeIMO.OfficeLength required
startY OfficeIMO.OfficeLength required
endX OfficeIMO.OfficeLength required
endY OfficeIMO.OfficeLength required
name string? = null optional

Returns

PowerPointAutoShape

public PowerPointMedia AddLinkedAudio(Uri source, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Media.cs:72

Adds a linked audio frame without copying the payload into the package.

Parameters

source System.Uri required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointMedia

public PowerPointOleObject AddLinkedOleObject(Uri source, string progId, bool autoUpdate = false, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.OleObjects.cs:111

Adds a linked OLE object while retaining the external payload URI.

Parameters

source System.Uri required
progId string required
autoUpdate bool = false optional
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointOleObject

public PowerPointMedia AddLinkedVideo(Uri source, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Media.cs:79

Adds a linked video frame without copying the payload into the package.

Parameters

source System.Uri required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointMedia

public PowerPointTimelineAction AddMotionAnimation(PowerPointShape shape, string path, PowerPointTimelineOptions? options = null)

PowerPointSlide.AnimationTimeline.cs:46

Adds a native motion-path action without replacing the existing timeline.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
path string required
options OfficeIMO.PowerPoint.PowerPointTimelineOptions? = null optional

Returns

PowerPointTimelineAction

public PowerPointOleObject AddOleObject(Stream storage, string progId, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null, string contentType = "application/vnd.openxmlformats-officedocument.oleObject")

PowerPointSlide.OleObjects.cs:16

Adds an embedded OLE compound storage to the slide.

Parameters

storage System.IO.Stream required
progId string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
contentType string = "application/vnd.openxmlformats-officedocument.oleObject" optional

Returns

PowerPointOleObject

public PowerPointAutoShape AddRectangle(OfficeLength left, OfficeLength top, OfficeLength width, OfficeLength height, string? name = null)

PowerPointSlide.Shapes.cs:69

Adds a rectangle shape.

Parameters

left OfficeIMO.OfficeLength required
top OfficeIMO.OfficeLength required
width OfficeIMO.OfficeLength required
height OfficeIMO.OfficeLength required
name string? = null optional

Returns

PowerPointAutoShape

public PowerPointTimelineAction AddRotationAnimation(PowerPointShape shape, double degrees, PowerPointTimelineOptions? options = null)

PowerPointSlide.AnimationTimeline.cs:63

Adds a native rotation action without replacing the existing timeline.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
degrees double required
options OfficeIMO.PowerPoint.PowerPointTimelineOptions? = null optional

Returns

PowerPointTimelineAction

public PowerPointAutoShape AddShape(OfficePresetShapeType shapeType, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null, string? name = null)

PowerPointSlide.Shapes.cs:11

Adds an auto shape with the specified geometry.

Parameters

shapeType OfficeIMO.Drawing.OfficePresetShapeType required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
name string? = null optional

Returns

PowerPointAutoShape

AddSmartArt 4 overloads

public PowerPointSmartArt AddSmartArt(PowerPointSmartArtType type = BasicProcess, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.SmartArt.cs:43

Adds a native SmartArt diagram to the slide.

Parameters

type OfficeIMO.PowerPoint.PowerPointSmartArtType = BasicProcess optional
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointSmartArt

public PowerPointSmartArt AddSmartArt(PowerPointSmartArtType type, IEnumerable<string> nodeTexts, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.SmartArt.cs:51

Adds a native SmartArt diagram populated with editable semantic node text.

Parameters

type OfficeIMO.PowerPoint.PowerPointSmartArtType required
nodeTexts System.Collections.Generic.IEnumerable<string> required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointSmartArt

public PowerPointSmartArt AddSmartArt(PowerPointSmartArtType type, PowerPointLayoutBox layout) #

PowerPointSlide.SmartArt.cs:85

Adds a native SmartArt diagram to the slide using a layout box.

Parameters

type OfficeIMO.PowerPoint.PowerPointSmartArtType required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointSmartArt

public PowerPointSmartArt AddSmartArt(PowerPointSmartArtType type, IEnumerable<string> nodeTexts, PowerPointLayoutBox layout)

PowerPointSlide.SmartArt.cs:91

Adds populated native SmartArt using a layout box.

Parameters

type OfficeIMO.PowerPoint.PowerPointSmartArtType required
nodeTexts System.Collections.Generic.IEnumerable<string> required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointSmartArt

AddTable 4 overloads

public PowerPointTable AddTable(int rows, int columns, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Tables.cs:19

Adds a table with the specified rows, columns and physical bounds. Omitted geometry uses the canonical content frame below the title.

Parameters

rows int required
columns int required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointTable

public PowerPointTable AddTable(int rows, int columns, PowerPointTableStylePreset preset, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Tables.cs:103

Adds a table with a style preset applied.

Parameters

rows int required
columns int required
preset OfficeIMO.PowerPoint.PowerPointTableStylePreset required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointTable

public PowerPointTable AddTable(int rows, int columns, string styleName, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null, bool ignoreCase = true, bool? firstRow = null, bool? lastRow = null, bool? firstColumn = null, bool? lastColumn = null, bool? bandedRows = null, bool? bandedColumns = null)

PowerPointSlide.Tables.cs:115

Adds a table with a table style name applied.

Parameters

rows int required
columns int required
styleName string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
ignoreCase bool = true optional
firstRow bool? = null optional
lastRow bool? = null optional
firstColumn bool? = null optional
lastColumn bool? = null optional
bandedRows bool? = null optional
bandedColumns bool? = null optional

Returns

PowerPointTable

public PowerPointTable AddTable(int rows, int columns, PowerPointLayoutBox layout) #

PowerPointSlide.Tables.cs:127

Adds a table using a layout box.

Parameters

rows int required
columns int required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointTable

AddTable``1 6 overloads

public PowerPointTable AddTable<T>(IEnumerable<T?> data, Action<ObjectFlattenerOptions>? configure, bool includeHeaders = true, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Tables.cs:135

Adds a table built from a sequence of objects.

Type Parameters

T

Parameters

data System.Collections.Generic.IEnumerable<T?> required
configure System.Action<OfficeIMO.Data.ObjectFlattenerOptions>? required
includeHeaders bool = true optional
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointTable

public PowerPointTable AddTable<T>(IEnumerable<T?> data, IEnumerable<PowerPointTableColumn<T?>> columns, bool includeHeaders = true, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Tables.cs:274

Adds a table using explicit column bindings.

Type Parameters

T

Parameters

data System.Collections.Generic.IEnumerable<T?> required
columns System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointTableColumn<T?>> required
includeHeaders bool = true optional
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointTable

public PowerPointTable AddTable<T>(IEnumerable<T?> data, IEnumerable<PowerPointTableColumn<T?>> columns, PowerPointTableStylePreset preset, bool includeHeaders = true, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Tables.cs:364

Adds a table using explicit column bindings with a style preset applied.

Type Parameters

T

Parameters

data System.Collections.Generic.IEnumerable<T?> required
columns System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointTableColumn<T?>> required
preset OfficeIMO.PowerPoint.PowerPointTableStylePreset required
includeHeaders bool = true optional
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointTable

public PowerPointTable AddTable<T>(IEnumerable<T?> data, IEnumerable<PowerPointTableColumn<T?>> columns, string styleName, bool includeHeaders = true, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null, bool ignoreCase = true, bool? firstRow = null, bool? lastRow = null, bool? firstColumn = null, bool? lastColumn = null, bool? bandedRows = null, bool? bandedColumns = null)

PowerPointSlide.Tables.cs:376

Adds a table using explicit column bindings with a table style name applied.

Type Parameters

T

Parameters

data System.Collections.Generic.IEnumerable<T?> required
columns System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointTableColumn<T?>> required
styleName string required
includeHeaders bool = true optional
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
ignoreCase bool = true optional
firstRow bool? = null optional
lastRow bool? = null optional
firstColumn bool? = null optional
lastColumn bool? = null optional
bandedRows bool? = null optional
bandedColumns bool? = null optional

Returns

PowerPointTable

public PowerPointTable AddTable<T>(IEnumerable<T?> data, IEnumerable<PowerPointTableColumn<T?>> columns, PowerPointLayoutBox layout, bool includeHeaders = true)

PowerPointSlide.Tables.cs:389

Adds a table using explicit column bindings and a layout box.

Type Parameters

T

Parameters

data System.Collections.Generic.IEnumerable<T?> required
columns System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointTableColumn<T?>> required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required
includeHeaders bool = true optional

Returns

PowerPointTable

public PowerPointTable AddTable<T>(IEnumerable<T?> rows, OfficeTableOptions? options = null) #

PowerPointSlide.TypedTables.cs:10

Adds an editable native table with common header and naming options.

Type Parameters

T

Parameters

rows System.Collections.Generic.IEnumerable<T?> required
options OfficeIMO.OfficeTableOptions? = null optional

Returns

PowerPointTable

AddTextBox 3 overloads

public PowerPointTextBox AddTextBox(string text, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Text.cs:60

Adds a textbox with the specified text.

Parameters

text string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointTextBox

public PowerPointTextBox AddTextBox(string text, PowerPointLayoutBox layout) #

PowerPointSlide.Text.cs:95

Adds a textbox using a layout box.

Parameters

text string required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointTextBox

public PowerPointTextBox AddTextBox(PowerPointLayoutBox layout) #

PowerPointSlide.Text.cs:102

Adds an empty textbox using a layout box.

Parameters

layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointTextBox

public PowerPointTextBox AddTextShape(OfficePresetShapeType shapeType, string text, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null, string? name = null)

PowerPointSlide.TextShapes.cs:17

Adds a text-bearing shape with the specified preset geometry.

Parameters

shapeType OfficeIMO.Drawing.OfficePresetShapeType required
text string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
name string? = null optional

Returns

PowerPointTextBox

public PowerPointTextBox AddTextToPlaceholder(PowerPointTemplatePlaceholderInfo placeholder, string text) #

PowerPointDocument.Templates.cs:157

Creates a slide textbox from an inventoried text placeholder while preserving semantic type, placeholder index, authored name, and bounds.

Parameters

placeholder OfficeIMO.PowerPoint.PowerPointTemplatePlaceholderInfo required
text string required

Returns

PowerPointTextBox

AddTitle 2 overloads

public PowerPointTextBox AddTitle(string text, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Text.cs:11

Adds a title textbox to the slide.

Parameters

text string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointTextBox

public PowerPointTextBox AddTitle(string text, PowerPointLayoutBox layout) #

PowerPointSlide.Text.cs:52

Adds a title textbox using a layout box.

Parameters

text string required
layout OfficeIMO.PowerPoint.PowerPointLayoutBox required

Returns

PowerPointTextBox

AddVideo 2 overloads

public PowerPointMedia AddVideo(string videoPath, string? posterImagePath = null, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null)

PowerPointSlide.Media.cs:14

Adds an embedded video file to the slide.

Parameters

videoPath string required
posterImagePath string? = null optional
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional

Returns

PowerPointMedia

public PowerPointMedia AddVideo(Stream video, string contentType, string extension, OfficeLength? left = null, OfficeLength? top = null, OfficeLength? width = null, OfficeLength? height = null, Stream? posterImage = null, OfficeImageFormat posterImageType = Png)

PowerPointSlide.Media.cs:39

Adds an embedded video stream to the slide.

Parameters

video System.IO.Stream required
contentType string required
extension string required
left OfficeIMO.OfficeLength? = null optional
top OfficeIMO.OfficeLength? = null optional
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
posterImage System.IO.Stream? = null optional
posterImageType OfficeIMO.Drawing.OfficeImageFormat = Png optional

Returns

PowerPointMedia

public void AlignGroupChildren(PowerPointGroupShape groupShape, PowerPointShapeAlignment alignment) #

PowerPointSlide.GroupLayout.cs:127

Aligns child shapes within the group's bounds.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required

AlignShapes 2 overloads

public void AlignShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeAlignment alignment) #

PowerPointSlide.Alignment.cs:9

Aligns shapes within their selection bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required

public void AlignShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeAlignment alignment, PowerPointLayoutBox bounds)

PowerPointSlide.Alignment.cs:16

Aligns shapes within a custom bounding box.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required

public void AlignShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeAlignment alignment) #

PowerPointSlide.Alignment.cs:58

Aligns shapes within the full slide bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required

public void AlignShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeAlignment alignment, OfficeLength margin)

PowerPointSlide.Alignment.cs:70

Aligns shapes within the slide content bounds using a margin.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.

public void ArrangeGroupChildrenInGrid(PowerPointGroupShape groupShape, int columns, int rows, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.GroupLayout.cs:255

Arranges child shapes into a grid within the group's bounds.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose children are arranged in their native child coordinate space.
columns int required: Number of grid columns, greater than zero.
rows int required: Number of grid rows, greater than zero.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

ArrangeGroupChildrenInGridAuto 2 overloads

public void ArrangeGroupChildrenInGridAuto(PowerPointGroupShape groupShape, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.GroupLayout.cs:277

Arranges child shapes into an auto-sized grid within the group's bounds.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose children are arranged in their native child coordinate space.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void ArrangeGroupChildrenInGridAuto(PowerPointGroupShape groupShape, PowerPointShapeGridOptions? options) #

PowerPointSlide.GroupLayout.cs:294

Arranges child shapes into an auto-sized grid within the group's bounds using options.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose children are arranged in their native child coordinate space.
options OfficeIMO.PowerPoint.PowerPointShapeGridOptions? required: Layout settings, or null to use the default settings.

ArrangeShapesInGrid 2 overloads

public void ArrangeShapesInGrid(IEnumerable<PowerPointShape> shapes, int columns, int rows, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:17

Arranges shapes into a grid within their selection bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
columns int required: Number of grid columns, greater than zero.
rows int required: Number of grid rows, greater than zero.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void ArrangeShapesInGrid(IEnumerable<PowerPointShape> shapes, PowerPointLayoutBox bounds, int columns, int rows, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:35

Arranges shapes into a grid within a custom bounding box.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
columns int required: Number of grid columns, greater than zero.
rows int required: Number of grid rows, greater than zero.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

ArrangeShapesInGridAuto 3 overloads

public void ArrangeShapesInGridAuto(IEnumerable<PowerPointShape> shapes, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:114

Arranges shapes into an auto-sized grid within their selection bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void ArrangeShapesInGridAuto(IEnumerable<PowerPointShape> shapes, PowerPointLayoutBox bounds, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:136

Arranges shapes into an auto-sized grid within a custom bounding box.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void ArrangeShapesInGridAuto(IEnumerable<PowerPointShape> shapes, PowerPointLayoutBox bounds, PowerPointShapeGridOptions? options)

PowerPointSlide.Grid.cs:153

Arranges shapes into an auto-sized grid within a custom bounding box using options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
options OfficeIMO.PowerPoint.PowerPointShapeGridOptions? required: Layout settings, or null to use the default settings.

ArrangeShapesInGridAutoToSlide 2 overloads

public void ArrangeShapesInGridAutoToSlide(IEnumerable<PowerPointShape> shapes, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:184

Arranges shapes into an auto-sized grid that spans the slide bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void ArrangeShapesInGridAutoToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeGridOptions? options) #

PowerPointSlide.Grid.cs:199

Arranges shapes into an auto-sized grid that spans the slide bounds using options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
options OfficeIMO.PowerPoint.PowerPointShapeGridOptions? required: Layout settings, or null to use the default settings.

ArrangeShapesInGridAutoToSlideContent 2 overloads

public void ArrangeShapesInGridAutoToSlideContent(IEnumerable<PowerPointShape> shapes, OfficeLength margin, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:215

Arranges shapes into an auto-sized grid that spans the slide content bounds using a margin.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void ArrangeShapesInGridAutoToSlideContent(IEnumerable<PowerPointShape> shapes, OfficeLength margin, PowerPointShapeGridOptions? options)

PowerPointSlide.Grid.cs:233

Arranges shapes into an auto-sized grid that spans the slide content bounds using a margin and options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
options OfficeIMO.PowerPoint.PowerPointShapeGridOptions? required: Layout settings, or null to use the default settings.

public void ArrangeShapesInGridToSlide(IEnumerable<PowerPointShape> shapes, int columns, int rows, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:81

Arranges shapes into a grid that spans the slide bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
columns int required: Number of grid columns, greater than zero.
rows int required: Number of grid rows, greater than zero.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void ArrangeShapesInGridToSlideContent(IEnumerable<PowerPointShape> shapes, int columns, int rows, OfficeLength margin, OfficeLength gutterX = default, OfficeLength gutterY = default, bool resizeToCell = true, PowerPointShapeGridFlow flow = RowMajor)

PowerPointSlide.Grid.cs:99

Arranges shapes into a grid that spans the slide content bounds using a margin.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
columns int required: Number of grid columns, greater than zero.
rows int required: Number of grid rows, greater than zero.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
gutterX OfficeIMO.OfficeLength = default optional: Nonnegative horizontal gap between cells. The default is zero.
gutterY OfficeIMO.OfficeLength = default optional: Nonnegative vertical gap between cells. The default is zero.
resizeToCell bool = true optional: Whether each shape is resized to its grid cell.
flow OfficeIMO.PowerPoint.PowerPointShapeGridFlow = RowMajor optional: Order used to fill grid cells.

public void BringForward(PowerPointShape shape) #

PowerPointSlide.Arrange.cs:53

Moves the shape one step forward in z-order.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

public void BringToFront(PowerPointShape shape) #

PowerPointSlide.Arrange.cs:95

Moves the shape to the front (top) of the z-order.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

public void ClearBackground() #

PowerPointSlide.Background.Color.cs:13

Removes the slide's background override so the layout or master can supply its background.

public void ClearBackgroundImage() #

PowerPointSlide.Background.cs:169

Clears any background image from the slide.

public void ClearClassicAnimations() #

PowerPointSlide.ClassicAnimations.cs:68

Removes all OfficeIMO classic animations from the slide.

public void ClearClassicAnimationSound(PowerPointShape shape) #

PowerPointSlide.ClassicAnimations.cs:116

Removes the embedded sound played with a shape's classic animation.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

public void ClearTransitionSound() #

PowerPointSlide.TransitionSounds.cs:71

Removes this slide's start- or stop-sound transition action.

public PowerPointSlideVisualInfo CreateVisualSnapshot(PowerPointImageExportOptions? options = null) #

PowerPointSlide.Imaging.cs:10

Creates a format-neutral visual snapshot for this slide.

Parameters

options OfficeIMO.PowerPoint.PowerPointImageExportOptions? = null optional

Returns

PowerPointSlideVisualInfo

DistributeGroupChildren 2 overloads

public void DistributeGroupChildren(PowerPointGroupShape groupShape, PowerPointShapeDistribution distribution) #

PowerPointSlide.GroupLayout.cs:141

Distributes child shapes within the group's bounds.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required

public void DistributeGroupChildren(PowerPointGroupShape groupShape, PowerPointShapeDistribution distribution, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.GroupLayout.cs:156

Distributes child shapes within the group's bounds and aligns on the cross axis.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required

DistributeGroupChildrenWithSpacing 2 overloads

public void DistributeGroupChildrenWithSpacing(PowerPointGroupShape groupShape, PowerPointShapeDistribution distribution, OfficeLength spacing, bool center = false)

PowerPointSlide.GroupLayout.cs:176

Distributes child shapes with fixed spacing within the group's bounds.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose children are arranged in their native child coordinate space.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
center bool = false optional: Whether to center the arranged shapes within the target bounds.

public void DistributeGroupChildrenWithSpacing(PowerPointGroupShape groupShape, PowerPointShapeDistribution distribution, PowerPointShapeSpacingOptions? options)

PowerPointSlide.GroupLayout.cs:195

Distributes child shapes with fixed spacing within the group's bounds using options.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose children are arranged in their native child coordinate space.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
options OfficeIMO.PowerPoint.PowerPointShapeSpacingOptions? required: Layout settings, or null to use the default settings.

DistributeShapes 4 overloads

public void DistributeShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution) #

PowerPointSlide.Alignment.cs:77

Distributes shapes evenly within their selection bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required

public void DistributeShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Alignment.cs:85

Distributes shapes evenly within their selection bounds and aligns them on the cross axis.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required

public void DistributeShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointLayoutBox bounds)

PowerPointSlide.Alignment.cs:92

Distributes shapes evenly within a custom bounding box.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required

public void DistributeShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointLayoutBox bounds, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Alignment.cs:118

Distributes shapes evenly within a custom bounding box and aligns them on the cross axis.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required

DistributeShapesToSlide 2 overloads

public void DistributeShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution) #

PowerPointSlide.Alignment.cs:135

Distributes shapes evenly within the full slide bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required

public void DistributeShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Alignment.cs:143

Distributes shapes evenly within the full slide bounds and aligns them on the cross axis.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required

DistributeShapesToSlideContent 2 overloads

public void DistributeShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength margin, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Alignment.cs:156

Distributes shapes evenly within the slide content bounds using a margin and aligns them on the cross axis.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment on the axis perpendicular to distribution.

public void DistributeShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength margin)

PowerPointSlide.Alignment.cs:168

Distributes shapes evenly within the slide content bounds using a margin.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.

DistributeShapesWithSpacing 8 overloads

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, bool center = false)

PowerPointSlide.Spacing.cs:13

Distributes shapes with a fixed spacing within their selection bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
center bool = false optional: Whether to center the arranged shapes within the target bounds.

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, PowerPointShapeAlignment alignment)

PowerPointSlide.Spacing.cs:26

Distributes shapes with a fixed spacing within their selection bounds using alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointShapeSpacingOptions? options)

PowerPointSlide.Spacing.cs:37

Distributes shapes with a fixed spacing within their selection bounds using options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
options OfficeIMO.PowerPoint.PowerPointShapeSpacingOptions? required: Layout settings, or null to use the default settings.

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, PowerPointShapeAlignment alignment, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Spacing.cs:51

Distributes shapes with a fixed spacing within their selection bounds using alignment and cross-axis alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment on the axis perpendicular to distribution.

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointLayoutBox bounds, OfficeLength spacing, bool center = false)

PowerPointSlide.Spacing.cs:65

Distributes shapes with a fixed spacing within a custom bounding box.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
center bool = false optional: Whether to center the arranged shapes within the target bounds.

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointLayoutBox bounds, OfficeLength spacing, PowerPointShapeAlignment alignment)

PowerPointSlide.Spacing.cs:100

Distributes shapes with a fixed spacing within a custom bounding box using alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointLayoutBox bounds, PowerPointShapeSpacingOptions? options)

PowerPointSlide.Spacing.cs:133

Distributes shapes with a fixed spacing within a custom bounding box using options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
options OfficeIMO.PowerPoint.PowerPointShapeSpacingOptions? required: Layout settings, or null to use the default settings.

public void DistributeShapesWithSpacing(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointLayoutBox bounds, OfficeLength spacing, PowerPointShapeAlignment alignment, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Spacing.cs:152

Distributes shapes with a fixed spacing within a custom bounding box using alignment and cross-axis alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment on the axis perpendicular to distribution.

DistributeShapesWithSpacingToSlide 4 overloads

public void DistributeShapesWithSpacingToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, bool center = false)

PowerPointSlide.Spacing.cs:186

Distributes shapes with a fixed spacing within the full slide bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
center bool = false optional: Whether to center the arranged shapes within the target bounds.

public void DistributeShapesWithSpacingToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, PowerPointShapeAlignment alignment)

PowerPointSlide.Spacing.cs:199

Distributes shapes with a fixed spacing within the full slide bounds using alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void DistributeShapesWithSpacingToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, PowerPointShapeSpacingOptions? options)

PowerPointSlide.Spacing.cs:210

Distributes shapes with a fixed spacing within the full slide bounds using options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
options OfficeIMO.PowerPoint.PowerPointShapeSpacingOptions? required: Layout settings, or null to use the default settings.

public void DistributeShapesWithSpacingToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, PowerPointShapeAlignment alignment, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Spacing.cs:224

Distributes shapes with a fixed spacing within the full slide bounds using alignment and cross-axis alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment on the axis perpendicular to distribution.

DistributeShapesWithSpacingToSlideContent 4 overloads

public void DistributeShapesWithSpacingToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, OfficeLength margin, bool center = false)

PowerPointSlide.Spacing.cs:238

Distributes shapes with a fixed spacing within the slide content bounds using a margin.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
center bool = false optional: Whether to center the arranged shapes within the target bounds.

public void DistributeShapesWithSpacingToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, OfficeLength margin, PowerPointShapeAlignment alignment)

PowerPointSlide.Spacing.cs:252

Distributes shapes with a fixed spacing within the slide content bounds using a margin and alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void DistributeShapesWithSpacingToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength margin, PowerPointShapeSpacingOptions? options)

PowerPointSlide.Spacing.cs:265

Distributes shapes with a fixed spacing within the slide content bounds using a margin and options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
options OfficeIMO.PowerPoint.PowerPointShapeSpacingOptions? required: Layout settings, or null to use the default settings.

public void DistributeShapesWithSpacingToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeDistribution distribution, OfficeLength spacing, OfficeLength margin, PowerPointShapeAlignment alignment, PowerPointShapeAlignment crossAxisAlignment)

PowerPointSlide.Spacing.cs:282

Distributes shapes with a fixed spacing within the slide content bounds using a margin, alignment, and cross-axis alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
distribution OfficeIMO.PowerPoint.PowerPointShapeDistribution required: Axis along which shapes are distributed.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
crossAxisAlignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment on the axis perpendicular to distribution.

public PowerPointShape DuplicateShape(PowerPointShape shape, OfficeLength offsetX = default, OfficeLength offsetY = default)

PowerPointSlide.Arrange.cs:16

Creates a duplicate of the provided shape and optionally offsets its position using exact document lengths.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
offsetX OfficeIMO.OfficeLength = default optional
offsetY OfficeIMO.OfficeLength = default optional

Returns

PowerPointShape

public IEnumerable<PowerPointShape> EnumerateShapesDeep(IEnumerable<PowerPointShape> shapes, bool includeHidden = false) #

PowerPointSlide.GroupLayout.cs:42

Enumerates a shape tree in drawing order, including nested group children while preserving inherited hidden state.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
includeHidden bool = false optional

Returns

IEnumerable<PowerPointShape>

public void FitShapesToBounds(IEnumerable<PowerPointShape> shapes, PowerPointLayoutBox bounds, bool preserveAspect = false, bool center = false)

PowerPointSlide.Fit.cs:10

Scales and repositions shapes to fit within a target bounding box.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required
preserveAspect bool = false optional
center bool = false optional

public void FitShapesToSlide(IEnumerable<PowerPointShape> shapes, bool preserveAspect = false, bool center = false) #

PowerPointSlide.Fit.cs:60

Scales and repositions shapes to fit the slide bounds.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
preserveAspect bool = false optional
center bool = false optional

public void FitShapesToSlideContent(IEnumerable<PowerPointShape> shapes, OfficeLength margin, bool preserveAspect = false, bool center = false)

PowerPointSlide.Fit.cs:73

Scales and repositions shapes to fit the slide content bounds with a margin.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
preserveAspect bool = false optional: Whether to retain each shape's aspect ratio when scaling.
center bool = false optional: Whether to center the arranged shapes within the target bounds.

GetBackground 2 overloads

public PowerPointSlideBackground GetBackground() #

PowerPointSlide.BackgroundSnapshot.cs:13

Returns a detached snapshot of the slide background fill that exporters can consume without Open XML coupling.

Returns

PowerPointSlideBackground

public PowerPointSlideBackground GetBackground(int maximumImageBytes) #

PowerPointSlide.BackgroundSnapshot.cs:18

Returns a detached slide-background snapshot with a bound on embedded image bytes.

Parameters

maximumImageBytes int required

Returns

PowerPointSlideBackground

public PowerPointChart? GetChart(string name) #

PowerPointSlide.Lookup.cs:139

Retrieves a chart by its name.

Parameters

name string required

Returns

PowerPointChart?

public byte[]? GetClassicAnimationSoundBytes(PowerPointShape shape) #

PowerPointSlide.ClassicAnimations.cs:122

Returns the exact embedded classic-animation sound bytes, when present.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

Returns

byte[]?

public IReadOnlyList<PowerPointChart> GetGroupCharts(PowerPointGroupShape groupShape) #

PowerPointSlide.GroupLayout.cs:108

Returns the child charts of a group shape.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required

Returns

IReadOnlyList<PowerPointChart>

public PowerPointLayoutBox GetGroupChildBounds(PowerPointGroupShape groupShape) #

PowerPointSlide.GroupLayout.cs:117

Gets the layout bounds used by a group for its children as OfficeLength values.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose native child coordinate space is inspected.

Returns

PowerPointLayoutBox The native child region, or the selection bounds when no complete child transform exists.

public IReadOnlyList<PowerPointShape> GetGroupChildren(PowerPointGroupShape groupShape) #

PowerPointSlide.GroupLayout.cs:10

Returns the child shapes of a group shape.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required

Returns

IReadOnlyList<PowerPointShape>

public IReadOnlyList<PowerPointImage> GetGroupImages(PowerPointGroupShape groupShape) #

PowerPointSlide.GroupLayout.cs:94

Returns the child images of a group shape.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required

Returns

IReadOnlyList<PowerPointImage>

public IReadOnlyList<PowerPointTable> GetGroupTables(PowerPointGroupShape groupShape) #

PowerPointSlide.GroupLayout.cs:101

Returns the child tables of a group shape.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required

Returns

IReadOnlyList<PowerPointTable>

public IReadOnlyList<PowerPointTextBox> GetGroupTextBoxes(PowerPointGroupShape groupShape) #

PowerPointSlide.GroupLayout.cs:87

Returns the child textboxes of a group shape.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required

Returns

IReadOnlyList<PowerPointTextBox>

public PowerPointImage? GetImage(string name) #

PowerPointSlide.Lookup.cs:79

Retrieves an image by its name.

Parameters

name string required

Returns

PowerPointImage?

public PowerPointSlideLayoutInfo? GetLayoutInfo() #

PowerPointSlide.Inspection.cs:26

Inspects the current layout and owning master without modifying the package.

Returns

PowerPointSlideLayoutInfo? The layout description, or null when the slide has no layout.

public PowerPointLayoutPlaceholderInfo? GetLayoutPlaceholder(PowerPointPlaceholderType placeholderType, uint? index = null)

PowerPointSlide.Layout.cs:193

Retrieves a layout placeholder by type and optional index.

Parameters

placeholderType OfficeIMO.PowerPoint.PowerPointPlaceholderType required
index uint? = null optional

Returns

PowerPointLayoutPlaceholderInfo?

public PowerPointLayoutBox? GetLayoutPlaceholderBounds(PowerPointPlaceholderType placeholderType, uint? index = null) #

PowerPointSlide.Layout.cs:212

Retrieves layout placeholder bounds by type and optional index.

Parameters

placeholderType OfficeIMO.PowerPoint.PowerPointPlaceholderType required
index uint? = null optional

Returns

PowerPointLayoutBox?

public IReadOnlyList<PowerPointLayoutPlaceholderInfo> GetLayoutPlaceholders() #

PowerPointSlide.Layout.cs:164

Retrieves placeholders defined by the slide layout.

Returns

IReadOnlyList<PowerPointLayoutPlaceholderInfo>

public PowerPointOleObject? GetOleObject(string name) #

PowerPointSlide.Lookup.cs:148

Retrieves an embedded OLE object by its shape name.

Parameters

name string required

Returns

PowerPointOleObject?

public PowerPointTextBox? GetPlaceholder(PowerPointPlaceholderType placeholderType, uint? index = null) #

PowerPointSlide.Layout.cs:150

Retrieves the first placeholder textbox matching the specified type.

Parameters

placeholderType OfficeIMO.PowerPoint.PowerPointPlaceholderType required
index uint? = null optional

Returns

PowerPointTextBox?

public PowerPointShape? GetShape(string name) #

PowerPointSlide.Lookup.cs:14

Retrieves a shape by its name.

Parameters

name string required

Returns

PowerPointShape?

public PowerPointShape? GetShapeById(uint id) #

PowerPointSlide.Lookup.cs:56

Retrieves a shape by its non-visual drawing identifier.

Parameters

id uint required

Returns

PowerPointShape?

public T? GetShapeById<T>(uint id) #

PowerPointSlide.Lookup.cs:63

Retrieves a typed shape by its non-visual drawing identifier.

Type Parameters

T

Parameters

id uint required

Returns

T?

public PowerPointShape? GetShapeByName(string name, bool ignoreCase = false) #

PowerPointSlide.Lookup.cs:23

Retrieves a shape by name, optionally using case-insensitive comparison.

Parameters

name string required
ignoreCase bool = false optional

Returns

PowerPointShape?

public T? GetShapeByName<T>(string name, bool ignoreCase = false) #

PowerPointSlide.Lookup.cs:41

Retrieves a typed shape by name, optionally using case-insensitive comparison.

Type Parameters

T

Parameters

name string required
ignoreCase bool = false optional

Returns

T?

GetShapesInBounds 2 overloads

public IReadOnlyList<PowerPointShape> GetShapesInBounds(PowerPointLayoutBox bounds, bool includePartial) #

PowerPointSlide.cs:77

Retrieves shapes that are within or intersect the provided bounds.

Parameters

bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required
includePartial bool required

Returns

IReadOnlyList<PowerPointShape>

public IReadOnlyList<PowerPointShape> GetShapesInBounds(OfficeLength left, OfficeLength top, OfficeLength width, OfficeLength height, bool includePartial = true)

PowerPointSlide.cs:99

Retrieves shapes using an explicit position and size.

Parameters

left OfficeIMO.OfficeLength required
top OfficeIMO.OfficeLength required
width OfficeIMO.OfficeLength required
height OfficeIMO.OfficeLength required
includePartial bool = true optional

Returns

IReadOnlyList<PowerPointShape>

public string GetSpeakerNotesText() #

PowerPointSlide.NotesInspection.cs:12

Reads existing speaker-note text without creating a notes part as a side effect.

Returns

string

public PowerPointTable? GetTable(string name) #

PowerPointSlide.Lookup.cs:88

Retrieves a table by its name.

Parameters

name string required

Returns

PowerPointTable?

public PowerPointTextBox? GetTextBox(string name) #

PowerPointSlide.Lookup.cs:70

Retrieves a textbox by its name.

Parameters

name string required

Returns

PowerPointTextBox?

public byte[]? GetTransitionSoundBytes() #

PowerPointSlide.TransitionSounds.cs:86

Returns the exact embedded transition sound bytes, when present.

Returns

byte[]?

public PowerPointGroupShape GroupShapes(IEnumerable<PowerPointShape> shapes, string? name = null) #

PowerPointSlide.Group.cs:11

Groups shapes into a single group shape.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
name string? = null optional

Returns

PowerPointGroupShape

public void Hide() #

PowerPointSlide.Visibility.cs:36

Hides the slide in slide show mode.

public bool RemoveAnimation(uint timingId) #

PowerPointSlide.AnimationTimeline.cs:108

Removes exactly one typed action by common timing id. Unrelated siblings and unmodeled producer sequences are retained.

Parameters

timingId uint required

Returns

bool

public bool RemoveClassicAnimation(PowerPointShape shape) #

PowerPointSlide.ClassicAnimations.cs:52

Removes the classic animation attached to a shape.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

Returns

bool

public void RemoveShape(PowerPointShape shape) #

PowerPointSlide.Lookup.cs:156

Removes the specified shape from the slide.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

public int ReplaceAll(string text, string replacement, PowerPointTextSearchOptions? options = null) #

PowerPointSlide.Lookup.cs:105

Replaces literal text in the slide's textboxes and, by default, its table cells.

Parameters

text string required: Text to find.
replacement string required: Replacement text; null removes each match.
options OfficeIMO.PowerPoint.PowerPointTextSearchOptions? = null optional: Comparison settings and scope. null matches ordinally, ignoring case, inside or across words, in textboxes and tables but not notes.

Returns

int The number of replaced matches.

ResizeShapes 2 overloads

public void ResizeShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeSizeDimension dimension, PowerPointShapeSizeReference reference = First)

PowerPointSlide.Resize.cs:8

Resizes shapes using the specified reference strategy.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required
dimension OfficeIMO.PowerPoint.PowerPointShapeSizeDimension required
reference OfficeIMO.PowerPoint.PowerPointShapeSizeReference = First optional

public void ResizeShapes(IEnumerable<PowerPointShape> shapes, OfficeLength? width, OfficeLength? height) #

PowerPointSlide.Resize.cs:47

Resizes shapes to explicit dimensions, leaving each null dimension unchanged.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
width OfficeIMO.OfficeLength? required: Nonnegative width, or null to retain each shape's current width. Zero is permitted.
height OfficeIMO.OfficeLength? required: Nonnegative height, or null to retain each shape's current height. Zero is permitted.

SaveAsImage 2 overloads

public OfficeConversionReport SaveAsImage(string path, PowerPointImageExportOptions? options = null, CancellationToken cancellationToken = default)

PowerPointSlide.Imaging.Conversion.cs:34

Writes the slide to a file and returns its fidelity report.

Parameters

path string required
options OfficeIMO.PowerPoint.PowerPointImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

public OfficeConversionReport SaveAsImage(Stream stream, PowerPointImageExportOptions? options = null, CancellationToken cancellationToken = default)

PowerPointSlide.Imaging.Conversion.cs:44

Writes the slide to a caller-owned stream and returns its fidelity report.

Parameters

stream System.IO.Stream required
options OfficeIMO.PowerPoint.PowerPointImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

SaveAsImageAsync 2 overloads

public async Task<OfficeConversionReport> SaveAsImageAsync(string path, PowerPointImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously writes the slide to a file and returns its fidelity report.

Parameters

path string required
options OfficeIMO.PowerPoint.PowerPointImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

public async Task<OfficeConversionReport> SaveAsImageAsync(Stream stream, PowerPointImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously writes the slide to a caller-owned stream and returns its fidelity report.

Parameters

stream System.IO.Stream required
options OfficeIMO.PowerPoint.PowerPointImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

public void SendBackward(PowerPointShape shape) #

PowerPointSlide.Arrange.cs:74

Moves the shape one step backward in z-order.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

public void SendToBack(PowerPointShape shape) #

PowerPointSlide.Arrange.cs:115

Moves the shape to the back (bottom) of the z-order.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required

public bool SetAnimationDuration(uint timingId, uint durationMilliseconds) #

PowerPointSlide.AnimationTimeline.cs:97

Changes duration on any typed or imported action with a common timing id.

Parameters

timingId uint required
durationMilliseconds uint required

Returns

bool

public void SetBackgroundColor(OfficeColor color) #

PowerPointSlide.Background.Color.cs:8

Sets a solid background, preserving native theme references and literal transparency.

Parameters

color OfficeIMO.OfficeColor required

public void SetBackgroundGradient(OfficeColor startColor, OfficeColor endColor, double angleDegrees = 135) #

PowerPointSlide.Background.cs:135

Sets a linear gradient background, retaining theme roles and color opacity.

Parameters

startColor OfficeIMO.OfficeColor required
endColor OfficeIMO.OfficeColor required
angleDegrees double = 135 optional

SetBackgroundImage 2 overloads

public void SetBackgroundImage(string imagePath) #

PowerPointSlide.Background.cs:57

Sets a background image for the slide.

Parameters

imagePath string required

public void SetBackgroundImage(Stream image, OfficeImageFormat imageType) #

PowerPointSlide.Background.cs:79

Sets a background image for the slide from a readable image stream.

Parameters

image System.IO.Stream required: Stream containing the image data.
imageType OfficeIMO.Drawing.OfficeImageFormat required: Image format of the stream.

public void SetBackgroundNoFill() #

PowerPointSlide.Background.cs:47

Sets an explicit no-fill slide background, overriding inherited theme fills.

SetClassicAnimationSound 2 overloads

public void SetClassicAnimationSound(PowerPointShape shape, string audioPath, bool stopExistingSounds = false) #

PowerPointSlide.ClassicAnimations.cs:74

Sets the embedded WAV or AIFF sound played with a shape's classic animation.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
audioPath string required
stopExistingSounds bool = false optional

public void SetClassicAnimationSound(PowerPointShape shape, Stream audio, string name, string contentType = "audio/wav", string extension = ".wav", bool stopExistingSounds = false)

PowerPointSlide.ClassicAnimations.cs:89

Sets the embedded WAV or AIFF sound played with a shape's classic animation.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
audio System.IO.Stream required
name string required
contentType string = "audio/wav" optional
extension string = ".wav" optional
stopExistingSounds bool = false optional

public void SetClassicAnimationStopsSound(PowerPointShape shape, bool value) #

PowerPointSlide.ClassicAnimations.cs:111

Controls whether existing sounds stop when a shape's classic animation starts.

Parameters

shape OfficeIMO.PowerPoint.PowerPointShape required
value bool required

SetLayout 4 overloads

public void SetLayout(int masterIndex, int layoutIndex) #

PowerPointSlide.Layout.cs:36

Sets the slide layout using master and layout indexes.

Parameters

masterIndex int required
layoutIndex int required

public void SetLayout(PowerPointSlideLayout layout) #

PowerPointSlide.Layout.cs:72

Moves the slide to another layout of the same presentation. Slide content is kept; placeholders are matched to the new layout's by type and index.

Parameters

layout OfficeIMO.PowerPoint.PowerPointSlideLayout required

public void SetLayout(PowerPointSlideLayoutType layoutType, int masterIndex = 0) #

PowerPointSlide.Layout.cs:91

Sets the slide layout using a layout type.

Parameters

layoutType OfficeIMO.PowerPoint.PowerPointSlideLayoutType required
masterIndex int = 0 optional

public void SetLayout(string layoutName, int masterIndex = 0, bool ignoreCase = true) #

PowerPointSlide.Layout.cs:99

Sets the slide layout using a layout name.

Parameters

layoutName string required
masterIndex int = 0 optional
ignoreCase bool = true optional

SetTransitionSound 2 overloads

public void SetTransitionSound(string audioPath, bool loop = false) #

PowerPointSlide.TransitionSounds.cs:23

Sets an embedded WAV or AIFF transition sound from a file.

Parameters

audioPath string required
loop bool = false optional

public void SetTransitionSound(Stream audio, string name, string contentType = "audio/wav", string extension = ".wav", bool loop = false)

PowerPointSlide.TransitionSounds.cs:37

Sets an embedded WAV or AIFF transition sound.

Parameters

audio System.IO.Stream required
name string required
contentType string = "audio/wav" optional
extension string = ".wav" optional
loop bool = false optional

public void Show() #

PowerPointSlide.Visibility.cs:41

Shows the slide in slide show mode.

StackGroupChildren 2 overloads

public void StackGroupChildren(PowerPointGroupShape groupShape, PowerPointShapeStackDirection direction, OfficeLength spacing)

PowerPointSlide.GroupLayout.cs:213

Stacks child shapes within the group's bounds.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose children are arranged in their native child coordinate space.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.

public void StackGroupChildren(PowerPointGroupShape groupShape, PowerPointShapeStackDirection direction, PowerPointShapeStackOptions? options)

PowerPointSlide.GroupLayout.cs:231

Stacks child shapes within the group's bounds using options.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required: Group whose children are arranged in their native child coordinate space.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
options OfficeIMO.PowerPoint.PowerPointShapeStackOptions? required: Layout settings, or null to use the default settings.

StackShapes 9 overloads

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing)

PowerPointSlide.Stack.cs:11

Stacks shapes within their selection bounds using a fixed spacing.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, PowerPointShapeAlignment alignment)

PowerPointSlide.Stack.cs:25

Stacks shapes within their selection bounds using a fixed spacing and alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:38

Stacks shapes within their selection bounds using a fixed spacing and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, PowerPointShapeAlignment alignment, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:53

Stacks shapes within their selection bounds using a fixed spacing, alignment, and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, PowerPointLayoutBox bounds, OfficeLength spacing)

PowerPointSlide.Stack.cs:66

Stacks shapes within a custom bounding box using a fixed spacing.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, PowerPointLayoutBox bounds, OfficeLength spacing, PowerPointShapeAlignment alignment)

PowerPointSlide.Stack.cs:81

Stacks shapes within a custom bounding box using a fixed spacing and alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, PowerPointLayoutBox bounds, OfficeLength spacing, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:95

Stacks shapes within a custom bounding box using a fixed spacing and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, PowerPointLayoutBox bounds, OfficeLength spacing, PowerPointShapeAlignment alignment, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:110

Stacks shapes within a custom bounding box using a fixed spacing, alignment, and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapes(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, PowerPointLayoutBox bounds, PowerPointShapeStackOptions? options)

PowerPointSlide.Stack.cs:123

Stacks shapes within a custom bounding box using options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
bounds OfficeIMO.PowerPoint.PowerPointLayoutBox required: Target region; positions may be signed and dimensions must be nonnegative.
options OfficeIMO.PowerPoint.PowerPointShapeStackOptions? required: Layout settings, or null to use the default settings.

StackShapesToSlide 5 overloads

public void StackShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing)

PowerPointSlide.Stack.cs:138

Stacks shapes within the slide bounds using a fixed spacing.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.

public void StackShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, PowerPointShapeAlignment alignment)

PowerPointSlide.Stack.cs:152

Stacks shapes within the slide bounds using a fixed spacing and alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void StackShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:165

Stacks shapes within the slide bounds using a fixed spacing and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, PowerPointShapeAlignment alignment, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:179

Stacks shapes within the slide bounds using a fixed spacing, alignment, and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapesToSlide(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, PowerPointShapeStackOptions? options)

PowerPointSlide.Stack.cs:190

Stacks shapes within the slide bounds using options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
options OfficeIMO.PowerPoint.PowerPointShapeStackOptions? required: Layout settings, or null to use the default settings.

StackShapesToSlideContent 5 overloads

public void StackShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, OfficeLength margin)

PowerPointSlide.Stack.cs:203

Stacks shapes within the slide content bounds using a margin.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.

public void StackShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, OfficeLength margin, PowerPointShapeAlignment alignment)

PowerPointSlide.Stack.cs:218

Stacks shapes within the slide content bounds using a margin and alignment.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.

public void StackShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, OfficeLength margin, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:233

Stacks shapes within the slide content bounds using a margin and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength spacing, OfficeLength margin, PowerPointShapeAlignment alignment, PowerPointShapeStackJustify justify)

PowerPointSlide.Stack.cs:249

Stacks shapes within the slide content bounds using a margin, alignment, and justification.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
spacing OfficeIMO.OfficeLength required: Nonnegative distance between adjacent shapes.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
alignment OfficeIMO.PowerPoint.PowerPointShapeAlignment required: Alignment within the bounds on the applicable axis.
justify OfficeIMO.PowerPoint.PowerPointShapeStackJustify required: Position of the stack along its main axis.

public void StackShapesToSlideContent(IEnumerable<PowerPointShape> shapes, PowerPointShapeStackDirection direction, OfficeLength margin, PowerPointShapeStackOptions? options)

PowerPointSlide.Stack.cs:262

Stacks shapes within the slide content bounds using a margin and options.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.PowerPoint.PowerPointShape> required: Shapes to arrange; null entries are ignored.
direction OfficeIMO.PowerPoint.PowerPointShapeStackDirection required: Axis along which the stack grows.
margin OfficeIMO.OfficeLength required: Nonnegative inset on every side of the slide.
options OfficeIMO.PowerPoint.PowerPointShapeStackOptions? required: Layout settings, or null to use the default settings.

public void StopTransitionSound() #

PowerPointSlide.TransitionSounds.cs:59

Stops any currently playing transition sound on entry to this slide.

ToImage 3 overloads

public OfficeImageExportResult ToImage(PowerPointImageExportOptions? options = null, CancellationToken cancellationToken = default)

PowerPointSlide.Imaging.Conversion.cs:9

Renders the slide using the encoding in OfficeImageExportOptions.Format.

Parameters

options OfficeIMO.PowerPoint.PowerPointImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult

public OfficeImageExportResult ToImage(PowerPointImageExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)

PowerPointSlide.Imaging.Conversion.cs:14

Renders the slide and returns its immutable fidelity report.

Parameters

options OfficeIMO.PowerPoint.PowerPointImageExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult

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

PowerPointSlide.Imaging.cs:21

Exports this slide as a supported raster format or SVG.

Parameters

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

Returns

OfficeImageExportResult

public async Task<OfficeImageExportResult> ToImageAsync(PowerPointImageExportOptions? options = null, CancellationToken cancellationToken = default)

Renders the slide with cancellation and returns the encoded image and its diagnostics.

Parameters

options OfficeIMO.PowerPoint.PowerPointImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeImageExportResult>

public bool TryGetShapeByName(string name, out PowerPointShape? shape, bool ignoreCase = false) #

PowerPointSlide.Lookup.cs:33

Attempts to retrieve a shape by name.

Parameters

name string required
shape OfficeIMO.PowerPoint.PowerPointShape? required
ignoreCase bool = false optional

Returns

bool

public bool TryGetShapeByName<T>(string name, out T? shape, bool ignoreCase = false) #

PowerPointSlide.Lookup.cs:48

Attempts to retrieve a typed shape by name.

Type Parameters

T

Parameters

name string required
shape T? required
ignoreCase bool = false optional

Returns

bool

public IReadOnlyList<PowerPointShape> UngroupShape(PowerPointGroupShape groupShape) #

PowerPointSlide.Group.cs:70

Ungroups a group shape back into its child shapes.

Parameters

groupShape OfficeIMO.PowerPoint.PowerPointGroupShape required

Returns

IReadOnlyList<PowerPointShape>

Inherited Methods

Properties

public OfficeColor? BackgroundColor { get; set; } #

PowerPointSlide.Background.cs:15

Gets or sets the local solid background color, retaining native theme slots and opacity.

public IReadOnlyList<PowerPointClassicAnimation> ClassicAnimations { get; } #

PowerPointSlide.ClassicAnimations.cs:15

Gets the editable classic animations authored by OfficeIMO or imported from binary PPT.

public IReadOnlyList<PowerPointShape> Shapes { get; } #

PowerPointSlide.cs:35

Collection of shapes on the slide.

public IEnumerable<PowerPointTextBox> TextBoxes { get; } #

PowerPointSlide.cs:40

Enumerates all textbox shapes on the slide.

public IEnumerable<PowerPointImage> Images { get; } #

PowerPointSlide.cs:45

Enumerates all image shapes on the slide.

public IEnumerable<PowerPointMedia> Media { get; } #

PowerPointSlide.cs:50

Enumerates all embedded audio and video media shapes on the slide.

public IEnumerable<PowerPointTable> Tables { get; } #

PowerPointSlide.cs:55

Enumerates all table shapes on the slide.

public IEnumerable<PowerPointChart> Charts { get; } #

PowerPointSlide.cs:60

Enumerates all charts on the slide.

public IEnumerable<PowerPointSmartArt> SmartArts { get; } #

PowerPointSlide.cs:65

Enumerates all SmartArt diagrams on the slide.

public IEnumerable<PowerPointOleObject> OleObjects { get; } #

PowerPointSlide.cs:71

Enumerates all embedded OLE compound objects on the slide.

public PowerPointNotes Notes { get; } #

PowerPointSlide.cs:104

Notes associated with the slide.

public int Index { get; } #

PowerPointSlide.Inspection.cs:10

Zero-based position in the owning presentation, or -1 for a detached slide.

public int LayoutIndex { get; } #

PowerPointSlide.Layout.cs:15

Gets the index of the layout used by this slide.

public PowerPointSlideLayout? Layout { get; } #

PowerPointSlide.Layout.cs:62

The layout this slide uses, or null when the slide has no layout.

public IReadOnlyList<PowerPointTextBox> Placeholders { get; } #

PowerPointSlide.Layout.cs:144

Textboxes that map to placeholders in the slide layout.

public string? Name { get; set; } #

PowerPointSlide.Metadata.cs:8

Gets or sets the authored slide name stored in common slide data.

public bool HasSpeakerNotes { get; } #

PowerPointSlide.NotesInspection.cs:8

Whether the slide already contains a speaker-notes part.

public PowerPointSlideTransition Transition { get; set; } #

PowerPointSlide.Transitions.cs:15

Transition applied when moving to this slide.

public PowerPointSlideTransitionSpeed? TransitionSpeed { get; set; } #

PowerPointSlide.Transitions.cs:144

Gets or sets the optional transition playback speed.

public double? TransitionDurationSeconds { get; set; } #

PowerPointSlide.Transitions.cs:180

Gets or sets the optional transition duration in seconds.

public bool? TransitionAdvanceOnClick { get; set; } #

PowerPointSlide.Transitions.cs:206

Gets or sets whether clicking advances the slide.

public double? TransitionAdvanceAfterSeconds { get; set; } #

PowerPointSlide.Transitions.cs:225

Gets or sets the optional automatic-advance time in seconds.

public bool HasTransitionSound { get; } #

PowerPointSlide.TransitionSounds.cs:6

Gets whether this slide starts an embedded transition sound.

public string? TransitionSoundName { get; } #

PowerPointSlide.TransitionSounds.cs:10

Gets the embedded transition sound name, when present.

public bool TransitionSoundLoops { get; } #

PowerPointSlide.TransitionSounds.cs:14

Gets whether the embedded transition sound loops.

public bool TransitionStopsSound { get; } #

PowerPointSlide.TransitionSounds.cs:17

Gets whether this transition stops the currently playing sound.

public bool Hidden { get; set; } #

PowerPointSlide.Visibility.cs:15

Gets or sets whether the slide is hidden in slide show mode.

Inheritance

Guides & Samples

Usage

Returned or exposed by 12

Accepted by parameters 21

Methods

Inherited Methods

Properties