All pages
Powered by GitBook
1 of 7

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

TagTextBox

Wisej.Web.TagTextBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

  • Control

    • TextBoxBase

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.

Constructors

TagTextBox()

Initializes an instance of a control.

Properties

AllowDuplicateTags

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

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

Editable

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

KeepWatermark

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

MaxTagCount

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

MaxTagWidth

: 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

: 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

: Returns the text of the selected tag.

SelectionLength

: Returns the length of the selected tag.

SelectionStart

: Returns the position of the selected tag.

SeparatorChar

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

ShowToolTips

: 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

: Returns the number of tags in the control.

Methods

OnAutoSizeChanged(e)

Parameter
Type
Description

OnSeparatorCharChanged(e)

Fires the event.

Parameter
Type
Description

OnTagAdded(e)

Fires the event.

Parameter
Type
Description

OnTagClick(e)

Fires the event.

Parameter
Type
Description

OnTagDoubleClick(e)

Fires the event.

Parameter
Type
Description

OnTagRejected(e)

Fires the event.

Parameter
Type
Description

OnTagRemoved(e)

Fires the event.

Parameter
Type
Description

OnTagRender(e)

Fires the event.

Parameter
Type
Description

OnTagSelected(e)

Fires the event.

Parameter
Type
Description

OnWebEvent(e)

Parameter
Type
Description

OnWebRender(config)

Parameter
Type
Description

SelectTag(tag)

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

Parameter
Type
Description

Events

SeparatorCharChanged

Fired when the value of changes.

TagAdded

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

TagClick

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

TagDoubleClick

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

TagRejected

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

TagRemoved

Fired when the user removes a tag from the control.

TagRender

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

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

TagSelected

Fires when the user selects a tag.

Implements

Name
Description

Provides access to the validation events and properties property for controls that support validation.

All wisej components implement this interface.

All wisej controls derived from the class must implement this interface.

Allows an object to serialize itself.

e

EventArgs

e

EventArgs

A EventArgs that contains the event data.

e

TagTextBoxEventArgs

A TagTextBoxEventArgs that contains the event data.

e

TagTextBoxMousEventArgs

A TagTextBoxMousEventArgs that contains the event data.

e

TagTextBoxMousEventArgs

A TagTextBoxMousEventArgs that contains the event data.

e

TagTextBoxEventArgs

A TagTextBoxEventArgs that contains the event data.

e

TagTextBoxEventArgs

A TagTextBoxEventArgs that contains the event data.

e

TagTextBoxRenderEventArgs

A TagTextBoxRenderEventArgs that contains the event data.

e

TagTextBoxEventArgs

A TagTextBoxEventArgs that contains the event data.

e

WisejEventArgs

config

Object

tag

String

Text of the tag to select.

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.

TagTextBox
Public Class TagTextBox
    Inherits TextBoxBase
TagTextBox
Boolean
TagRejected
Boolean
Boolean
Int32
TagRejected
Int32
Int32
String
Int32
Int32
Char
Boolean
Int32
SeparatorCharChanged
TagAdded
TagClick
TagDoubleClick
TagRejected
TagRemoved
TagRender
TagSelected
TagSelected
EventHandler
SeparatorChar
TagTextBoxEventHandler
TagTextBoxMousEventHandler
TagTextBoxMousEventHandler
TagTextBoxEventHandler
MaxTagCount
TagTextBoxEventHandler
TagTextBoxRenderEventHandler
Text
TagTextBoxEventHandler
public class TagTextBox : TextBoxBase

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;
  }
}
IValidation
IWisejComponent
IWisejControl
Control
IWisejSerializable

TagTextBoxEventArgs

Wisej.Web.TagTextBoxEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the TagAdded or TagRejected or TagRejected or TagSelected events of a TagTextBox control

public class TagTextBoxEventArgs : EventArgs
Public Class TagTextBoxEventArgs
    Inherits EventArgs

Constructors

TagTextBoxEventArgs(text, index)

Initializes a new instance of the class.

Name
Type
Description

Properties

Index

: Returns the index of the tag being added, removed, rejected, or selected.

Text

: Text of the tag that is being added, removed, rejected, or selected.

Used By

Name
Description

text

String

Text of the tag that is being notified with the event.

