GrapeCity.Documents.Excel.Forms.IControl

Interface IControl

Namespace

GrapeCity.Documents.Excel.Forms

Assembly

GcDocs.Excel.dll

The base of form controls.

public interface IControl

Properties

BottomRightCell

Gets the bottom right cell of this control.

IRange BottomRightCell { get; }

Property Value

IRange

Enabled

Indicates whether the control is enabled.

bool Enabled { get; set; }

Property Value

bool

Remarks

Not supported by the *.ssjson format.

FormControlType

Returns the form control type of this control.

FormControlType FormControlType { get; }

Property Value

FormControlType

Height

The height of this control.

double Height { get; set; }

Property Value

double

Left

The left margin of this control.

double Left { get; set; }

Property Value

double

Locked

Indicates whether the control is locked.

bool Locked { get; set; }

Property Value

bool

Remarks

Not supported by the *.ssjson and *.sjs format.

Name

Gets or sets the name of this control.

string Name { get; set; }

Property Value

string

Parent

The parent object, typically IWorksheet. In some cases, the type of this property is IControl.

object Parent { get; }

Property Value

object

Placement

Gets or sets the way a control is attached to its underlying cells.

Placement Placement { get; set; }

Property Value

Placement

PrintObject

Indicates whether the control will be printed.

bool PrintObject { get; set; }

Property Value

bool

ShapeRange

The shapes of this control.

IShapeRange ShapeRange { get; }

Property Value

IShapeRange

Top

The top margin of this control.

double Top { get; set; }

Property Value

double

TopLeftCell

Gets the top left cell of this control.

IRange TopLeftCell { get; }

Property Value

IRange

Visible

Indicates whether the control is visible.

bool Visible { get; set; }

Property Value

bool

Width

The width of this control.

double Width { get; set; }

Property Value

double

ZOrder

The z-index of this control.

int ZOrder { get; }

Property Value

int

Methods

BringToFront()

Change z-index of this control to front.

bool BringToFront()

Returns

bool

Delete()

Remove this control from parent.

void Delete()

SendToBack()

Send the Z-Index to back.

bool SendToBack()

Returns

bool

Returns true if succeed.