TokenEdit Members
The text editor that applies custom validation to the entered text and transforms text blocks which passed this validation to tokens.Constructors
| Name | Description |
|---|---|
| TokenEdit() | Initializes a new instance of the TokenEdit class with the default settings. |
Properties
| Name | Description |
|---|---|
| AccessibilityObject | Gets the AccessibleObject assigned to the control. Inherited from Control. |
| AccessibleDefaultActionDescription | Gets or sets the default action description of the editor for use by accessibility client applications. Inherited from BaseEdit. |
| AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. Inherited from BaseEdit. |
| AccessibleName | Gets or sets the object’s name used by accessibility client applications. Inherited from BaseEdit. |
| AccessibleRole | Gets or sets the object’s accessible role. Inherited from BaseEdit. |
| AllowDrop | Gets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control. |
| AllowHtmlTextInToolTip | Gets or sets whether HTML formatting is allowed in the control’s regular tooltips. Inherited from BaseControl. |
| Anchor | Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control. |
| AutoScrollOffset | Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control. |
| AutoSize | This property is not relevant for this class. Inherited from Control. |
| AutoSizeInLayoutControl | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| BackColor | Gets or sets the background color of an enabled editor. Inherited from BaseEdit. |
| BackgroundImage | Gets or sets the background image displayed in the control. Inherited from Control. |
| BackgroundImageLayout | Gets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control. |
| BindingContext | Gets or sets the BindingContext for the control. Inherited from Control. |
| BindingManager | Gets the BindingManagerBase object. Inherited from BaseEdit. |
| BorderStyle | Gets or sets the editor’s border style. Inherited from BaseEdit. |
| Bottom | Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control. |
| Bounds | Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control. |
| CanEnableIme protected | Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control. |
| CanFocus | Gets a value indicating whether the control can receive focus. Inherited from Control. |
| CanRaiseEvents protected | Determines if events can be raised on the control. Inherited from Control. |
| CanSelect | Gets a value indicating whether the control can be selected. Inherited from Control. |
| CanShowDialog | For internal use. Inherited from BaseEdit. |
| Capture | Gets or sets a value indicating whether the control has captured the mouse. Inherited from Control. |
| CausesValidation | Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control. |
| CheckedItem | Gets the currently checked token within this TokenEdit. |
| CheckedItems | Returns the object that contains all currently checked tokens within this TokenEdit. |
| CheckForIllegalCrossThreadCalls static | Gets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control. |
| Client | Returns this TokenEdit. |
| ClientRectangle | Gets the rectangle that represents the client area of the control. Inherited from Control. |
| ClientSize | Gets or sets the height and width of the client area of the control. Inherited from Control. |
| CompanyName | Gets the name of the company or creator of the application containing the control. Inherited from Control. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| ContainsFocus | Gets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control. |
| ContextMenu | Gets or sets the context menu for the editor. Inherited from BaseEdit. |
| Controls | Gets the collection of controls contained within the control. Inherited from Control. |
| Created | Gets a value indicating whether the control has been created. Inherited from Control. |
| Cursor | Gets or sets the cursor that is displayed when the mouse pointer is over the ControlBase control. Inherited from ControlBase. |
| DataBindings | Gets the data bindings for the control. Inherited from Control. |
| DefaultBackColor static | Gets the default background color of the control. Inherited from Control. |
| DefaultCursor protected | Gets or sets the default cursor for the control. Inherited from Control. |
| DefaultErrorIcon static | Gets or sets the default error icon. Inherited from BaseEdit. |
| DefaultErrorIconAlignment static | Gets or sets the location of the default error icon in relation to the editor. Inherited from BaseEdit. |
| DefaultErrorImageOptions static | Gets a set of options that allow you to assign and customize the default icon displayed when an error is associated with the editor. Inherited from BaseEdit. |
| DefaultFont static | Gets the default font of the control. Inherited from Control. |
| DefaultForeColor static | Gets the default foreground color of the control. Inherited from Control. |
| DefaultImeMode protected | Gets the default Input Method Editor (IME) mode supported by the control. Inherited from Control. |
| DefaultMargin protected | Gets the space, in pixels, that is specified by default between controls. Inherited from Control. |
| DefaultMaximumSize protected | Gets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control. |
| DefaultMinimumSize protected | Gets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control. |
| DefaultPadding protected | Gets the internal spacing, in pixels, of the contents of a control. Inherited from Control. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DisplayRectangle | Gets the rectangle that represents the display area of the control. Inherited from Control. |
| Disposing | Gets a value indicating whether the base Control class is in the process of disposing. Inherited from Control. |
| Dock | Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control. |
| DoubleBuffered protected | Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control. |
| EditorContainsFocus | Gets whether the token editor or its pop-up form has focus. |
| EditorTypeName | Returns the textual representation of the TokenEdit class. |
| EditText | Returns the text currently displayed in the TokenEdit. |
| EditValue | Gets or sets the editor’s value. Inherited from BaseEdit. |
| Enabled | Gets or sets a value indicating whether the control can respond to user interaction. Inherited from Control. |
| EnterMoveNextControl | Gets or sets whether focus is moved to the next control (according to the tab order) when an end-user presses ENTER. Inherited from BaseEdit. |
| ErrorIcon | Gets or sets an icon displayed when an error is associated with the editor. Inherited from BaseEdit. |
| ErrorIconAlignment | Gets or sets the alignment of the icon displayed when an error is associated with the editor. Inherited from BaseEdit. |
| ErrorImageOptions | Gets a set of options that allow you to assign and customize an icon displayed when an error is associated with the editor. Inherited from BaseEdit. |
| ErrorText | Gets or sets the tooltip displayed when the mouse pointer hovers over the error icon. Inherited from BaseEdit. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| Focused | Gets a value indicating whether the control has input focus. Inherited from Control. |
| Font | Gets or sets the font used to display editor contents. Inherited from BaseEdit. |
| FontHeight protected | Gets or sets the height of the font of the control. Inherited from Control. |
| ForeColor | Gets or sets the editor content’s foreground color. Inherited from BaseEdit. |
| Handle | Gets the window handle that the control is bound to. Inherited from Control. |
| Handler | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| HasChildren | Gets a value indicating whether the control contains one or more child controls. Inherited from Control. |
| HasTokens | Checks whether there are any tokens currently displayed within the TokenEdit‘s edit box. |
| Height | Gets or sets the height of the control. Inherited from Control. |
| ImeMode | Gets or sets the Input Method Editor (IME) mode of the control. Inherited from Control. |
| ImeModeBase protected | Gets or sets the IME mode of a control. Inherited from Control. |
| InplaceType | Gets or sets the inplace type of an editor. Inherited from BaseEdit. |
| InvokeRequired | Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control. |
| IsAccessible | Gets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control. |
| IsDesignMode | Gets a value indicating whether the control is currently in design mode. Inherited from BaseControl. |
| IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from Control. |
| IsDrawing | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseEdit. |
| IsEditorActive | Checks whether or not this TokenEdit is currently focused. |
| IsHandleCreated | Gets a value indicating whether the control has a handle associated with it. Inherited from Control. |
| IsLoading | Gets a value indicating whether the editor is being loaded. Inherited from BaseEdit. |
| IsMirrored | Gets a value indicating whether the control is mirrored. Inherited from Control. |
| IsModified | Gets or sets whether the editor’s value has been modified since the editor last received focus or since it was last validated. Inherited from BaseEdit. |
| IsNeedFocus | This member supports the internal editors library infrastructure and is not intended to be used from your code. Inherited from BaseEdit. |
| IsPopupOpen | Gets whether the editor’s popup is currently open. |
| IsRightToLeft | Gets whether the ControlBase‘s visual elements are actually aligned to support locales using right-to-left fonts. Inherited from ControlBase. |
| IsTextEditorActive | Gets or sets whether the TokenEdit‘s text box currently has focus. |
| LayoutEngine | Gets a cached instance of the control’s layout engine. Inherited from Control. |
| Left | Gets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control. |
| Location | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control. |
| LookAndFeel | Gets an object containing the editor’s look and feel settings. Inherited from BaseEdit. |
| Margin | Gets or sets the space between controls. Inherited from Control. |
| MaskBox | Gets the text box that provides text editing functionality. |
| MaximumSize | Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control. |
| MenuManager | Gets or sets an object that controls the look and feel of the popup menus. Inherited from BaseEdit. |
| MinimumSize | Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control. |
| ModifierKeys static | Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control. |
| MouseButtons static | Gets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control. |
| MousePosition static | Gets the position of the mouse cursor in screen coordinates. Inherited from Control. |
| Name | Gets or sets the name of the control. Inherited from Control. |
| OldEditValue | Gets the last successfully validated value. Inherited from BaseEdit. |
| Padding | This property is not supported by the BaseEdit class. Inherited from BaseEdit. |
| Parent | Gets or sets the parent container of the control. Inherited from Control. |
| PopupAutoWidthCalculationLimit static | When the RepositoryItemTokenEdit.DropDownShowMode property is set to Outlook, the drop-down menu width is calculated according to the widest token available. The PopupAutoWidthCalculationLimit property allows the Token Edit to check only first N tokens when it calculates the required menu width. This limitation speeds up the calculation process and improves the control performance. |
| PopupServiceControl static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseEdit. |
| PreferredSize | Gets the size of a rectangular area into which the control can fit. Inherited from Control. |
| ProductName | Gets the product name of the assembly containing the control. Inherited from Control. |
| ProductVersion | Gets the version of the assembly containing the control. Inherited from Control. |
| PropagatingImeMode protected static | Gets an object that represents a propagating IME mode. Inherited from Control. |
| Properties | Provides access to an object that stores the main TokenEdit settings. |
| ReadOnly | Gets or sets whether the editor’s value cannot be changed by end-users. Inherited from BaseEdit. |
| RecreatingHandle | Gets a value indicating whether the control is currently re-creating its handle. Inherited from Control. |
| Region | Gets or sets the window region associated with the control. Inherited from Control. |
| RenderRightToLeft protected | This property is now obsolete. Inherited from Control. |
| ResizeRedraw protected | Gets or sets a value indicating whether the control redraws itself when resized. Inherited from Control. |
| Right | Gets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control. |
| RightToLeft | Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control. |
| ScaleChildren protected | Gets a value that determines the scaling of child controls. Inherited from Control. |
| ScaleFactor | Returns scale multipliers that are currently applied to a control’s original width and height. Inherited from BaseControl. |
| SelectedItems | Gets the collection that contains all tokens currently visible within the editor. |
| ServiceObject | This method is used internally when using editors inplace and is not intended to be called in your code. Inherited from BaseEdit. |
| ShowFocusCues protected | Gets a value indicating whether the control should display focus rectangles. Inherited from Control. |
| ShowKeyboardCues protected | Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control. |
| ShowToolTips | Gets or sets whether a tooltip should be displayed when the mouse pointer is over the control. Inherited from BaseControl. |
| Site | Gets or sets the site of the control. Inherited from Control. |
| Size | Gets or sets the height and width of the control. Inherited from Control. |
| StyleController | Gets or sets the style controller component that provides style settings for this control. Inherited from BaseControl. |
| SuperTip | Gets or sets a SuperToolTip for the current control. Inherited from BaseControl. |
| SuppressModifierKey | Gets or sets whether to suppress the specified keyboard key for the editor. Inherited from BaseEdit. |
| TabIndex | Gets or sets the tab order of the control within its container. Inherited from Control. |
| TabStop |
Gets or sets whether this TokenEdit can be focused by sequentially pressing the Tab keyboard key. Always equal to true. |
| Tag | Gets or sets the object that contains data about the control. Inherited from Control. |
| Text | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| ToolTip | Gets or sets a regular tooltip’s text content. Inherited from BaseControl. |
| ToolTipAnchor | Gets or sets whether the tooltip is anchored relative to the mouse cursor or relative to the editor. This property is not in effect if you handle the ToolTipController.GetActiveObjectInfo event. Inherited from BaseEdit. |
| ToolTipController | Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for this control. Inherited from BaseControl. |
| ToolTipIconType | Gets or sets the type of the tooltip icon. Inherited from BaseControl. |
| ToolTipTitle | Gets or sets a regular tooltip’s title. Inherited from BaseControl. |
| Top | Gets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control. |
| TopLevelControl | Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control. |
| TopRow | Gets or sets the first visible token row within this TokenEdit. |
| UseWaitCursor | Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control. |
| Visible | Gets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control. |
| Width | Gets or sets the width of the control. Inherited from Control. |
| WindowTarget | This property is not relevant for this class. Inherited from Control. |
Methods
| Name | Description |
|---|---|
| About() static | Displays the XtraEditors library’s about box. Inherited from BaseEdit. |
| AccessibilityNotifyClients(AccessibleEvents, Int32, Int32) protected | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control . Inherited from Control. |
| AccessibilityNotifyClients(AccessibleEvents, Int32) protected | Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. Inherited from Control. |
| ActivateTextEditor() | Focuses this TokenEdit‘s text box. |
| AllowMouseClick(Control, Point) | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| BeginInvoke(Delegate, Object[]) | Executes the specified delegate asynchronously with the specified arguments, on the thread that the control’s underlying handle was created on. Inherited from Control. |
| BeginInvoke(Delegate) | Executes the specified delegate asynchronously on the thread that the control’s underlying handle was created on. Inherited from Control. |
| BringToFront() | Brings the control to the front of the z-order. Inherited from Control. |
| CalcBestSize() | Calculates the minimum size sufficient to fit the content. Inherited from BaseControl. |
| CalcHitInfo(Point) | Gets which TokenEdit control’s element is located at the specific position. |
| CalcHitInfo(Int32, Int32) | Gets which token element is located at the specific position. |
| CalcMinHeight() | Calculates the minumum height of the editor. Inherited from BaseEdit. |
| CancelPopup() | |
| CanHandleKeyMessage(Message) static | This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseEdit. |
| CheckItem(Object) | Checks the token with the specified value in your TokenEdit control. |
| ClearPreferredSizeCache(Control) static | Clears the value of the size of a rectangular area, into which the specified control can fit, from the program cache. Inherited from ControlBase. |
| ClosePopup() | Closes the drop-down window. |
| ClosePopup(PopupCloseMode) | Forces the TokenEdit‘s pop-up to close in a specific mode. |
| CloseTextEditor(Boolean) | Moves focus away from this TokenEdit‘s text box and optionally removes the last entered text. |
| Contains(Control) | Retrieves a value indicating whether the specified control is a child of the control. Inherited from Control. |
| CreateControl() | Forces the creation of the visible control, including the creation of the handle and any visible child controls. Inherited from Control. |
| CreateControlsInstance() protected | Creates a new instance of the control collection for the control. Inherited from Control. |
| CreateGraphics() | Creates the Graphics for the control. Inherited from Control. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| DefWndProc(Message) protected | Sends the specified message to the default window procedure. Inherited from Control. |
| DeselectAll() | Clears selection within the editor. Inherited from BaseEdit. |
| DestroyHandle() protected | Destroys the handle associated with the control. Inherited from Control. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| DoDragDrop(Object, DragDropEffects) | Begins a drag-and-drop operation. Inherited from Control. |
| DoValidate() | Performs editor value validation. Inherited from BaseEdit. |
| DoValidate(PopupCloseMode) | Validates the editor. Inherited from BaseEdit. |
| DrawToBitmap(Bitmap, Rectangle) | Supports rendering to the specified bitmap. Inherited from Control. |
| EndInvoke(IAsyncResult) | Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed. Inherited from Control. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FindForm() | Retrieves the form that the control is on. Inherited from Control. |
| Focus() | Sets input focus to the control. Inherited from Control. |
| ForceInitializePopupForm() | Explicitly initializes this Token Edit Control‘s drop-down menu. |
| FromChildHandle(IntPtr) static | Retrieves the control that contains the specified handle. Inherited from Control. |
| FromHandle(IntPtr) static | Returns the control that is currently associated with the specified handle. Inherited from Control. |
| GetAccessible() | Returns an object which implements the accessibility information. Inherited from BaseControl. |
| GetAutoSizeMode() protected | Retrieves a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control. |
| GetCanProcessMnemonic(Control) static | Returns the value of the control’s CanProcessMnemonic property, if this property exists. Inherited from ControlBase. |
| GetChildAtPoint(Point, GetChildAtPointSkip) | Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. Inherited from Control. |
| GetChildAtPoint(Point) | Retrieves the child control that is located at the specified coordinates. Inherited from Control. |
| GetContainerControl() | Returns the next ContainerControl up the control’s chain of parent controls. Inherited from Control. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetNextControl(Control, Boolean) | Retrieves the next control forward or back in the tab order of child controls. Inherited from Control. |
| GetPopupEditForm() | Returns the control’s popup window. |
| GetPreferredSize(Size) | Retrieves the size of a rectangular area into which the control can be fitted. Inherited from BaseEdit. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetStyle(ControlStyles) protected | Retrieves the value of the specified control style bit for the control. Inherited from Control. |
| GetTokenList() | Returns a TokenEditSelectedItemCollection object that contains all tokens currently visible within the editor. |
| GetTopLevel() protected | Determines if the control is a top-level control. Inherited from Control. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GetUnvalidatedControl(Control) static | This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ControlBase. |
| GetValidationCanceled(Control) static | Returns the ValidationCancelled property value of a control, if this property exists. Inherited from ControlBase. |
| GetValidationCanceledSource(Control) static | Returns the parent container of the specified control that canceled validation. Inherited from ControlBase. |
| GetViewInfo() | Returns the object that contains the internal information used to render this TokenEdit. |
| Hide() | Conceals the control from the user. Inherited from Control. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| InitializeNewComponent() | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| InitLayout() protected | Called after the control has been added to another container. Inherited from Control. |
| Invalidate() | Invalidates the entire surface of the control and causes the control to be redrawn. Inherited from Control. |
| Invalidate(Boolean) | Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control. |
| Invalidate(Rectangle, Boolean) | Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control. |
| Invalidate(Rectangle) | Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control. |
| Invalidate(Region, Boolean) | Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control. |
| Invalidate(Region) | Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control. |
| Invoke(Delegate, Object[]) | Executes the specified delegate, on the thread that owns the control’s underlying window handle, with the specified list of arguments. Inherited from Control. |
| Invoke(Delegate) | Executes the specified delegate on the thread that owns the control’s underlying window handle. Inherited from Control. |
| InvokeGotFocus(Control, EventArgs) protected | Raises the GotFocus event for the specified control. Inherited from Control. |
| InvokeLostFocus(Control, EventArgs) protected | Raises the LostFocus event for the specified control. Inherited from Control. |
| InvokeOnClick(Control, EventArgs) protected | Raises the Click event for the specified control. Inherited from Control. |
| InvokePaint(Control, PaintEventArgs) protected | Raises the Paint event for the specified control. Inherited from Control. |
| InvokePaintBackground(Control, PaintEventArgs) protected |
Raises the PaintBackground event for the specified control.
Inherited from Control. |
| IsKeyLocked(Keys) static | Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. Inherited from Control. |
| IsMnemonic(Char, String) static | Determines if the specified character is the mnemonic character assigned to the control in the specified string. Inherited from Control. |
| IsNeededKey(KeyEventArgs) | Returns a value indicating whether a particular key will be processed by the editor or passed to its container. Inherited from BaseEdit. |
| IsNotLoadedValue(Object) static | Gets whether the specified value is the “Non-loaded Value”. This property is in effect when asynchronous data binding is used. Inherited from BaseEdit. |
| IsTextEditor(Control) static | Checks whether a control is a text editor. Inherited from BaseEdit. |
| IsUnvalidatedControlIsParent(Control) static | This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ControlBase. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| NotifyInvalidate(Rectangle) protected | Raises the Invalidated event with a specified region of the control to invalidate. Inherited from Control. |
| OnAutoSizeChanged(EventArgs) protected | Raises the AutoSizeChanged event. Inherited from Control. |
| OnBackColorChanged(EventArgs) protected | Raises the BackColorChanged event. Inherited from Control. |
| OnBackgroundImageChanged(EventArgs) protected | Raises the BackgroundImageChanged event. Inherited from Control. |
| OnBackgroundImageLayoutChanged(EventArgs) protected | Raises the BackgroundImageLayoutChanged event. Inherited from Control. |
| OnCausesValidationChanged(EventArgs) protected | Raises the CausesValidationChanged event. Inherited from Control. |
| OnChangeUICues(UICuesEventArgs) protected | Raises the ChangeUICues event. Inherited from Control. |
| OnClick(EventArgs) protected | Raises the Click event. Inherited from Control. |
| OnControlAdded(ControlEventArgs) protected | Raises the ControlAdded event. Inherited from Control. |
| OnControlRemoved(ControlEventArgs) protected | Raises the ControlRemoved event. Inherited from Control. |
| OnCursorChanged(EventArgs) protected | Raises the CursorChanged event. Inherited from Control. |
| OnDockChanged(EventArgs) protected | Raises the DockChanged event. Inherited from Control. |
| OnDoubleClick(EventArgs) protected | Raises the DoubleClick event. Inherited from Control. |
| OnDragDrop(DragEventArgs) protected | Raises the DragDrop event. Inherited from Control. |
| OnDragEnter(DragEventArgs) protected | Raises the DragEnter event. Inherited from Control. |
| OnDragLeave(EventArgs) protected | Raises the DragLeave event. Inherited from Control. |
| OnDragOver(DragEventArgs) protected | Raises the DragOver event. Inherited from Control. |
| OnFontChanged(EventArgs) protected | Raises the FontChanged event. Inherited from Control. |
| OnForeColorChanged(EventArgs) protected | Raises the ForeColorChanged event. Inherited from Control. |
| OnGiveFeedback(GiveFeedbackEventArgs) protected | Raises the GiveFeedback event. Inherited from Control. |
| OnHelpRequested(HelpEventArgs) protected | Raises the HelpRequested event. Inherited from Control. |
| OnImeModeChanged(EventArgs) protected | Raises the ImeModeChanged event. Inherited from Control. |
| OnInvalidated(InvalidateEventArgs) protected | Raises the Invalidated event. Inherited from Control. |
| OnLayout(LayoutEventArgs) protected | Raises the Layout event. Inherited from Control. |
| OnLocationChanged(EventArgs) protected | Raises the LocationChanged event. Inherited from Control. |
| OnMarginChanged(EventArgs) protected | Raises the MarginChanged event. Inherited from Control. |
| OnMouseCaptureChanged(EventArgs) protected | Raises the MouseCaptureChanged event. Inherited from Control. |
| OnMouseClick(MouseEventArgs) protected | Raises the MouseClick event. Inherited from Control. |
| OnMove(EventArgs) protected | Raises the Move event. Inherited from Control. |
| OnNotifyMessage(Message) protected | Notifies the control of Windows messages. Inherited from Control. |
| OnParentBackColorChanged(EventArgs) protected | Raises the BackColorChanged event when the BackColor property value of the control’s container changes. Inherited from Control. |
| OnParentBackgroundImageChanged(EventArgs) protected | Raises the BackgroundImageChanged event when the BackgroundImage property value of the control’s container changes. Inherited from Control. |
| OnParentBindingContextChanged(EventArgs) protected | Raises the BindingContextChanged event when the BindingContext property value of the control’s container changes. Inherited from Control. |
| OnParentCursorChanged(EventArgs) protected | Raises the CursorChanged event. Inherited from Control. |
| OnParentEnabledChanged(EventArgs) protected | Raises the EnabledChanged event when the Enabled property value of the control’s container changes. Inherited from Control. |
| OnParentFontChanged(EventArgs) protected | Raises the FontChanged event when the Font property value of the control’s container changes. Inherited from Control. |
| OnParentForeColorChanged(EventArgs) protected | Raises the ForeColorChanged event when the ForeColor property value of the control’s container changes. Inherited from Control. |
| OnParentRightToLeftChanged(EventArgs) protected | Raises the RightToLeftChanged event when the RightToLeft property value of the control’s container changes. Inherited from Control. |
| OnParentVisibleChanged(EventArgs) protected | Raises the VisibleChanged event when the Visible property value of the control’s container changes. Inherited from Control. |
| OnPrint(PaintEventArgs) protected | Raises the Paint event. Inherited from Control. |
| OnQueryContinueDrag(QueryContinueDragEventArgs) protected | Raises the QueryContinueDrag event. Inherited from Control. |
| OnRegionChanged(EventArgs) protected | Raises the RegionChanged event. Inherited from Control. |
| OnStyleChanged(EventArgs) protected | Raises the StyleChanged event. Inherited from Control. |
| OnSystemColorsChanged(EventArgs) protected | Raises the SystemColorsChanged event. Inherited from Control. |
| OnTabIndexChanged(EventArgs) protected | Raises the TabIndexChanged event. Inherited from Control. |
| OnTextChanged(EventArgs) protected | Raises the TextChanged event. Inherited from Control. |
| PerformLayout() | Forces the control to apply layout logic to all its child controls. Inherited from Control. |
| PerformLayout(Control, String) | Forces the control to apply layout logic to all its child controls. Inherited from Control. |
| PerformValidation(Control, Boolean) static | Returns if the ControlBase validates its value before the user may proceed. Inherited from ControlBase. |
| PointToClient(Point) | Computes the location of the specified screen point into client coordinates. Inherited from Control. |
| PointToScreen(Point) | Computes the location of the specified client point into screen coordinates. Inherited from Control. |
| PreProcessControlMessage(Message) | Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control. |
| PreProcessMessage(Message) | Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control. |
| ProcessCmdKey(Message, Keys) protected | Processes a command key. Inherited from Control. |
| ProcessDialogChar(Char) protected | Processes a dialog character. Inherited from Control. |
| ProcessDialogKey(Keys) protected | Processes a dialog key. Inherited from Control. |
| ProcessKeyEventArgs(Message) protected | Processes a key message and generates the appropriate control events. Inherited from Control. |
| ProcessKeyMessage(Message) protected | Processes a keyboard message. Inherited from Control. |
| ProcessKeyPreview(Message) protected | Previews a keyboard message. Inherited from Control. |
| ProcessMnemonic(Char) protected | Processes a mnemonic character. Inherited from Control. |
| RaiseDragEvent(Object, DragEventArgs) protected | Raises the appropriate drag event. Inherited from Control. |
| RaiseKeyEvent(Object, KeyEventArgs) protected | Raises the appropriate key event. Inherited from Control. |
| RaiseMouseEvent(Object, MouseEventArgs) protected | Raises the appropriate mouse event. Inherited from Control. |
| RaisePaintEvent(Object, PaintEventArgs) protected | Raises the appropriate paint event. Inherited from Control. |
| RecreateHandle() protected | Forces the re-creation of the handle for the control. Inherited from Control. |
| RectangleToClient(Rectangle) | Computes the size and location of the specified screen rectangle in client coordinates. Inherited from Control. |
| RectangleToScreen(Rectangle) | Computes the size and location of the specified client rectangle in screen coordinates. Inherited from Control. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ReflectMessage(IntPtr, Message) protected static | Reflects the specified message to the control that is bound to the specified handle. Inherited from Control. |
| Refresh() | Forces the control to invalidate its client area and immediately redraw itself and any child controls. Inherited from BaseControl. |
| RemoveItem(Object) | Hides a token with the specified value from the TokenEdit control’s textbox. |
| Reset() | |
| ResetBackColor() | Resets the BaseEdit.BackColor property back to its default value. Inherited from BaseEdit. |
| ResetBindings() | Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. Inherited from Control. |
| ResetCursor() | Resets the Cursor property to its default value. Inherited from Control. |
| ResetFont() | Resets the Font property to its default value. Inherited from Control. |
| ResetForeColor() | Resets the BaseEdit.ForeColor property back to its default value. Inherited from BaseEdit. |
| ResetImeMode() | Resets the ImeMode property to its default value. Inherited from Control. |
| ResetMouseEventArgs() protected | Resets the control to handle the MouseLeave event. Inherited from Control. |
| ResetRightToLeft() | Resets the RightToLeft property to its default value. Inherited from Control. |
| ResetSelection() | In descendant classes, clears the selection. Inherited from BaseEdit. |
| ResetSuperTip() | Removes the SuperToolTip object that has been assigned to the current control. Inherited from BaseControl. |
| ResetText() | Resets the Text property to its default value (Empty). Inherited from Control. |
| ResetValidationCanceled(Control) static | Resets the control’s ValidationCancelled property. This method supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ControlBase. |
| ResumeLayout() | Resumes usual layout logic. Inherited from Control. |
| ResumeLayout(Boolean) | Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. Inherited from Control. |
| RtlTranslateAlignment(ContentAlignment) protected | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control. |
| RtlTranslateAlignment(HorizontalAlignment) protected | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control. |
| RtlTranslateAlignment(LeftRightAlignment) protected | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control. |
| RtlTranslateContent(ContentAlignment) protected | Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control. |
| RtlTranslateHorizontal(HorizontalAlignment) protected | Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control. |
| RtlTranslateLeftRight(LeftRightAlignment) protected | Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control. |
| Scale(SizeF) | Scales the control and all child controls by the specified scaling factor. Inherited from Control. |
| Scale(Single, Single) | Scales the entire control and any child controls. Inherited from Control. |
| Scale(Single) | Scales the control and any child controls. Inherited from Control. |
| ScaleCore(Single, Single) protected | This method is not relevant for this class. Inherited from Control. |
| ScrollIntoView(TokenEditToken) | Scrolls this TokenEdit up or down to the target token. |
| Select() | Activates the control. Inherited from Control. |
| SelectAll() | Selects the editor’s entire content. Inherited from BaseEdit. |
| SelectItem(Object) | Selects an item with specified value. |
| SelectNextControl(Control, Boolean, Boolean, Boolean, Boolean) | Activates the next control. Inherited from Control. |
| SendKey(Object, KeyPressEventArgs) | Sends the specified message to the active editor. Inherited from BaseEdit. |
| SendKey(KeyEventArgs) | Raises the KeyDown event. Inherited from BaseEdit. |
| SendKeyUp(KeyEventArgs) | Raises the KeyUp event. Inherited from BaseEdit. |
| SendMouse(Point, MouseButtons) | Raises the RepositoryItem.MouseDown event. Inherited from BaseEdit. |
| SendMouse(MouseEventArgs) | Raises the RepositoryItem.MouseDown event. Inherited from BaseEdit. |
| SendMouseUp(Point, MouseButtons) | Raises the RepositoryItem.MouseUp event. Inherited from BaseEdit. |
| SendToBack() | Sends the control to the back of the z-order. Inherited from Control. |
| SetAutoSizeMode(AutoSizeMode) protected | Sets a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control. |
| SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified) | Sets the specified bounds of the control to the specified location and size. Inherited from Control. |
| SetBounds(Int32, Int32, Int32, Int32) | Sets the bounds of the control to the specified location and size. Inherited from Control. |
| SetClientSizeCore(Int32, Int32) protected | Sets the size of the client area of the control. Inherited from Control. |
| SetStyle(ControlStyles, Boolean) protected |
Sets a specified ControlStyles flag to either true or false.
Inherited from Control. |
| SetTopLevel(Boolean) protected | Sets the control as the top-level control. Inherited from Control. |
| SetVisibleCore(Boolean) protected | Sets the control to the specified visible state. Inherited from Control. |
| Show() | Displays the control to the user. Inherited from Control. |
| ShowPopup() | Displays the drop-down assigned to this TokenEdit. |
| SizeFromClientSize(Size) protected | Determines the size of the entire control from the height and width of its client area. Inherited from Control. |
| StringStartsWidth(String, String, Boolean) static | This member supports the internal .NET Framework infrastructure, and is not intended to be used directly from your code. Inherited from BaseEdit. |
| StringStartsWidth(String, String) static | This method supports the internal .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from BaseEdit. |
| SuspendLayout() | Temporarily suspends the layout logic for the control. Inherited from Control. |
| IDropTarget.OnDragDrop(DragEventArgs) | Raises the DragDrop event. Inherited from Control. |
| IDropTarget.OnDragEnter(DragEventArgs) | Raises the DragEnter event. Inherited from Control. |
| IDropTarget.OnDragLeave(EventArgs) | Raises the DragLeave event. Inherited from Control. |
| IDropTarget.OnDragOver(DragEventArgs) | Raises the DragOver event. Inherited from Control. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
| UncheckItem(Object) | Unchecks the token with the specified value in your TokenEdit control. |
| Update() | Causes the control to redraw the invalidated regions within its client area. Inherited from Control. |
| UpdateBounds() protected | Updates the bounds of the control with the current size and location. Inherited from Control. |
| UpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32) protected | Updates the bounds of the control with the specified size, location, and client size. Inherited from Control. |
| UpdateBounds(Int32, Int32, Int32, Int32) protected | Updates the bounds of the control with the specified size and location. Inherited from Control. |
| UpdatePopupFormDataSource() | Retrieves items from the data source and updates the list displayed in the TokenEdit‘s popup. |
| UpdateStyles() protected | Forces the assigned styles to be reapplied to the control. Inherited from Control. |
| UpdateZOrder() protected | Updates the control in its parent’s z-order. Inherited from Control. |
| Validate() | Validates the text entered in this TokenEdit. |
Events
| Name | Description |
|---|---|
| AutoSizeChanged | This event is not relevant for this class. Inherited from Control. |
| BackColorChanged | This event is not supported by the BaseEdit class. Inherited from BaseEdit. |
| BackgroundImageChanged | Occurs when the value of the BackgroundImage property changes. Inherited from Control. |
| BackgroundImageLayoutChanged | Occurs when the BackgroundImageLayout property changes. Inherited from Control. |
| BeforePopup | Fires before the drop-down window is shown. |
| BeforeShowPopupPanel | Occurs before the peek panel assigned to this TokenEdit is displayed. |
| BindingContextChanged | Occurs when the value of the BindingContext property changes. Inherited from Control. |
| CausesValidationChanged | Occurs when the value of the CausesValidation property changes. Inherited from Control. |
| ChangeUICues | Occurs when the focus or keyboard user interface (UI) cues change. Inherited from Control. |
| Click | Occurs when the control is clicked. Inherited from Control. |
| ClientSizeChanged | Occurs when the value of the ClientSize property changes. Inherited from Control. |
| Closed | Fires after the drop-down window is closed and gets the reason for closure. |
| CloseUp | Fires when the drop-down window is about to be closed and allows you to get and update the selected token. |
| ContextMenuChanged | Occurs when the value of the ContextMenu property changes. Inherited from Control. |
| ContextMenuStripChanged | Occurs when the value of the ContextMenuStrip property changes. Inherited from Control. |
| ControlAdded | Occurs when a new control is added to the Control.ControlCollection. Inherited from Control. |
| ControlRemoved | Occurs when a control is removed from the Control.ControlCollection. Inherited from Control. |
| CursorChanged | Occurs when the value of the Cursor property changes. Inherited from Control. |
| CustomDisplayText | Enables custom display text to be provided for an editor. Inherited from BaseEdit. |
| CustomDrawTokenBackground | |
| CustomDrawTokenGlyph | Allows you to re-draw the default token glyph. |
| CustomDrawTokenText | Allows you to re-paint the token text area. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| DockChanged | Occurs when the value of the Dock property changes. Inherited from Control. |
| DoubleClick | Occurs when the control is double-clicked. Inherited from Control. |
| DragDrop | Occurs when a drag-and-drop operation is completed. Inherited from Control. |
| DragEnter | Occurs when an object is dragged into the control’s bounds. Inherited from Control. |
| DragLeave | Occurs when an object is dragged out of the control’s bounds. Inherited from Control. |
| DragOver | Occurs when an object is dragged over the control’s bounds. Inherited from Control. |
| EditValueChanged | Fires immediately after the edit value has been changed. Inherited from BaseEdit. |
| EditValueChanging | Fires when the editor’s value is about to change. Inherited from BaseEdit. |
| EnabledChanged | Occurs when the Enabled property value has changed. Inherited from Control. |
| Enter | Occurs when the control is entered. Inherited from Control. |
| FontChanged | This event is not supported by the BaseEdit class. Inherited from BaseEdit. |
| ForeColorChanged | This event is not supported by the BaseEdit class. Inherited from BaseEdit. |
| FormatEditValue | Enables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). Inherited from BaseEdit. |
| GiveFeedback | Occurs during a drag operation. Inherited from Control. |
| GotFocus | Occurs when the control receives focus. Inherited from Control. |
| HandleCreated | Occurs when a handle is created for the control. Inherited from Control. |
| HandleDestroyed | Occurs when the control’s handle is in the process of being destroyed. Inherited from Control. |
| HelpRequested | Occurs when the user requests help for a control. Inherited from Control. |
| ImeModeChanged | Occurs when the ImeMode property has changed. Inherited from Control. |
| Invalidated | Occurs when a control’s display requires redrawing. Inherited from Control. |
| InvalidValue | Enables an appropriate response to be provided when invalid values are entered. Inherited from BaseEdit. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from Control. |
| KeyPress | Occurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from Control. |
| Layout | Occurs when a control should reposition its child controls. Inherited from Control. |
| Leave | Occurs when the input focus leaves the control. Inherited from Control. |
| LocationChanged | Occurs when the Location property value has changed. Inherited from Control. |
| LostFocus | Occurs when the control loses focus. Inherited from Control. |
| MarginChanged | Occurs when the control’s margin changes. Inherited from Control. |
| Modified | Fires when the user starts to modify the edit value. Inherited from BaseEdit. |
| MouseCaptureChanged | Occurs when the control loses mouse capture. Inherited from Control. |
| MouseClick | Occurs when the control is clicked by the mouse. Inherited from Control. |
| MouseDoubleClick | Occurs when the control is double clicked by the mouse. Inherited from Control. |
| MouseDown | Occurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control. |
| MouseEnter | Occurs when the mouse pointer enters the control. Inherited from Control. |
| MouseHover | Occurs when the mouse pointer rests on the control. Inherited from Control. |
| MouseLeave | Occurs when the mouse pointer leaves the control. Inherited from Control. |
| MouseMove | Occurs when the mouse pointer is moved over the control. Inherited from Control. |
| MouseUp | Occurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control. |
| MouseWheel | Occurs when the mouse wheel moves while the control has focus. Inherited from Control. |
| Move | Occurs when the control is moved. Inherited from Control. |
| PaddingChanged | Occurs when the control’s padding changes. Inherited from Control. |
| Paint | Occurs when the control is redrawn. Inherited from Control. |
| ParentChanged | Occurs when the Parent property value changes. Inherited from Control. |
| ParseEditValue | Converts an input value (the one that is entered by an end-user or assigned in code) to the value to be stored by the editor. Inherited from BaseEdit. |
| Popup | Fires after the drop-down window is opened. |
| PreviewKeyDown | Occurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control. |
| ProcessNewValue | Fires when a user enters a new value into a Token Edit that is connected to a data source. Allows you to validate entered values and call data source API to save valid records. |
| PropertiesChanged | Fires immediately after any editor’s property value has changed. Inherited from BaseEdit. |
| QueryAccessibilityHelp | Fires when the help is provided to accessibility applications. Inherited from BaseEdit. |
| QueryCloseUp | Fires before the drop-down window is closed and allows you to cancel the action. |
| QueryContinueDrag | Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control. |
| QueryPopUp | Fires before the drop-down window is opened and allows you to cancel the action. |
| QueryProcessKey | Provides ability to specify whether the key pressed in the editor is processed by the editor or a container control (GridControl, TreeList, etc.) that displays this editor. Inherited from BaseEdit. |
| RegionChanged | Occurs when the value of the Region property changes. Inherited from Control. |
| RemoveTokenButtonClick | Occurs when a user clicks the Remove button in the TokenEdit drop-down menu. |
| Resize | Occurs when the control is resized. Inherited from Control. |
| RightToLeftChanged | Occurs when the RightToLeft property value changes. Inherited from Control. |
| SelectedItemsChanged | Occurs whenever the list of currently selected tokens changes. |
| SizeChanged | Occurs when the Size property value changes. Inherited from Control. |
| StyleChanged | Occurs when the control style changes. Inherited from Control. |
| SystemColorsChanged | Occurs when the system colors change. Inherited from Control. |
| TabIndexChanged | Occurs when the TabIndex property value changes. Inherited from Control. |
| TabStopChanged | Occurs when the TabStop property value changes. Inherited from Control. |
| TextChanged | Occurs when the Text property value changes. Inherited from Control. |
| TokenCheckStateChanged | Occurs when a token in this TokenEdit changed its checked state. |
| Validated | Occurs when the control is finished validating. Inherited from Control. |
| ValidateToken | Allows you to perform the custom validation on text currently entered in this TokenEdit control. |
| Validating | Occurs when the control is validating. Inherited from Control. |
| VisibleChanged | Occurs when the Visible property value changes. Inherited from Control. |
See Also