index

Int32

Index of the tag that is being notified with the event.

TagTextBoxEventHandler

Represents the method that will handle the TagAdded or TagRejected or TagRejected or TagSelected events of a TagTextBox control.

TagTextBoxEventArgs
Int32
String

TagTextBoxRenderEventHandler

Wisej.Web.TagTextBoxRenderEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the event of a control.

TagTextBoxEventHandler

Wisej.Web.TagTextBoxEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the or or or events of a control.

TagTextBoxMousEventHandler

Wisej.Web.TagTextBoxMousEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the or events of a control.

Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

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

TagRender
TagTextBox
Public Delegate Sub TagTextBoxRenderEventHandler(ByVal sender As [Object], ByVal e As TagTextBoxRenderEventArgs)
public delegate void TagTextBoxRenderEventHandler(Object sender, TagTextBoxRenderEventArgs e)
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

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

Fired when the user removes a tag from the control.

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

Fires when the user selects a tag.

TagAdded
TagRejected
TagRejected
TagSelected
TagTextBox
Public Delegate Sub TagTextBoxEventHandler(ByVal sender As [Object], ByVal e As TagTextBoxEventArgs)
public delegate void TagTextBoxEventHandler(Object sender, TagTextBoxEventArgs e)
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

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

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

TagClick
TagDoubleClick
TagTextBox
Public Delegate Sub TagTextBoxMousEventHandler(ByVal sender As [Object], ByVal e As TagTextBoxMousEventArgs)
public delegate void TagTextBoxMousEventHandler(Object sender, TagTextBoxMousEventArgs e)

TagTextBoxRenderEventArgs

Wisej.Web.TagTextBoxRenderEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the

TagTextBoxMousEventArgs

Wisej.Web.TagTextBoxMousEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the

Object
TagTextBoxRenderEventArgs
TagTextBoxRenderEventArgs
TagTextBox.TagRender
Text
Object
TagTextBoxEventArgs
TagTextBoxEventArgs
TagTextBox.TagAdded
TagTextBox.TagRemoved
TagTextBox.TagRejected
MaxTagCount
TagTextBox.TagSelected
Object
TagTextBoxMousEventArgs
TagTextBoxMousEventArgs
TagTextBox.TagClick
TagTextBox.TagDoubleClick
event of a
control.
public class TagTextBoxRenderEventArgs : TagTextBoxEventArgs
Public Class TagTextBoxRenderEventArgs
    Inherits TagTextBoxEventArgs

Constructors

TagTextBoxRenderEventArgs(text, index)

Initializes a new instance of the TagTextBoxRenderEventArgs class.

Name
Type
Description

text

Text of the tag that is being rendered.

index

Index of the tag that is being rendered.

Properties

BackColor

Color: Allows the application to change the background color of the tag displayed on the client.

ForeColor

Color: Allows the application to change the color of the text in the tag displayed on the client.

Html

String: Allows the application set the HTML to display in the tag instead of displaying the text.

Used By

Name
Description

Represents the method that will handle the event of a control.

TagTextBoxEventArgs
TagTextBoxRenderEventArgs
TagRender
TagTextBox
or
events of a
control
public class TagTextBoxMousEventArgs : MouseEventArgs
Public Class TagTextBoxMousEventArgs
    Inherits MouseEventArgs

Constructors

TagTextBoxMousEventArgs(text, index, button, clicks)

Initializes a new instance of the TagTextBoxMousEventArgs class.

Name
Type
Description

text

Text of the tag that is being notified with the event.

index

Index of the tag that is being notified with the event.

button

One of the values that indicate which mouse button was pressed.

clicks

Properties

Index

Int32: Returns the index of the tag being clicked or double clicked.

Text

String: Text of the tag that is being clicked or double clicked.

Used By

Name
Description

Represents the method that will handle the or events of a control.

MouseEventArgs
TagTextBoxMousEventArgs
TagClick
TagDoubleClick
TagTextBox
String
Int32
TagTextBoxRenderEventHandler
TagRender
TagTextBox

The number of times a mouse button was pressed.

String
Int32
MouseButtons
MouseButtons
Int32
TagTextBoxMousEventHandler
TagClick
TagDoubleClick
TagTextBox