TextBox
Description:
The TextBox object represents text-based control that allows the user to enter text.
The TextBox object represents text-based control that allows the user to enter text.
Remarks:
The ItemText property inherited from RibbonItem has no effect. The text entered in the TextBox is edited by the UI user is accepted only if the user presses the Enter key or click the image button when ShowImageAsButton is true. If the user clicks off of this component without pressing Enter or click the image button; then the text will be reverted to the previous value. Use of this class is not supported in Revit Macros.
The ItemText property inherited from RibbonItem has no effect. The text entered in the TextBox is edited by the UI user is accepted only if the user presses the Enter key or click the image button when ShowImageAsButton is true. If the user clicks off of this component without pressing Enter or click the image button; then the text will be reverted to the previous value. Use of this class is not supported in Revit Macros.
public class TextBox : RibbonItem| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| EnterPressed | event | Subscribe to this event to be notified when the Enter button is pressed in the text box. |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| Equals(Object) | bool | Determines whether the specified is equal to the current . | RibbonItem |
| GetContextualHelp() | nullNothingnullptr | Gets the contextual help bound with this control. | RibbonItem |
| SetContextualHelp(ContextualHelp) | None | Sets the contextual help bound with this button. | RibbonItem |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| Image | ImageSource | The image of the TextBox. | |
| PromptText | string | The prompt text for the text box. | |
| SelectTextOnFocus | bool | A value that indicates if the text is selected when the text box gains focus. | |
| ShowImageAsButton | bool | Gets or sets a value that indicates if the Image set in the text box should be displayed as a clickable button. | |
| Value | Object | The object that supplies the text value. | |
| Width | double | Gets or sets the width of the TextBox. | |
| Enabled | bool | Gets or sets a value indicating whether the item is enabled. | RibbonItem |
| ItemText | string | Gets or sets the text displayed on the item. | RibbonItem |
| ItemType | RibbonItemType | Gets the item type. | RibbonItem |
| LongDescription | string | Long description of the command tooltip | RibbonItem |
| Name | string | The name of the item. | RibbonItem |
| ToolTipImage | ImageSource | The image to show as a part of the button extended tooltip | RibbonItem |
| ToolTip | string | The description that appears as a ToolTip for the item. | RibbonItem |
| Visible | bool | Gets or sets a value indicating whether the item is visible. | RibbonItem |