BuddyValue Property

Gets or sets the value that is to be passed to the buddy control.

object.BuddyValue as String

Use

When the following controls are generated by the recognition engine, the BuddyValue property is automatically populated in the following way for each control:

• Check box control - This property is set to the current Value of the checkbox. If the Choices property for the check box is blank, then a value of 0 represents an Unchecked state, 1 represents the Checked state, and 2 is Grayed. If the Choices property has been set then the BuddyValue is populated with the current checked or unchecked choice.
• Option button control - This property is populated with the underlying FieldChoiceValue for this host screen element. This may be different to the Text displayed next to the option button which will be the underlying FieldChoiceDescription if both are present.
• Menu button control - This property is set to the menu number associated with this menu item.
• UpDown control - there is no BuddyValue for this object. instead, the BuddyProperty of the buddy control is set to the current Value of the UpDown control.

How the Buddy Properties work together

The BuddyControl property specifies another control on the form that will update when this control is clicked. When this property is set, clicking on the active control will modify the contents of it's buddy control also. Some host-generated controls, such as menu buttons and option buttons have automatically populated buddy properties . These controls have one thing in common, they are usually part of a group of individual controls that are associated with a single entry field. The buddy processing determines what value to send to the entry field and which field to send it to.

A buddy control can be specified using either the control name, or the row and column position of the corresponding host field using the following syntax:

row,column

The BuddyProperty is the specific property of the buddy control that will be populated with the value of the active control when clicked.

TIP!

If you specify the BuddyControl property you will need to also set the BuddyProperty property. Where the BuddyControl is a textbox, the BuddyProperty is typically set to Text. If the BuddyControl is a label, then the BuddyProperty is usually set to Caption.

If the BuddyValue property is left blank then the value sent to the buddy control will be the current value of the active control. If a BuddyValue is specified then the specified value will be sent to the buddy control when the active control is clicked.

For CheckBox controls the BuddyValue property can be specified as two values. The first value is used when the check box is checked and the second value is set when it is cleared. The two values are specified using a semi-colon to separate them like the following example:

checkedValue;uncheckedValue

If a BuddyKey is specified, then, after the active control is clicked, the focus will be moved to the buddy control and the specified AID key will be sent to the host when the buddy control is modified.

WATCH OUT FOR..

Buddy processing is tied to the click event of the active control, therefore setting a buddy control does NOT mean that the two controls are synchronized. The buddy control is only updated when the user clicks on the active control. Any changes to the value of the active control via other means, for instance a script or macro, will not modify the buddy control.

See Also

BuddyKey property | BuddyProperty property | BuddyControl property | Properties

Applies To

CommandButton control

Check box control

Label control

Menu button control

Option button control

PictureBox control

---

© 2004-2021 looksoftware. All rights reserved.