2027 Class
Changes 0
C

TextBox

Description:
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.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.UI.RibbonItem
    Autodesk.Revit.UI.TextBox
public class TextBox : RibbonItem
Name Return Type Description Inherited From
E 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
M Equals(Object) Boolean Determines whether the specified Object is equal to the current Object . (Inherited from RibbonItem ) RibbonItem
M GetContextualHelp() ContextualHelp Gets the contextual help bound with this control. (Inherited from RibbonItem ) RibbonItem
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M SetContextualHelp(ContextualHelp) None Sets the contextual help bound with this button. (Inherited from RibbonItem ) RibbonItem
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P Enabled bool Gets or sets a value indicating whether the item is enabled. (Inherited from RibbonItem ) RibbonItem
P Image ImageSource The image of the TextBox.
P ItemText string Gets or sets the text displayed on the item. (Inherited from RibbonItem ) RibbonItem
P ItemType RibbonItemType Gets the item type. (Inherited from RibbonItem ) RibbonItem
P LongDescription string Long description of the command tooltip (Inherited from RibbonItem ) RibbonItem
P Name string The name of the item. (Inherited from RibbonItem ) RibbonItem
P PromptText string The prompt text for the text box.
P SelectTextOnFocus bool A value that indicates if the text is selected when the text box gains focus.
P ShowImageAsButton bool Gets or sets a value that indicates if the Image set in the text box should be displayed as a clickable button.
P ToolTip string The description that appears as a ToolTip for the item. (Inherited from RibbonItem ) RibbonItem
P ToolTipImage ImageSource The image to show as a part of the button extended tooltip (Inherited from RibbonItem ) RibbonItem
P Value Object The object that supplies the text value.
P Visible bool Gets or sets a value indicating whether the item is visible. (Inherited from RibbonItem ) RibbonItem
P Width double Gets or sets the width of the TextBox.