TagTextBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • TextBoxBase
    • TagTextBox

Represents a data field that displays a list of selectable and removable tags. The control recognizes tags as the user types and adds in front of the editable field.

C#

public class TagTextBox : TextBoxBase

VB.NET

Public Class TagTextBox
    Inherits TextBoxBase

Constructors

TagTextBox()

Initializes an instance of a TagTextBox control.

Properties

AllowDuplicateTags

Boolean: Returns or sets whether duplicate tags are allowed. Since 3.0.10 (Default: False)

When a duplicate tag is rejected, the control fires the TagRejected event.

Editable

Boolean: Returns or sets whether the user can add tags by typing into the editable field. (Default: True)

KeepWatermark

Boolean: Returns or sets whether the watermark should disappear when there is at least one tag. (Default: False)

MaxTagCount

Int32: Returns or sets the maximum number of tags allowed in the control. When this limit is reached, the control will fire the TagRejected event and will not add the tag. The default is 0 = unlimited. (Default: 0)

MaxTagWidth

Int32: Returns or sets the maximum width in pixels of the tag widgets displayed on the client. When the content exceeds this limit, it will show an ellipses. (Default: 100)

MinFieldLength

Int32: Returns or sets the minimum number of characters that should fit in the editable portion of the control before it wraps to a new line or displays the scroller for the tags portion. (Default: 10)

SelectedText

String: Returns the text of the selected tag.

SelectionLength

Int32: Returns the length of the selected tag.

SelectionStart

Int32: Returns the position of the selected tag.

SeparatorChar

Char: Returns or sets the character used to separate the tags. (Default: ,)

ShowToolTips

Boolean: Returns or sets whether to show a tooltip with the full content of the tag text when the mouse hovers over the tag element. (Default: False)

TagCount

Int32: Returns the number of tags in the control.

Methods

OnAutoSizeChanged(e)

Parameter	Type	Description
e	EventArgs

OnSeparatorCharChanged(e)

Fires the SeparatorCharChanged event.

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

OnTagAdded(e)

Fires the TagAdded event.

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

OnTagClick(e)

Fires the TagClick event.

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

OnTagDoubleClick(e)

Fires the TagDoubleClick event.

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

OnTagRejected(e)

Fires the TagRejected event.

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

OnTagRemoved(e)

Fires the TagRemoved event.

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

OnTagRender(e)

Fires the TagRender event.

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

OnTagSelected(e)

Fires the TagSelected event.

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

OnWebEvent(e)

Parameter	Type	Description
e	WisejEventArgs

OnWebRender(config)

Parameter	Type	Description
config	Object

SelectTag(tag)

Selects the specified tag, if it exists. If the tag is selected successfully, it will fire the TagSelected event.

Parameter	Type	Description
tag	String	Text of the tag to select.

Events

SeparatorCharChanged

EventHandler Fired when the value of SeparatorChar changes.

TagAdded

TagTextBoxEventHandler Fired when the user adds new tag is added to the control.

TagClick

TagTextBoxMousEventHandler Fired when the user clicks (or taps) on a tag outside of the close icon.

TagDoubleClick

TagTextBoxMousEventHandler Fired when the user double clicks (or double taps) on a tag outside of the close icon.

TagRejected

TagTextBoxEventHandler Fired when the user tries to add a tag that already exists or the maximum number of allowed tags set in MaxTagCount is reached.

TagRemoved

TagTextBoxEventHandler Fired when the user removes a tag from the control.

TagRender

TagTextBoxRenderEventHandler Fired when the control needs to render the tags in the Text property.

Use this event to change the visual aspect of each tag on the client.

private void tagTextBox1_TagRender(object sender, TagTextBoxRenderEventArgs e)
{
  switch (e.Text)
  {
    case "Arizona":
      e.BackColor = Color.Beige;
      break;

    case "Florida":
      e.BackColor = Color.LightGreen;
      break;

    case "Alaska":
      e.Html = "<b>" + e.Text + "</b>";
      break;

    case "California":
      e.Html = "<u>" + e.Text + "</u>";
      break;

    case "Georgia":
      e.Html = "<img src='Images/fullstar.png' style='display:inline-block;float:left;padding-right:5px' width='16'/>" + e.Text;
      break;
  }
}

TagSelected

TagTextBoxEventHandler Fires when the user selects a tag.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
ILabel	Provides access to the LabelWrapper associated with the controls that implement this interface.
IReadOnly	Provides access to the ReadOnly property for coontrols that support the read-only mode.
IModified	Provides access to the Modified property and ModifiedChanged event for controls that implement this interface.
IValidation	Provides access to the validation events and properties property for controls that support validation.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.