An edit field control.
Parent Elements
This element can appear as a child of the following elements.
| Element | Description | Version Introduced | Pro Version Introduced |
|---|---|---|---|
| <Group> | A single group that appears within a single tab and contains controls. | 1.0 | 3.2 |
| <QuickAccessControls> | A list of controls that appear in the quick access toolbar. | 1.0 | 3.2 |
| <SplitButton> | A button control with a drop down that can contain other controls. | 1.0 | 3.2 |
| <TabBarControls> | The list of controls that appear on the right end of the tab bar area. | 1.0 | 3.2 |
Attributes
This element supports the following attributes:
| Attribute | Description | Version Introduced | Pro Version Introduced |
|---|---|---|---|
| BeginGroup | Determines if this control begins a new group. | 1.0 | 3.2 |
| Hint | Grayed text that appears in the edit field when it is empty. | 1.0 | 3.2 |
| Key | The unique identifier of this control. Must be unique among all other controls. (Required) | 1.0 | 3.2 |
| Height | The height of the control. | 1.0 | 3.2 |
| Text | The edit field's default text. | 1.0 | 3.2 |
| Width | The width of the control | 1.0 | 3.2 |
BeginGroup
The BeginGroup attribute can be set to "True" or "False". When set to "True", it informs the ribbon that this control should not be grouped with the control before it and should be the first control in a new group. This attribute only works if the control is in a group whose GroupControls attribute is "True".
Key
The Key attribute defines the unique identifier you will use in properties, methods, or events to identify this control. This needs to be unique among all other controls, regardless of control type.
Hint
The Hint attribute contains text you want to appear, albeit grayed out slightly, when the control is empty. Think of it as a label within the control.
Height
The Height attribute sets a new fixed height for the control.
Text
The Text attribute contains the default text you want to appear.
Width
The Width attribute sets a new fixed width for the control.
Remarks
The EditField element defines an edit field control that will appear on the ribbon. It is blank by default, in which case you can display a hint, such as "Search..." as a kind of pseudo label. To set the text or hint programmatically, use the EditFieldText or EditFieldHint properties respectively. The only event available to you for this control is the OnEditFieldLostFocus event. Use it to react to changes in the edit line.
Example
<EditField Key="EDL_TEST" Hint="Search..." Width="80" />
