TagTextBox
Wisej.Web.TagTextBox
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.2.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.
Constructors
TagTextBox()
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Initializes an instance of a TagTextBox control.
Properties
AllowDuplicateTags
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Boolean: Returns or sets whether the user can add tags by typing into the editable field. (Default: True
)
KeepWatermark
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Boolean: Returns or sets whether the watermark should disappear when there is at least one tag. (Default: False
)
MaxTagCount
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
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
)
SelectedText
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
String: Returns the text of the selected tag.
SelectionLength
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Int32: Returns the length of the selected tag.
SelectionStart
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Int32: Returns the position of the selected tag.
SeparatorChar
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Char: Returns or sets the character used to separate the tags. (Default: ,
)
ShowToolTips
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Int32: Returns the number of tags in the control.
Methods
SelectTag(tag)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
Selects the specified tag, if it exists. If the tag is selected successfully, it will fire the TagSelected event.
Parameter | Type | Description |
---|---|---|
tag | Text of the tag to select. |
Events
SeparatorCharChanged
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
EventHandler Fired when the value of SeparatorChar changes.
TagAdded
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
TagTextBoxEventHandler Fired when the user adds new tag is added to the control.
TagClick
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
TagTextBoxMousEventHandler Fired when the user clicks (or taps) on a tag outside of the close icon.
TagDoubleClick
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
TagTextBoxMousEventHandler Fired when the user double clicks (or double taps) on a tag outside of the close icon.
TagRejected
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
TagTextBoxEventHandler Fired when the user removes a tag from the control.
TagRender
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
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.
TagSelected
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F3811934619-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FaN9qL9rX9v301dsI6CfD%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3Dbc63f9cf-3241-48ac-8cb4-46d1df1d13df&width=300&dpr=4&quality=100&sign=3f055c39&sv=1)
TagTextBoxEventHandler Fires when the user selects a tag.
Implements
Name | Description |
---|---|
Bindable components implement this interface. | |
Controls that support drag & drop operations implement this interface. | |
Provides access to the LabelWrapper associated with the controls that implement this interface. | |
Provides access to the ReadOnly property for coontrols that support the read-only mode. | |
Provides access to the Modified property and ModifiedChanged event for controls that implement this interface. | |
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 Control class must implement this interface. | |
Allows an object to serialize itself. |
Last updated