[]
        
(Showing Draft Content)

C1.Win.Ribbon.RibbonTextBox

RibbonTextBox Class

Represents a text box element in a C1Ribbon control.

Implements
ISupportUiaContainer
Namespace: C1.Win.Ribbon
Assembly: C1.Win.Ribbon.4.8.dll
Syntax
public class RibbonTextBox : RibbonIconItem, IComponent, IDisposable, ISupportUiaContainer

Constructors

Name Description
RibbonTextBox()

Creates a new instance of RibbonTextBox.

Properties

Name Description
ContextMenuStrip

Gets or sets the context menu strip associated with the text box.

CueBanner

Gets or sets the textual cue, or tip, that is displayed by RibbonTextBox to prompt the user for information.

GapBeforeTextArea

Gets or sets the gap between the label and text area when this RibbonTextBox appears on a RibbonGroup.

KeyTip

Gets or sets the KeyTip providing keyboard access to a RibbonTextBox.

Label

Gets or sets the label used to identify this RibbonTextBox.

LabelWidth

Gets or sets the width of the text label. Set to -1 to let the label calculate width automatically.

MaxLength

Gets or sets the maximum length of the string in the Text property in this RibbonTextBox.

PasswordChar

Gets or sets the character used to mask characters of a password in the RibbonTextBox.

ReadOnly

Gets or sets a value indicating whether the contents of the component can be changed.

Text

Gets or sets the text in this RibbonTextBox.

TextAlign

Gets or sets how text is aligned in the RibbonTextBox.

TextAreaWidth

Gets or sets the width of the text area.

TextBox

Gets the TextBox control contained in this RibbonTextBox.

UseSystemPasswordChar

Gets or sets a value indicating whether the text in the RibbonTextBox should appear as the default password character.

Methods

Name Description
OnChangeCanceled(EventArgs)

Raises the ChangeCanceled event.

OnChangeCommitted(EventArgs)

Raises the ChangeCommitted event.

OnGotFocus(EventArgs)

Raises the GotFocus event.

OnKeyDown(KeyEventArgs)

Raises the KeyDown event.

OnKeyPress(KeyPressEventArgs)

Raises the KeyPress event.

OnKeyUp(KeyEventArgs)

Raises the KeyUp event.

OnLostFocus(EventArgs)

Raises the LostFocus event.

OnTextChanged(EventArgs)

Raises the TextChanged event.

Events

Name Description
ChangeCanceled

Occurs when the user cancels changes to the text box.

ChangeCommitted

Occurs when the user commits changes to the text box.

GotFocus

Occurs when the text box receives focus.

KeyDown

Occurs when a key is first pressed.

KeyPress

Occurs when the user presses and releases a key.

KeyUp

Occurs when a key is released.

LostFocus

Occurs when the text box loses focus.

TextChanged

Event raised when the text is changed.