ButtonFormControl Interface
A button form control.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v24.1.Core.dll
NuGet Package: DevExpress.Spreadsheet.Core
Declaration
public interface ButtonFormControl :
FormControl,
Shape,
FloatingObject,
ShapeFormatBase,
TextFormControlRelated API Members
The following members return ButtonFormControl objects:
Remarks
Create a Button Form Control
The code sample below creates a button form control:
using DevExpress.Spreadsheet;
Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var cellRange = workbook.Worksheets[0].Range["B2:C4"];
var buttonFormControl = formControls.AddButton(cellRange);
buttonFormControl.PlainText = "Click Here";
buttonFormControl.PrintObject = false;
Note
The FormControlCollection.AddButton method call adds a new item to both FormControlCollection and ShapeCollection.
Obtain Button Form Controls
The Worksheet.FormControls property obtains all form controls in a worksheet. You can use one of the following ways to obtain a specific form control:
- Access the item in the collection by its index
- Call the FormControlCollection.GetFormControlsByName method
- Call the FormControlCollection.GetFormControlById method
The Id and Name properties return the form control’s identifier and name.
Modify Button Form Controls
Use the ButtonFormControl class properties to change button form control parameters.
Note
The ShapeFormatBase.Fill and ShapeFormatBase.Outline properties return null for the ButtonFormControl.
The code sample below retrieves all button form controls from a worksheet and disables printing for all buttons:
using DevExpress.Spreadsheet;
using System.Linq;
Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var formControls = workbook.Worksheets[0].FormControls;
var buttons = formControls.Where(formControl => formControl.FormControlType == FormControlType.Button).Cast<ButtonFormControl>();
foreach (ButtonFormControl button in buttons) {
button.PrintObject = false;
}
Remove Button Form Controls
Call the FormControlCollection.Remove or FormControlCollection.RemoveAt method to remove a form control.
The code sample below removes all buttons from a worksheet:
Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var formControls = workbook.Worksheets[0].FormControls;
for (int i = formControls.Count - 1; i >= 0; i--) {
if (formControls[i].FormControlType == FormControlType.Button)
formControls.RemoveAt(i);
}