Class ExcelControl

An abstract class inherited by form controls

Inheritance
System.Object
XmlHelper
ExcelDrawing
ExcelControl
ExcelControlDialog
ExcelControlList
ExcelControlScrollBar
ExcelControlSpinButton
ExcelControlWithText
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.Controls
Assembly: EPPlus.dll
Syntax
public abstract class ExcelControl : ExcelDrawing, IDisposable, IPictureContainer

Constructors

ExcelControl(ExcelDrawings, XmlNode, String, ExcelGroupShape)

Declaration
protected ExcelControl(ExcelDrawings drawings, XmlNode drawingNode, string name, ExcelGroupShape parent = null)
Parameters
Type Name Description
ExcelDrawings drawings
System.Xml.XmlNode drawingNode
System.String name
ExcelGroupShape parent

Properties

AlternativeText

Gets or sets the alternative text for the control.

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

AutoFill

If the controls fill formatting is provided automatically

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

AutoPict

If the controls size is formatted automatically.

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

ControlPropertiesXml

The control property xml associated with the control

Declaration
public XmlDocument ControlPropertiesXml { get; }
Property Value
Type Description
System.Xml.XmlDocument

ControlType

The type of form control

Declaration
public abstract eControlType ControlType { get; }
Property Value
Type Description
eControlType

DefaultSize

Returns true if the object is at its default size.

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

Disabled

If true, the object is allowed to run an attached macro

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

DrawingType

The type of drawing. Always set to Control

Declaration
public override eDrawingType DrawingType { get; }
Property Value
Type Description
eDrawingType
Overrides
Declaration
protected ExcelAddressBase FmlaLink { get; set; }
Property Value
Type Description
ExcelAddressBase

LinkedCell

Gets or sets the address to the cell that is linked to the control.

Declaration
public ExcelAddressBase LinkedCell { get; set; }
Property Value
Type Description
ExcelAddressBase

LinkedGroup

Declaration
protected ExcelAddressBase LinkedGroup { get; set; }
Property Value
Type Description
ExcelAddressBase

Locked

The object is locked when the sheet is protected..

Declaration
public override bool Locked { get; set; }
Property Value
Type Description
System.Boolean
Overrides

Macro

Gets or sets the macro function assigned.

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

Name

The name of the control

Declaration
public override string Name { get; set; }
Property Value
Type Description
System.String
Overrides

Print

The object is printed when the document is printed.

Declaration
public override bool Print { get; set; }
Property Value
Type Description
System.Boolean
Overrides

ThreeDEffects

If the control has 3D effects enabled.

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

Methods

SetLinkedCellValue(Int32)

Declaration
protected void SetLinkedCellValue(int value)
Parameters
Type Name Description
System.Int32 value

Implements

System.IDisposable