RepositoryItemTextEdit Members
Represents a repository item which contains settings specific to TextEdit editors.Constructors
| Name | Description |
|---|---|
| RepositoryItemTextEdit() | Creates a new RepositoryItemTextEdit object with default settings. |
Properties
| Name | Description |
|---|---|
| AccessibleDefaultActionDescription | Gets or sets the default action description of the repository item for use by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleName | Gets or sets the object’s name used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleRole | Gets or sets the object’s accessible role. Inherited from RepositoryItem. |
| AdvancedModeOptions | |
| AllowContextImageChangeAnimation | Gets or sets whether the context image is changed using animation. This property is not in effect for in-place editors. |
| AllowFocused | Gets or sets a value specifying whether the focus rectangle is displayed within the editor when it has focus. Inherited from RepositoryItem. |
| AllowFocusedAppearance | Gets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. Inherited from RepositoryItem. |
| AllowGlyphSkinning | Gets or sets whether this TextEdit can colorize its icons. |
| AllowHtmlDraw | Gets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items. Inherited from RepositoryItem. |
| AllowInplaceAutoFilter | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| AllowInplaceBorderPainter | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| AllowMouseWheel | Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. |
| AllowNullInput | Gets or sets whether end users can reset the editor’s value to null with the keyboard. |
| Appearance | Gets appearance settings used to paint the editor when it is enabled. Inherited from RepositoryItem. |
| AppearanceDisabled | Gets appearance settings used to paint the editor when it is disabled. Inherited from RepositoryItem. |
| AppearanceFocused | Gets appearance settings used to paint the current editor when it is focused. Inherited from RepositoryItem. |
| AppearanceReadOnly | Gets appearance settings used to paint the read-only editor. Inherited from RepositoryItem. |
| AutoHeight | Gets or sets a value specifying whether the editor’s height is calculated automatically to fit the editor’s content. Inherited from RepositoryItem. |
| BeepOnError | Gets or sets whether the masked editor should play a system error sound when a user enters an invalid character (for example, a literal in an editor with a Numeric mask). This property replaces the BeepOnError property in v20.2 and newer. |
| BestFitWidth | Gets or sets the editor’s best fit width. Inherited from RepositoryItem. |
| BorderStyle | Gets or sets the editor’s border style. Inherited from RepositoryItem. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| CharacterCasing | Gets or sets the character casing applied to the editor’s content. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| ContextImage | Gets or sets a custom image displayed at the editor’s edge, specified by the RepositoryItemTextEdit.ContextImageAlignment property. |
| ContextImageAlignment | Gets or sets the alignment of an image displayed by this editor. |
| ContextImageOptions | Provides access to all properties that allow you to assign and customize a custom image displayed at the editor’s edge. |
| ContextMenu | Gets or sets the context menu for the editor. Inherited from RepositoryItem. |
| DefaultAlignment | Gets the default horizontal alignment of the editor’s content. Inherited from RepositoryItem. |
| DefaultBorderStyleInBars | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DefaultBorderStyleInGrid | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DisplayFormat | Gets format settings applied to the editor’s value. Inherited from RepositoryItem. |
| Editable | Gets whether the editor’s value can be changed. Inherited from RepositoryItem. |
| EditFormat | Provides access to the settings used to format the edit value when the editor has input focus. Inherited from RepositoryItem. |
| EditorTypeName | Gets the corresponding editor’s type name. |
| EditValueChangedDelay | Gets or sets the time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem. |
| EditValueChangedFiringDelay static | Gets or sets the default time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem. |
| EditValueChangedFiringMode | Gets or sets the RepositoryItem.EditValueChanged event’s firing mode. Inherited from RepositoryItem. |
| Enabled | Gets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors. Inherited from RepositoryItem. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| ExportMode | Specifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. Inherited from RepositoryItem. |
| HideSelection | Gets or sets whether the selection is hidden when moving focus to another control. |
| HtmlImages | Gets or sets a collection of images that can be embedded in the editor’s display text or the display text of the editor’s items, using the image tag. Inherited from RepositoryItem. |
| IsDesignMode | Indicates whether the editor is currently in design mode. Inherited from RepositoryItem. |
| IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from RepositoryItem. |
| IsEditValueChangedEventPending | Gets whether the EditValueChanged event is postponed. Inherited from RepositoryItem. |
| IsFilterLookUp | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| IsLoading | Indicates whether the editor is being loaded. Inherited from RepositoryItem. |
| IsLockUpdate | Gets a value indicating whether the editor is immediately updated in response to changing its settings. Inherited from RepositoryItem. |
| IsNonSortableEditor | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| LinkCount | Gets the number of objects connected to the current repository item. Inherited from RepositoryItem. |
| LookAndFeel | Provides access to the stand-alone editor’s look and feel settings. These settings are not in effect for the editor in a bar, ribbon, grid, etc. Inherited from RepositoryItem. |
| Mask | Specifies the editor’s input mask. From v20.2, use the MaskSettings property to specify an input mask. |
| MaskBoxPadding | Gets or sets the amount of space around the text box embedded in the TextEdit. |
| MaskSettings | Provides access to settings that allow you to create input masks. This property replaces the Mask property beginning with v20.2. See the following help topic for more information: Input Masks. |
| MaxLength | Gets or sets the maximum number of characters an end-user can enter into the editor. |
| MaxToolTipTextLength static | Gets or sets the maximum number of characters in the automatically generated tooltip displayed for an in-place editor. |
| Name | Gets or sets the repository item name. Inherited from RepositoryItem. |
| NormalizeDisplayText static | Set the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control. Inherited from RepositoryItem. |
| NullText | Gets or sets the text that presents the editor’s null value (null, System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit). Inherited from RepositoryItem. |
| NullValuePrompt | Gets or sets a grayed out hint displayed when the editor’s value is null or empty. This property is in effect for standalone editors and for editors embedded in toolbars and Ribbon controls. Not supported for in-place editors embedded in grid and tree list controls. Not supported for read-only editors. |
| NullValuePromptForeColor | |
| NullValuePromptShowForEmptyValue | Gets or sets whether the editor displays a prompt when its value is not specified (equals String.Empty). |
| OwnerEdit | Gets an editor which owns the current repository item. |
| OwnerItem | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| Padding | Gets or sets the TextEdit padding. The MemoEdit does not fully support this property, use the MaskBoxPadding property instead. |
| PasswordChar | Gets or sets the password character that appears instead of actual characters. |
| PopupOffset | Gets or sets the popup window’s location. Inherited from RepositoryItem. |
| Properties | Obsolete. Gets an object providing properties specific to the text edit control. |
| ReadOnly | Gets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem. |
| RequireDisplayTextSorting | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| ShowNullValuePrompt | Gets or sets conditions under which this editor should display its null value text (see the NullValuePrompt property). |
| ShowNullValuePromptWhenFocused | Gets or sets whether the focused editor displays a prompt when its value is not specified. |
| ShowNullValuePromptWhenReadOnly | Gets or sets whether the read-only editor displays a prompt when its value is not specified. |
| Site | Gets or sets a ISite for the object. Inherited from RepositoryItem. |
| Tag | Gets or sets the data associated with the repository item. Inherited from RepositoryItem. |
| TextPadding | Gets or sets the text (value) padding within the editor. |
| UseAdvancedMode | Switches the editor to Advanced Mode. This mode supports new caret and selection animations, emojis, and embedded labels. You can set up properties from the RepositoryItemTextEdit.AdvancedModeOptions group to choose which Advanced Mode features are enabled. |
| UseMaskAsDisplayFormat | Gets or sets whether the editor uses an Input Mask to format its display value when not focused. This property replaces the UseMaskAsDisplayFormat property beginning with v20.2. |
| UseParentBackground | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| UseReadOnlyAppearance | Gets or sets whether the TextEdit is grayed out in the read only mode. |
| UseSystemPasswordChar | Gets or sets whether password mode is active and the system password character is used to mask the editor’s text. |
| UseTextEditorForAutoFilter | Gets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItem. |
| ValidateOnEnterKey | Gets or sets whether to raise the RepositoryItem.Validating event on pressing the ENTER key. |
| XlsxFormatString | Gets or sets the native Excel format string used to format the editor’s value when exporting to XLSX. This property is in effect in WYSIWYG export mode. |
Methods
| Name | Description |
|---|---|
| Assign(RepositoryItem) | Copies properties of the source repository item to the current object. |
| BeginInit() | Notifies the editor that the initialization has been started. Inherited from RepositoryItem. |
| BeginUpdate() | Locks the RepositoryItem object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from RepositoryItem. |
| CancelUpdate() | Unlocks the RepositoryItem object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from RepositoryItem. |
| Clone() | Creates a copy of the current repository item. Inherited from RepositoryItem. |
| Connect(Object) | Connects the repository item to the specified object. Inherited from RepositoryItem. |
| CreateEditor() | Creates an editor whose type corresponds to the repository item’s type. Inherited from RepositoryItem. |
| CreateGroupPainter() | Initializes a new instance of the DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter class. Inherited from RepositoryItem. |
| 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. |
| CreatePainter() | This member supports the editor library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| CreateViewInfo() | This member supports the editors library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| Disconnect(Object) | Removes the connection between the repository item and the specified object. Inherited from RepositoryItem. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EditMaskSettings(Object) | Shows the Mask Editor dialog at runtime. Users can utilize this dialog to apply standard or custom masks to this editor. |
| EditMaskSettings(IWindowsFormsEditorService, Object) | |
| EditMaskSettings(IWin32Window, Object) | |
| EnableCustomMaskTextInput(Action<CustomTextMaskInputArgs>, Object) | Allows you to manually control user edits, and modify them according to your custom logic. |
| EnableNonMaskedInput() | |
| EndInit() | Notifies the editor that the initialization has been completed. Inherited from RepositoryItem. |
| EndUpdate() | Unlocks the RepositoryItem object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from RepositoryItem. |
| 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. |
| GetBorderSides(Boolean, Boolean) static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetBrick(PrintCellHelperInfo) | Returns a brick object that contains information on how the current editor should be printed. |
| GetDisplayText(FormatInfo, Object) | Returns the text representation of the specified value, formatted according to the specified settings. Inherited from RepositoryItem. |
| GetDisplayText(Object) | Returns the text representation of the specified value formatted using the editor’s settings. Inherited from RepositoryItem. |
| GetEditorType() | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetEditValueForExportByOptions(Object, Object, Object, Object, Function3<String, Object, Object, Object>, ExportTarget) | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetHashCode() | Returns a hash code. Inherited from RepositoryItem. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetNormalizedText(String) static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| IsActivateKey(Keys) | Indicates whether a particular key can activate the editor used as an inplace control. Inherited from RepositoryItem. |
| IsLockDefaultImmediateUpdateRowPosition() | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| IsNeededKey(Keys) | Indicates whether the key is handled by the editor or the container control. Inherited from RepositoryItem. |
| LockEvents() | This method supports the .NET Framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem. |
| 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. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ResetEvents() | This member supports the .NET Framework infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| ResetMaskSettings() | Reverts all MaskSettings properties to their default values, and removes an active input mask. |
| ScaleProperties(ScaleHelper) | Updates the RepositoryItem according to current scale settings. This method is called automatically when the form’s runtime DPI settings differ from those in design-time. Inherited from RepositoryItem. |
| ShouldSerializeMaskSettings() | Tests whether the MaskSettings object should be serialized. This member supports the internal .NET infrastructure and does not need to be called from your code. |
| SwitchMode() | |
| ToString() | Returns a string that represents the current object. Inherited from RepositoryItem. |
| UnLockEvents() | This method supports the .NET Framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem. |
Events
| Name | Description |
|---|---|
| BeforeShowMenu | Occurs before the editor’s context menu is displayed. |
| Click | Fires when clicking the editor. Inherited from RepositoryItem. |
| CustomDisplayText | Enables custom display text to be provided for an editor. Inherited from RepositoryItem. |
| CustomHighlightText | Allows you to highlight or custom paint strings within the control’s text. This event is supported in Advanced mode (see RepositoryItemTextEdit.UseAdvancedMode). |
| CustomizeAutoCompleteSource |
Allows you to dynamically supply custom auto-complete text suggestions each time a user types a new word in the text box. This event is in effect in advanced mode when the AutoCompleteSource option is set to CustomSource, and the AutoCompleteMode option is set to SuggestSingleWord.
|
| CustomTextLineHeight | Allows you to specify the height of a line of text in Advanced Mode. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| DoubleClick | Fires when the editor is double clicked. Inherited from RepositoryItem. |
| DragDrop | Fires when an object is dropped onto the editor. Inherited from RepositoryItem. |
| DragEnter | Fires when a dragged object enters the editor’s area. Inherited from RepositoryItem. |
| DragLeave | Fires when a dragged object leaves the editor’s area. Inherited from RepositoryItem. |
| DragOver | Fires repeatedly when dragging an object over the editor. Inherited from RepositoryItem. |
| EditValueChanged | Fires when the editor’s EditValue property changes. Inherited from RepositoryItem. |
| EditValueChanging | Fires when the editor’s value is about to be changed. Inherited from RepositoryItem. |
| Enter | Fires when the editor receives focus. Inherited from RepositoryItem. |
| FormatEditValue | Enables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). Inherited from RepositoryItem. |
| GiveFeedback | Enables you to specify the cursor appearance when dragging this editor’s data. Inherited from RepositoryItem. |
| HelpRequested | Fires when the end-user requests help for the editor. Inherited from RepositoryItem. |
| KeyDown | Fires when a key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyPress | Fires when a character key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyUp | Fires when a key is released while the editor has focus. Inherited from RepositoryItem. |
| Leave | Fires when the editor loses focus. Inherited from RepositoryItem. |
| Modified | Fires when the edit value is first changed since it was last validated. Inherited from RepositoryItem. |
| MouseDown | Fires when a mouse button is pressed while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseEnter | Fires when the mouse pointer enters the editor’s area. Inherited from RepositoryItem. |
| MouseHover | Fires when hot-tracking an editor element. Inherited from RepositoryItem. |
| MouseLeave | Fires when the mouse pointer leaves the editor’s area. Inherited from RepositoryItem. |
| MouseMove | Fires when the mouse pointer moves over the editor’s area. Inherited from RepositoryItem. |
| MouseUp | Fires when the mouse button is released while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseWheel | Fires when the mouse wheel moves while the mouse pointer is within the editor. Inherited from RepositoryItem. |
| ParseEditValue | Converts an input value (entered by a user or assigned in code) to the value that the editor will store. Inherited from RepositoryItem. |
| PropertiesChanged | Fires immediately after a change to one of the editor’s properties. Inherited from RepositoryItem. |
| QueryAccessibilityHelp | Fires when the help is provided to accessibility applications. Inherited from RepositoryItem. |
| QueryContinueDrag | Fires when dragging the editor’s data allowing you to specify whether dragging should be continued. Inherited from RepositoryItem. |
| QueryProcessKey | Provides the capability 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 RepositoryItem. |
| Spin | Occurs when either the UP or DOWN ARROW key is pressed or the mouse wheel is rotated. |
| Validating | Allows you to specify whether the edit value is valid. This event does not occur if the editor’s CausesValidation property is disabled. Inherited from RepositoryItem. |
See Also