v3.5

TagTextBox

Wisej.Web.TagTextBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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.

public class TagTextBox : TextBoxBase

Constructors

Initializes an instance of a TagTextBox control.

Properties

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.

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

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

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)

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)

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. (Default: 10)

String: Returns the text of the selected tag.

Int32: Returns the length of the selected tag.

Int32: Returns the position of the selected tag.

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

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)

Int32: Returns the number of tags in the control.

Methods

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

Events

EventHandler Fired when the value of SeparatorChar changes.

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

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

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

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.

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

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;
  }
}

TagTextBoxEventHandler Fires when the user selects a tag.

Implements

Last updated