AutomationPeer.GetLabeledBy Method

Definition

Gets the AutomationPeer for the Label that is targeted to the element.

public:
 System::Windows::Automation::Peers::AutomationPeer ^ GetLabeledBy();
public System.Windows.Automation.Peers.AutomationPeer GetLabeledBy ();
member this.GetLabeledBy : unit -> System.Windows.Automation.Peers.AutomationPeer
Public Function GetLabeledBy () As AutomationPeer

Returns

The LabelAutomationPeer for the element that is targeted by the Label.

Exceptions

A public call to this method is currently in progress.

Remarks

For example, if the element is a ComboBox control, the GetLabeledBy method gets the AutomationPeer for the Label that is associated with the ComboBox.

In the following image, the Label "Themes" is targeted to the ComboBox; therefore the AccessKey for the Label also targets the ComboBox. When the user presses ALT+T, the ComboBox gets focus instead of the Label.

Display properties shows labeled by usage

The GetLabeledBy method for ComboBoxAutomationPeer returns the LabelAutomationPeer for the corresponding Label. This enables an automation client to get the text string that describes the ComboBox.

Applies to

See also