Table of Contents

XlsFile.SetRadioButtonState Method

Sets the value of a radio button in the active sheet. Note that this only works for radio buttons added through the Forms toolbar. It won't return the values of ActiveX radio buttons

Remarks

If the radio button is linked to a cell, this method will change both the radio button and the cell.

Syntax

Namespace: FlexCel.XlsAdapter

public override void SetRadioButtonState(Int32 objectIndex, String objectPath, Boolean selected)

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"
selected Boolean If true, the option button will be set, and all other buttons in the range will be deselected.
When false the radio button will be deselected.

Examples

To set a radio button given its text, use the code:

    XlsFile xls = new XlsFile("radiobuttons.xls");
    for (int i = 1; i <= xls.ObjectCount; i++)
    {
        TShapeProperties shp = xls.GetObjectProperties(i, false);
        if (shp.ObjectType == TObjectType.OptionButton && shp.Text == "MyText")
        {
            xls.SetRadioButtonState(i, null, true);
        }
    }

To change a radio button given its name instead of its text, replace shp.Text == "MyText" by shp.Name == "MyName" in the code above.

See also