Class

RadTextBoxElement

Initializes a new instance of the RadTextBoxElement class.

Declaration

public RadTextBoxElement()

Initializes a new instance of the RadTextBoxElement class.

Declaration

public RadTextBoxElement(RadTextBoxItem textBoxItem)

Parameters

Identifies the NullTextColor dependency property that controls the color of prompt text displayed when the TextBox contains no text.

Declaration

public static RadProperty NullTextColorProperty

Field Value

Gets the BorderPrimitive instance used for rendering the border around the text box.

Declaration

public BorderPrimitive Border { get; }

Property Value

Gets the StackLayoutPanel instance that contains and arranges the clear button and other action buttons.

Declaration

public StackLayoutPanel ButtonsStack { get; }

Property Value

Gets the clear button element that allows users to quickly clear the text box content.

Declaration

public LightVisualButtonElement ClearButton { get; }

Property Value

Gets the embedded label element that provides floating label functionality with animation support.

Declaration

public LightVisualElement EmbeddedLabel { get; }

Property Value

Gets or sets the animation speed for the embedded label transitions. The speed is an integer between 1 (animation disabled) and 10 (slowest animation) with a default value of 8.

Declaration

public int EmbeddedLabelAnimationSpeed { get; set; }

Property Value

Gets or sets the offset distance in pixels of the embedded label from the bottom border when the label is in the down position.

Declaration

public float EmbeddedLabelBorderOffset { get; set; }

Property Value

Gets or sets the text content displayed in the embedded label.

Declaration

public string EmbeddedLabelText { get; set; }

Property Value

Gets the FillPrimitive instance used for rendering the background of the text box.

Declaration

public FillPrimitive Fill { get; }

Property Value

Gets or sets the color of the prompt text that is displayed when the TextBox contains no text.

Declaration

public Color NullTextColor { get; set; }

Property Value

Gets or sets the character used to mask characters in a password text box control for security purposes.

Declaration

public char PasswordChar { get; set; }

Property Value

Gets or sets a value indicating whether the embedded label should automatically reposition itself when the text box is empty.

Declaration

public bool RepositionEmbeddedLabel { get; set; }

Property Value

Gets or sets a value indicating whether the border around the text box is visible or not.

Declaration

public bool ShowBorder { get; set; }

Property Value

Gets or sets a value indicating whether the clear button is displayed to allow users to quickly clear the text box content.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Gets or sets a value indicating whether the embedded label is visible and provides floating label functionality.

Declaration

public bool ShowEmbeddedLabel { get; set; }

Property Value

Gets or sets the horizontal text alignment of the TextBoxItem.

Declaration

public HorizontalAlignment TextAlign { get; set; }

Property Value

Gets the underlying RadTextBoxItem instance that handles the core text input functionality.

Declaration

public RadTextBoxItem TextBoxItem { get; }

Property Value

Gets or sets a value indicating whether to use generic border painting to prevent clipping of characters due to font name or size particularities.

Declaration

public bool UseGenericBorderPaint { get; set; }

Property Value

Arranges the child elements within the final size allocated to this element.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides RadElement.ArrangeOverride(SizeF)

Raises the TextChanged event.

Declaration

protected virtual void CallTextChanged(EventArgs e)

Parameters

Raises the TextChanging event.

Declaration

protected virtual void CallTextChanging(TextChangingEventArgs e)

Parameters

Creates the child elements including fill primitive, border primitive, buttons stack, clear button, and embedded label.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates and configures the clear button element with default padding settings.

Declaration

protected virtual LightVisualButtonElement CreateClearButton()

Returns

Creates and configures the embedded label element with default properties for positioning and appearance.

Declaration

protected virtual LightVisualElement CreateEmbeddedLabel()

Returns

Releases managed resources used by the RadTextBoxElement and unsubscribes from event handlers.

Declaration

protected override void DisposeManagedResources()

Overrides RadItem.DisposeManagedResources()

Sets input focus to the text box element.

Declaration

public override bool Focus()

Returns

Overrides RadElement.Focus()

Initializes the default field values and properties for the text box element including stretch behavior and embedded label border offset.

Declaration

protected override void InitializeFields()

Overrides RadItem.InitializeFields()

Measures the desired size of the element and its children based on the available space.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides RadElement.MeasureOverride(SizeF)

Raises the AcceptsTabChanged event.

Declaration

protected virtual void OnAcceptsTabChanged(EventArgs e)

Parameters

Handles bubbled events from child elements including mouse events and multiline property changes.

Declaration

protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)

Parameters

Overrides RadElement.OnBubbleEvent(RadElement, RoutedEventArgs)

Called when the clear button is clicked and clears the text content by setting it to an empty string.

Declaration

protected virtual void OnClearButtonClick()

Raises the HideSelectionChanged event.

Declaration

protected virtual void OnHideSelectionChanged(EventArgs e)

Parameters

Called when the element is loaded and initializes clear button visibility and focus event handling.

Declaration

protected override void OnLoaded()

Overrides RadElement.OnLoaded()

Raises the ModifiedChanged event.

Declaration

protected virtual void OnModifiedChanged(EventArgs e)

Parameters

Handles mouse down events by animating the embedded label up and setting focus to the text box control.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Raises the MultilineChanged event with the specified event arguments.

Declaration

protected virtual void OnMultilineChanged(EventArgs e)

Parameters

Raises the ReadOnlyChanged event with the specified event arguments.

Declaration

protected virtual void OnReadOnlyChanged(EventArgs e)

Parameters

Called when the element is selected and sets focus to the text box.

Declaration

protected override void OnSelect()

Overrides RadItem.OnSelect()

Raises the TextAlignChanged event.

Declaration

protected virtual void OnTextAlignChanged(EventArgs e)

Parameters

Occurs when the value of the AcceptsTab property has changed.

Declaration

[Browsable(true)]
public event EventHandler AcceptsTabChanged

Event Value

Occurs when the value of the HideSelection property has changed.

Declaration

[Browsable(true)]
public event EventHandler HideSelectionChanged

Event Value

Occurs when the value of the Modified property has changed.

Declaration

[Browsable(true)]
public event EventHandler ModifiedChanged

Event Value

Occurs when the value of the Multiline property has changed.

Declaration

[Browsable(true)]
public event EventHandler MultilineChanged

Event Value

Occurs when the ReadOnly property value has changed.

Declaration

[Browsable(true)]
public event EventHandler ReadOnlyChanged

Event Value

Occurs when the value of the TextAlign property has changed.

Declaration

[Browsable(true)]
public event EventHandler TextAlignChanged

Event Value

Occurs after the text content has been changed.

Declaration

[Browsable(true)]
public event EventHandler TextChanged

Event Value

Occurs before the text content is changed, allowing validation or modification of the new text value.

Declaration

[Browsable(true)]
public event TextChangingEventHandler TextChanging

Event Value