Skip to main content

TokenEdit Methods

The text editor that applies custom validation to the entered text and transforms text blocks which passed this validation to tokens.
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.
See Also