Class ExcelShapeBase

Base class for drawing-shape objects

Inheritance
System.Object
XmlHelper
ExcelDrawing
ExcelShapeBase
ExcelConnectionShape
ExcelShape
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: OfficeOpenXml.Drawing
Assembly: EPPlus.dll
Syntax
public class ExcelShapeBase : ExcelDrawing, IDisposable

Properties

Border

Access to Border propesties

Declaration
public ExcelDrawingBorder Border { get; }
Property Value
Type Description
ExcelDrawingBorder

DrawingType

The type of drawing

Declaration
public override eDrawingType DrawingType { get; }
Property Value
Type Description
eDrawingType
Overrides

Effect

Drawing effect properties

Declaration
public ExcelDrawingEffectStyle Effect { get; }
Property Value
Type Description
ExcelDrawingEffectStyle

Fill

Access Fill properties

Declaration
public ExcelDrawingFill Fill { get; }
Property Value
Type Description
ExcelDrawingFill

Font

Font properties

Declaration
public ExcelTextFont Font { get; }
Property Value
Type Description
ExcelTextFont

HeadEnd

Head line end

Declaration
public ExcelDrawingLineEnd HeadEnd { get; }
Property Value
Type Description
ExcelDrawingLineEnd

HorizontalFlip

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

Declaration
public bool HorizontalFlip { get; set; }
Property Value
Type Description
System.Boolean

Indent

Indentation

Declaration
public int Indent { get; set; }
Property Value
Type Description
System.Int32

LockText

Lock drawing

Declaration
public bool LockText { get; set; }
Property Value
Type Description
System.Boolean

RichText

Richtext collection. Used to format specific parts of the text

Declaration
public ExcelParagraphCollection RichText { get; }
Property Value
Type Description
ExcelParagraphCollection

Rotation

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

Declaration
public double Rotation { get; set; }
Property Value
Type Description
System.Double

Style

Shape style

Declaration
public virtual eShapeStyle Style { get; set; }
Property Value
Type Description
eShapeStyle

TailEnd

Tail line end

Declaration
public ExcelDrawingLineEnd TailEnd { get; }
Property Value
Type Description
ExcelDrawingLineEnd

Text

Text inside the shape

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

TextAlignment

How the text is aligned

Declaration
public eTextAlignment TextAlignment { get; set; }
Property Value
Type Description
eTextAlignment

TextAnchoring

Text Anchoring

Declaration
public eTextAnchoringType TextAnchoring { get; set; }
Property Value
Type Description
eTextAnchoringType

TextAnchoringControl

The centering of the text box.

Declaration
public bool TextAnchoringControl { get; set; }
Property Value
Type Description
System.Boolean

TextBody

Access to text body properties.

Declaration
public ExcelTextBody TextBody { get; }
Property Value
Type Description
ExcelTextBody

TextVertical

Vertical text

Declaration
public eTextVerticalType TextVertical { get; set; }
Property Value
Type Description
eTextVerticalType

ThreeD

Defines 3D properties to apply to an object

Declaration
public ExcelDrawing3D ThreeD { get; }
Property Value
Type Description
ExcelDrawing3D

VerticalFlip

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

Declaration
public bool VerticalFlip { get; set; }
Property Value
Type Description
System.Boolean

Methods

GetAdjustmentPointsNames()

Get a list of available adjustment point names.

Declaration
public EPPlusReadOnlyList<string> GetAdjustmentPointsNames()
Returns
Type Description
EPPlusReadOnlyList<System.String>

RemoveAdjustmentPoints()

Remove all the shapes adjustments.

Declaration
public void RemoveAdjustmentPoints()

SetAdjustmentPoint(String, Int32)

Adjust the named point with value.

Declaration
public void SetAdjustmentPoint(string name, int value)
Parameters
Type Name Description
System.String name

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

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
Type Condition
System.Exception

Implements

System.IDisposable