C1TagEditor Class

A text box-based control with ability to display and edit tags.

Inheritance

C1TagEditor

Namespace: C1.WPF.Input

Assembly: C1.WPF.Input.dll

Syntax

[StyleTypedProperty(Property = "TagStyle", StyleTargetType = typeof(C1Tag))]
[TemplatePart(Name = "Container", Type = typeof(C1WrapPanel))]
[TemplatePart(Name = "Editor", Type = typeof(C1TextBoxBase))]
[TemplatePart(Name = "TagScrollViewer", Type = typeof(ScrollViewer))]
[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualState(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Focused", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
public class C1TagEditor : C1View

<StyleTypedProperty(Property:="TagStyle", StyleTargetType:=GetType(C1Tag))>
<TemplatePart(Name:="Container", Type:=GetType(C1WrapPanel))>
<TemplatePart(Name:="Editor", Type:=GetType(C1TextBoxBase))>
<TemplatePart(Name:="TagScrollViewer", Type:=GetType(ScrollViewer))>
<TemplateVisualState(Name:="Normal", GroupName:="CommonStates")>
<TemplateVisualState(Name:="MouseOver", GroupName:="CommonStates")>
<TemplateVisualState(Name:="Focused", GroupName:="CommonStates")>
<TemplateVisualState(Name:="Disabled", GroupName:="CommonStates")>
Public Class C1TagEditor
    Inherits C1View

Constructors

Name	Description
C1TagEditor()	Initializes a new instance of the C1TagEditor class.

Fields

Name	Description
DisplayModeProperty	Identifies the DisplayMode dependency property.
FocusBrushProperty	Identifies the FocusBrush dependency property.
FocusCuesVisibilityProperty	Identifies the FocusCuesVisibility dependency property.
IsEditableProperty	Identifies the IsEditable dependency property.
IsTagEditableProperty	Identifies the IsTagEditable dependency property.
IsTextReadOnlyProperty	Identifies the IsTextReadOnly dependency property.
MaxSelectedItemsProperty	Identifies the MaxSelectedItems dependency property.
MouseOverBorderBrushProperty	Identifies the MouseOverBorderBrush dependency property.
PlaceholderProperty	Identifies the Placeholder dependency property.
SeparatorProperty	Identifies the Separator dependency property.
TagStyleProperty	Identifies the TagStyle dependency property.
TagWrappingProperty	Identifies the TagWrapping dependency property.
TagsProperty	Identifies the Tags dependency property.
TextProperty	Identifies the Text dependency property.

Properties

Name	Description
DisplayMode	Gets or sets a value indicates whether to show tag mode or text mode.
FocusBrush	Gets or sets the Brush used to highlight the focused control.
FocusCuesVisibility	Gets or sets a value indicating whether the focus visuals of the control are visible.
IsEditable	Gets or sets a value that enables or disables editing of the text in text box of the control.
IsFocused	Gets whether the control is focused.
IsTagEditable	Gets or sets a value that determines whether the tag is editable or not.
IsTextReadOnly	Gets or sets a value that determines whether the content of the input element should be enable or not.
MaxSelectedItems	Gets or sets the maximum number of items to selected on the control.
MouseOverBorderBrush	Gets or sets the Brush used to highlight the border of the control when it has the mouse over.
Placeholder	Gets or sets the placeholder text.
Separator	Gets or sets string which is used as separator in multi-select mode.
TagStyle	Gets or sets the style used for the tags.
TagWrapping	Gets or sets a value indicates whether to wrap the tags or not.
Tags	Gets the string collection of tags.
Text	Gets the text shown on the control.

Methods

Name	Description
ChangeVisualStateCommon(bool)	Updates the current visual state of the Common visual state group to match the object's properties.
ClearTags()	Clear all tags.
ContainsTag(string)	Determines whether specified text already exists in tags collection.
Dispose(bool)
GetEditorText()	Get the text of the inner editor.
InsertNewTextTag(int, string, object)	Insert new tag in a specific position.
InsertTag(int, string, object)	Insert a tag in a specific position.
InsertTag(string, object)	Insert a tag at last.
OnApplyTemplate()
OnEditing(object, TagEditorEditingEventArgs)	Occurs when tag is being edited.
OnGotFocus(RoutedEventArgs)
OnKeyDown(KeyEventArgs)
OnTagExited(object, RoutedEventArgs)	Occurs when a tag is edited.
OnTagInserted(object, RoutedEventArgs)	Occurs when a tag is inserted.
OnTagInserting(object, CancelEventArgs)	Occurs before a tag is inserted.
OnTagRemoved(object, RoutedEventArgs)	Occurs when a tag is removed.
OnTagUpdating(object, CancelEventArgs)	Occurs before a tag is edited.
OnTagsReset(object, RoutedEventArgs)	Occurs when tags are resetted.
RemoveTag(C1Tag)	Remove a specific tag.
RemoveTagAt(int)	Remove a tag in a specific position.
SetEditorText(string)	Set the text of the inner editor.
UpdateTextFromTags()	Update Text according to the tags when DisplayMode is Text.

Events

Name	Description
Editing	Occurs when tag is being edited.
TagExited	Occurs when a tag is exit edit mode.
TagInserted	Occurs when a tag is inserted.
TagInserting	Occurs before a tag is inserted.
TagRemoved	Occurs when a tag is removed.
TagUpdating	Occurs before a tag is edited.
TagsReset	Occurs when tags are resetted.