Class ExcelShapeBase¶

Namespace: OfficeOpenXml.Drawing
Assembly: EPPlus.dll

Base class for drawing-shape objects

public class ExcelShapeBase : ExcelDrawing, IDisposable

Inheritance¶

object ← XmlHelper ← ExcelDrawing ← ExcelShapeBase

Derived¶

ExcelConnectionShape
ExcelShape

Implements¶

IDisposable

Inherited Members¶

ExcelDrawing.AdjustPositionAndSize()
ExcelDrawing.As
ExcelDrawing.BringToFront()
ExcelDrawing.CellAnchor
ExcelDrawing.ChangeCellAnchor(eEditAs, int, int, int, int)
ExcelDrawing.ChangeCellAnchor(eEditAs)
ExcelDrawing.Copy(ExcelWorksheet, int, int, int, int)
ExcelDrawing.Description
ExcelDrawing.Dispose()
ExcelDrawing.DrawingType
ExcelDrawing.EditAs
ExcelDrawing.EMU_PER_CM
ExcelDrawing.EMU_PER_MM
ExcelDrawing.EMU_PER_PICA
ExcelDrawing.EMU_PER_PIXEL
ExcelDrawing.EMU_PER_POINT
ExcelDrawing.EMU_PER_US_INCH
ExcelDrawing.From
ExcelDrawing.Group(params ExcelDrawing[])
ExcelDrawing.Hyperlink
ExcelDrawing.Locked
ExcelDrawing.Name
ExcelDrawing.ParentGroup
ExcelDrawing.Position
ExcelDrawing.Print
ExcelDrawing.SendToBack()
ExcelDrawing.SetPosition(int, int, int, int)
ExcelDrawing.SetPosition(int, int)
ExcelDrawing.SetSize(int, int)
ExcelDrawing.SetSize(int)
ExcelDrawing.Size
ExcelDrawing.To
ExcelDrawing.UnGroup(bool)
object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties¶

Border¶

Access to Border propesties

public ExcelDrawingBorder Border { get; }

Property Value¶

ExcelDrawingBorder

DrawingType¶

The type of drawing

public override eDrawingType DrawingType { get; }

Property Value¶

eDrawingType

Effect¶

Drawing effect properties

public ExcelDrawingEffectStyle Effect { get; }

Property Value¶

ExcelDrawingEffectStyle

Fill¶

Access Fill properties

public ExcelDrawingFill Fill { get; }

Property Value¶

ExcelDrawingFill

Font¶

Font properties

public ExcelTextFont Font { get; }

Property Value¶

ExcelTextFont

HeadEnd¶

Head line end

public ExcelDrawingLineEnd HeadEnd { get; }

Property Value¶

ExcelDrawingLineEnd

HorizontalFlip¶

If true, flips the shape horizontal about the center of its bounding box.

public bool HorizontalFlip { get; set; }

Property Value¶

bool

Indent¶

Indentation

public int Indent { get; set; }

Property Value¶

int

LockText¶

Lock drawing

public bool LockText { get; set; }

Property Value¶

bool

RichText¶

Richtext collection. Used to format specific parts of the text

public ExcelParagraphCollection RichText { get; }

Property Value¶

ExcelParagraphCollection

Rotation¶

Rotation angle in degrees. Positive angles are clockwise. Negative angles are counter-clockwise.

public double Rotation { get; set; }

Property Value¶

double

Style¶

Shape style

public virtual eShapeStyle Style { get; set; }

Property Value¶

eShapeStyle

TailEnd¶

Tail line end

public ExcelDrawingLineEnd TailEnd { get; }

Property Value¶

ExcelDrawingLineEnd

Text¶

Text inside the shape

public string Text { get; set; }

Property Value¶

string

TextAlignment¶

How the text is aligned

public eTextAlignment TextAlignment { get; set; }

Property Value¶

eTextAlignment

TextAnchoring¶

Text Anchoring

public eTextAnchoringType TextAnchoring { get; set; }

Property Value¶

eTextAnchoringType

TextAnchoringControl¶

The centering of the text box.

public bool TextAnchoringControl { get; set; }

Property Value¶

bool

TextBody¶

Access to text body properties.

public ExcelTextBody TextBody { get; }

Property Value¶

ExcelTextBody

TextVertical¶

Vertical text

public eTextVerticalType TextVertical { get; set; }

Property Value¶

eTextVerticalType

ThreeD¶

Defines 3D properties to apply to an object

public ExcelDrawing3D ThreeD { get; }

Property Value¶

ExcelDrawing3D

VerticalFlip¶

If true, flips the shape vertical about the center of its bounding box.

public bool VerticalFlip { get; set; }

Property Value¶

bool

Methods¶

GetAdjustmentPointsNames()¶

Get a list of available adjustment point names.

public EPPlusReadOnlyList<string> GetAdjustmentPointsNames()

Returns¶

EPPlusReadOnlyList<string>

RemoveAdjustmentPoints()¶

Remove all the shapes adjustments.

public void RemoveAdjustmentPoints()

SetAdjustmentPoint(string, int)¶

Adjust the named point with value.

public void SetAdjustmentPoint(string name, int value)

Parameters¶

name string

The name of the adjustment point. Use GetShapeGuideNames for a list of possible shape guides to adjust.

value int

The value to set for the shape guide. Value is different from shape to shape. Some shapes clamp the value and some are free.

Exceptions¶

Exception