OfficeIMO

API Reference

Class

PowerPointShape

Namespace OfficeIMO.PowerPoint
Assembly OfficeIMO.PowerPoint
Modifiers abstract

Base class for shapes used on PowerPoint slides.

Inheritance

  • Object
  • PowerPointShape

Methods

public Void BringToFront() #
Returns: Void

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

public Void ClearBlur() #
Returns: Void

Removes any blur effect from the shape.

public Void ClearGlow() #
Returns: Void

Removes any glow effect from the shape.

public Void ClearReflection() #
Returns: Void

Removes any reflection effect from the shape.

public Void ClearShadow() #
Returns: Void

Removes any drop shadow from the shape.

public Void ClearSoftEdges() #
Returns: Void

Removes any soft edges effect from the shape.

public Void MoveBy(Int64 offsetX, Int64 offsetY) #
Returns: Void

Moves the shape by the specified offsets in EMUs.

Parameters

offsetX System.Int64 requiredposition: 0
offsetY System.Int64 requiredposition: 1
public Void MoveByCm(Double offsetXCm, Double offsetYCm) #
Returns: Void

Moves the shape by the specified offsets in centimeters.

Parameters

offsetXCm System.Double requiredposition: 0
offsetYCm System.Double requiredposition: 1
public Void MoveByInches(Double offsetXInches, Double offsetYInches) #
Returns: Void

Moves the shape by the specified offsets in inches.

Parameters

offsetXInches System.Double requiredposition: 0
offsetYInches System.Double requiredposition: 1
public Void MoveByPoints(Double offsetXPoints, Double offsetYPoints) #
Returns: Void

Moves the shape by the specified offsets in points.

Parameters

offsetXPoints System.Double requiredposition: 0
offsetYPoints System.Double requiredposition: 1
public Void Resize(Int64 width, Int64 height, PowerPointShapeAnchor anchor = TopLeft) #
Returns: Void

Resizes the shape while keeping the specified anchor fixed.

Parameters

width System.Int64 requiredposition: 0
height System.Int64 requiredposition: 1
anchor OfficeIMO.PowerPoint.PowerPointShapeAnchor = TopLeft optionalposition: 2
public Void ResizeCm(Double widthCm, Double heightCm, PowerPointShapeAnchor anchor = TopLeft) #
Returns: Void

Resizes the shape using centimeters while keeping the specified anchor fixed.

Parameters

widthCm System.Double requiredposition: 0
heightCm System.Double requiredposition: 1
anchor OfficeIMO.PowerPoint.PowerPointShapeAnchor = TopLeft optionalposition: 2
public Void ResizeInches(Double widthInches, Double heightInches, PowerPointShapeAnchor anchor = TopLeft) #
Returns: Void

Resizes the shape using inches while keeping the specified anchor fixed.

Parameters

widthInches System.Double requiredposition: 0
heightInches System.Double requiredposition: 1
anchor OfficeIMO.PowerPoint.PowerPointShapeAnchor = TopLeft optionalposition: 2
public Void ResizePoints(Double widthPoints, Double heightPoints, PowerPointShapeAnchor anchor = TopLeft) #
Returns: Void

Resizes the shape using points while keeping the specified anchor fixed.

Parameters

widthPoints System.Double requiredposition: 0
heightPoints System.Double requiredposition: 1
anchor OfficeIMO.PowerPoint.PowerPointShapeAnchor = TopLeft optionalposition: 2
Scale 2 overloads
public Void Scale(Double scale, PowerPointShapeAnchor anchor = Center) #
Returns: Void

Scales the shape uniformly using the specified anchor.

Parameters

scale System.Double requiredposition: 0
anchor OfficeIMO.PowerPoint.PowerPointShapeAnchor = Center optionalposition: 1
public Void Scale(Double scaleX, Double scaleY, PowerPointShapeAnchor anchor = Center) #
Returns: Void

Scales the shape using separate X/Y factors and the specified anchor.

Parameters

