Sign in Join
FPDoc Onlineexperiment

TDBRadioGroup.GetButtonValue function

Member of TDBRadioGroupprotectedIn unit DBCtrls

Gets the value for the radio button at the specified position in the control.

Declaration

pascal
function GetButtonValue(Index: Integer): string

Arguments

Index

Ordinal position in Items for the requested radio button.

Function result

The value stored for the specified radio button.

Description

GetButtonValue is a String function used to get the value for the Radio Button at the ordinal position specified in Index.

When Index is a negative non-zero value, the return value is an empty string (''). Otherwise, the return value contains the content at the specified index position in Values. If no corresponding entry is available in Values, the content from Items at the specified position is used.

Use the Items property to define the Radio Buttons displayed in the control. Use Values to define the content stored in DataField when the radio button in ItemIndex is selected.

GetButtonValue is used in the implementation of the UpdateRadioButtonStates method.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.