RibbonBarItemTextBox

Namespace: Wisej.Web.Ext.RibbonBar

Assembly: Wisej.Web.Ext.RibbonBar (4.1.0.0)

• Component
  • Component
    • RibbonBarItem
      • RibbonBarItemTextBox

Represents a textbox in a RibbonBarGroup.

C#

public class RibbonBarItemTextBox : RibbonBarItem

VB.NET

Public Class RibbonBarItemTextBox
    Inherits RibbonBarItem

The Text and the image are displayed as a label to the left of the edit field; the content of the field is in the Value property. The user can move between the text boxes and combo boxes in the same RibbonBarGroup using the Tab and Shift+Tab keys.

Constructors

RibbonBarItemTextBox()

Initializes a new instance of RibbonBarItemTextBox.

Properties

FieldWidth

Int32: Returns or sets the width of the TextBox field inside the RibbonBarItemTextBox. (Default: 120)

Value: The width of the edit field in pixels, not including the label. The default is 120.

Value

String: Returns or sets the value in the editable field of the RibbonBarItemTextBox. (Default: null)

Value: The text in the edit field. The default is null.

The value is updated on the server when the user commits the change in the field. Every change, including assigning the value in code, fires the ValueChanged event on the item and the ItemValueChanged event on the RibbonBar.

Example:

Searching the text typed in a ribbon text box:

private void ribbonBar1_ItemValueChanged(object sender, RibbonBarItemEventArgs e)
{
    if (e.Item == this.textBoxSearch)
        Search(this.textBoxSearch.Value);
}

Methods

OnValueChanged(e)

Fires the ValueChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

OnWebUpdate(state)

Updates the client component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

Events

ValueChanged

EventHandler Fired when the Value property has changed.

Implements

Name	Description
IUserData
IWisejComponent
IWisejSerializable