scaleX System.Double requiredposition: 0
scaleY System.Double requiredposition: 1
anchor OfficeIMO.PowerPoint.PowerPointShapeAnchor = Center optionalposition: 2
public Void SendToBack() #
Returns: Void

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

public Void SetBlur(Double radiusPoints, Boolean grow = false) #
Returns: Void

Applies a blur effect to the shape.

Parameters

radiusPoints System.Double requiredposition: 0
grow System.Boolean = false optionalposition: 1
public Void SetGlow(String color, Double radiusPoints = 4, Int32 transparencyPercent = 30) #
Returns: Void

Applies a glow effect to the shape.

Parameters

color System.String requiredposition: 0
radiusPoints System.Double = 4 optionalposition: 1
transparencyPercent System.Int32 = 30 optionalposition: 2
public Void SetLineEnds(Nullable<LineEndValues> startType, Nullable<LineEndValues> endType, Nullable<LineEndWidthValues> width = null, Nullable<LineEndLengthValues> length = null) #
Returns: Void

Sets arrowheads for line-based shapes.

Parameters

startType System.Nullable{DocumentFormat.OpenXml.Drawing.LineEndValues} requiredposition: 0
endType System.Nullable{DocumentFormat.OpenXml.Drawing.LineEndValues} requiredposition: 1
width System.Nullable{DocumentFormat.OpenXml.Drawing.LineEndWidthValues} = null optionalposition: 2
length System.Nullable{DocumentFormat.OpenXml.Drawing.LineEndLengthValues} = null optionalposition: 3
public Void SetPositionCm(Double leftCm, Double topCm) #
Returns: Void

Sets position using centimeters.

Parameters

leftCm System.Double requiredposition: 0
topCm System.Double requiredposition: 1
public Void SetPositionInches(Double leftInches, Double topInches) #
Returns: Void

Sets position using inches.

Parameters

leftInches System.Double requiredposition: 0
topInches System.Double requiredposition: 1
public Void SetPositionPoints(Double leftPoints, Double topPoints) #
Returns: Void

Sets position using points.

Parameters

leftPoints System.Double requiredposition: 0
topPoints System.Double requiredposition: 1
public Void SetReflection(Double blurPoints = 4, Double distancePoints = 2, Double directionDegrees = 270, Double fadeDirectionDegrees = 90, Int32 startOpacityPercent = 50, Int32 endOpacityPercent = 0, Int32 startPositionPercent = 0, Int32 endPositionPercent = 100, Nullable<RectangleAlignmentValues> alignment = null, Boolean rotateWithShape = false) #
Returns: Void

Applies a reflection effect to the shape.

Parameters

blurPoints System.Double = 4 optionalposition: 0
distancePoints System.Double = 2 optionalposition: 1
directionDegrees System.Double = 270 optionalposition: 2
fadeDirectionDegrees System.Double = 90 optionalposition: 3
startOpacityPercent System.Int32 = 50 optionalposition: 4
endOpacityPercent System.Int32 = 0 optionalposition: 5
startPositionPercent System.Int32 = 0 optionalposition: 6
endPositionPercent System.Int32 = 100 optionalposition: 7
alignment System.Nullable{DocumentFormat.OpenXml.Drawing.RectangleAlignmentValues} = null optionalposition: 8
rotateWithShape System.Boolean = false optionalposition: 9
public Void SetShadow(String color, Double blurPoints = 4, Double distancePoints = 3, Double angleDegrees = 45, Int32 transparencyPercent = 35, Boolean rotateWithShape = false) #
Returns: Void

Applies a drop shadow to the shape.

Parameters

color System.String requiredposition: 0
blurPoints System.Double = 4 optionalposition: 1
distancePoints System.Double = 3 optionalposition: 2
angleDegrees System.Double = 45 optionalposition: 3
transparencyPercent System.Int32 = 35 optionalposition: 4
rotateWithShape System.Boolean = false optionalposition: 5
public Void SetSizeCm(Double widthCm, Double heightCm) #
Returns: Void

Sets size using centimeters.

Parameters

widthCm System.Double requiredposition: 0
heightCm System.Double requiredposition: 1
public Void SetSizeInches(Double widthInches, Double heightInches) #
Returns: Void

