XlsFile.SetCheckboxState Method
Sets the value of a checkbox in the active sheet. Note that this only works for checkboxes added through the Forms toolbar. It won't return the values of ActiveX checkboxes.
Remarks
If the checkbox is linked to a cell, this method will change both the checkbox and the cell.
Syntax
Namespace: FlexCel.XlsAdapter
public override void SetCheckboxState(Int32 objectIndex, String objectPath, TCheckboxState value)
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
objectIndex | Int32 | Index of the object (1 based) | |
objectPath | String | Index to the child object you want to change the property. If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from ExcelFile.GetObjectProperties(Int32, Boolean) If it is "absolute"(it starts with "\\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\\1\\2\\3" is exactly the same as using objectIndex = 1 and objectPath = "2\\3" |
|
value | TCheckboxState | Value to set. |
Examples
To set a checkbox given its text, use the code:
XlsFile xls = new XlsFile("checkboxes.xls");
for (int i = 1; i <= xls.ObjectCount; i++)
{
TShapeProperties shp = xls.GetObjectProperties(i, false);
if (shp.ObjectType == TObjectType.CheckBox && shp.Text == "MyText")
{
xls.SetCheckboxState(i, null, TCheckboxState.Checked);
}
}
To change a checkbox given its name instead of its text, replace shp.Text == "MyText" by shp.Name == "MyName" in the code above.