Sets size using inches.

Parameters

widthInches System.Double requiredposition: 0
heightInches System.Double requiredposition: 1
public Void SetSizePoints(Double widthPoints, Double heightPoints) #
Returns: Void

Sets size using points.

Parameters

widthPoints System.Double requiredposition: 0
heightPoints System.Double requiredposition: 1
public Void SetSoftEdges(Double radiusPoints) #
Returns: Void

Applies a soft edges effect to the shape.

Parameters

radiusPoints System.Double requiredposition: 0

Properties

public String Name { get; } #

Name assigned to the shape.

public String FillColor { get; set; } #

Gets or sets the fill color of the shape in hex format (e.g. "FF0000").

public Int64 Left { get; set; } #

Horizontal position of the shape in EMUs.

public Double LeftPoints { get; set; } #

Horizontal position of the shape in points.

public Double LeftCm { get; set; } #

Horizontal position of the shape in centimeters.

public Double LeftInches { get; set; } #

Horizontal position of the shape in inches.

public Int64 Top { get; set; } #

Vertical position of the shape in EMUs.

public Double TopPoints { get; set; } #

Vertical position of the shape in points.

public Double TopCm { get; set; } #

Vertical position of the shape in centimeters.

public Double TopInches { get; set; } #

Vertical position of the shape in inches.

public Int64 Width { get; set; } #

Width of the shape in EMUs.

public Double WidthPoints { get; set; } #

Width of the shape in points.

public Double WidthCm { get; set; } #

Width of the shape in centimeters.

public Double WidthInches { get; set; } #

Width of the shape in inches.

public Int64 Height { get; set; } #

Height of the shape in EMUs.

public Double HeightPoints { get; set; } #

Height of the shape in points.

public Double HeightCm { get; set; } #

Height of the shape in centimeters.

public Double HeightInches { get; set; } #

Height of the shape in inches.

public Int64 Right { get; set; } #

Right position of the shape in EMUs.

public Double RightPoints { get; set; } #

Right position of the shape in points.

public Double RightCm { get; set; } #

Right position of the shape in centimeters.

public Double RightInches { get; set; } #

Right position of the shape in inches.

public Int64 Bottom { get; set; } #

Bottom position of the shape in EMUs.

public Double BottomPoints { get; set; } #

Bottom position of the shape in points.

public Double BottomCm { get; set; } #

Bottom position of the shape in centimeters.

public Double BottomInches { get; set; } #

Bottom position of the shape in inches.

public Int64 CenterX { get; set; } #

Horizontal center of the shape in EMUs.

public Double CenterXPoints { get; set; } #

Horizontal center of the shape in points.

public Double CenterXCm { get; set; } #

Horizontal center of the shape in centimeters.

public Double CenterXInches { get; set; } #

Horizontal center of the shape in inches.

public Int64 CenterY { get; set; } #

Vertical center of the shape in EMUs.

public Double CenterYPoints { get; set; } #

Vertical center of the shape in points.

public Double CenterYCm { get; set; } #

Vertical center of the shape in centimeters.

public Double CenterYInches { get; set; } #

Vertical center of the shape in inches.

public PowerPointLayoutBox Bounds { get; set; } #

Gets or sets the shape bounds in EMUs.

public String OutlineColor { get; set; } #

Gets or sets the outline color for the shape in hex format (e.g. "FF0000").

public Nullable<Double> OutlineWidthPoints { get; set; } #

Gets or sets the outline width in points.

public Nullable<PresetLineDashValues> OutlineDash { get; set; } #

Gets or sets the outline dash preset.

public Nullable<Int32> FillTransparency { get; set; } #

Gets or sets the fill transparency percentage (0-100). 0 = opaque, 100 = fully transparent.

public Nullable<Double> Rotation { get; set; } #

Gets or sets rotation in degrees.

public Nullable<Boolean> HorizontalFlip { get; set; } #

Gets or sets horizontal flip.

public Nullable<Boolean> VerticalFlip { get; set; } #

Gets or sets vertical flip.