RepositoryItemTextEdit.AdvancedModeOptions Property

Gets Advanced Mode options.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Appearance")]
public TextEditAdvancedModeOptions AdvancedModeOptions { get; }

VB.NET

<DXCategory("Appearance")>
Public ReadOnly Property AdvancedModeOptions As TextEditAdvancedModeOptions

Property Value

Type	Description
TextEditAdvancedModeOptions	Advanced Mode options.

Remarks

Activate the RepositoryItemTextEdit.UseAdvancedMode property to switch the editor to Advanced Mode.

Use the AdvancedModeOptions property to customize Advanced Mode features.

C#

// Enable Advanced Mode
textEdit1.Properties.UseAdvancedMode = DefaultBoolean.True;
// Enable caret animation
textEdit1.Properties.AdvancedModeOptions.AllowCaretAnimation = DefaultBoolean.True;
// Animate selection
textEdit1.Properties.AdvancedModeOptions.AllowSelectionAnimation = DefaultBoolean.True;
// Set selection color
textEdit1.Properties.AdvancedModeOptions.SelectionColor = Color.Yellow;

VB.NET

' Enable Advanced Mode
textEdit1.Properties.UseAdvancedMode = DefaultBoolean.[True]
' Enable caret animation
textEdit1.Properties.AdvancedModeOptions.AllowCaretAnimation = DefaultBoolean.[True]
' Animate selection
textEdit1.Properties.AdvancedModeOptions.AllowSelectionAnimation = DefaultBoolean.[True]
' Set selection color
textEdit1.Properties.AdvancedModeOptions.SelectionColor = Color.Yellow

Features

Advanced Mode activates the following features:

Caret and Selection Animations

The redesigned control painter enables more responsive and smooth animations.

To disable these effects, use AdvancedModeOptions.AllowCaretAnimation and AdvancedModeOptions.AllowSelectionAnimation properties.

Themed Selection Color

The selection color depends on the current application skin.

Text Autocompletion

The autocomplete functionality displays suggestions to complete words that a user types in a text editor.

Use the AutoCompleteMode property to enable the autocomplete functionality. You can choose one of the following options:

• Suggest - The editor displays a drop-down list with suggestions when a user types the first word in the edit box.

  

• Append - The editor automatically completes the first entered word in the edit box. The editor uses the first matching suggestion from a source of suggestions.

  

• SuggestAppend - The editor uses a combination of the Append and Suggest options — it automatically completes the first word in the edit box, and displays a drop-down list with suggestions.

  

• SuggestSingleWord - The editor displays a drop-down list with custom suggestions every time a user types a new word in the edit box. The editor automatically sets the AutoCompleteSource option to CustomSource in SuggestSingleWord mode. Use the CustomizeAutoCompleteSource event, or AutoCompleteCustomSource collection to specify the custom auto-complete suggestions.

  Note

  Only alphanumeric characters are considered “words”. Special characters (other than the hyphen) are considered “word separators”.

  

Use the AutoCompleteSource property to specify the source of autocomplete strings. To supply custom autocomplete strings, set the AutoCompleteSource property to CustomSource, then handle the CustomizeAutoCompleteSource event or populate the TextEditAdvancedModeOptions.AutoCompleteCustomSource collection.

You can use ShowAutoCompletePopup() and CloseAutoCompletePopup() methods to control the visibility of the drop-down list with autocomplete suggestions.

Embedded Labels

Set the AdvancedModeOptions.Label property to display an editor caption inside the text box. This caption moves upward when the editor is focused.

Use the AdvancedModeOptions.LabelAppearance property to customize appearance settings of the embedded label (caption).

Note that to accommodate both an embedded label and its input value, the editor increases its height.

Emoji Support

Users can press “Win+.“ to enter emojis from the Windows library. If the AdvancedModeOptions.UseDirectXPaint property is disabled, emojis are grayed out.

Custom Text Highlighting and Painting

You can handle the TextEdit.CustomHighlightText (or RepositoryItemTextEdit.CustomHighlightText) event to highlight or paint specific strings within the control’s text in a custom manner:

• Highlight strings with custom foreground and background colors.
• Add padding for text blocks.
• Specify a painter that draws text using a custom font.
• Specify a painter that replaces strings with custom graphics (for example, icons or emojis).

Run Demo: Memo Edit

Disable Keyboard Shortcuts

Set the TextEditAdvancedModeOptions.ShortcutsEnabled property to false to disable all keyboard shortcuts within the editor.

WXI Skin

The WXI vector skin utilizes Advanced Mode to paint rounded editor corners and color accents. Advanced Mode cannot be disabled while this skin is active.

Important

In Advanced Mode or when the WXI Skin is applied, use the Appearance.BackColor property to specify the editor’s background color. Other appearance settings that specify the background color of the editor in different states are ignored (for example, the AppearanceReadOnly.BackColor, AppearanceFocused.BackColor, AppearanceDisabled.BackColor).

C#

if (textEdit1.Properties.ReadOnly) {
    textEdit1.Properties.Appearance.BackColor = Color.LightGray;
}

VB.NET

If textEdit1.Properties.ReadOnly Then
    textEdit1.Properties.Appearance.BackColor = Color.LightGray
End If

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AdvancedModeOptions property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-memo-editor-advanced-mode/CS/MemoEditSample/Views/DemoView.cs#L20

fluent.SetBinding(memoEdit.Properties, me => me.ScrollBars, x => x.ScrollBars);
fluent.SetBinding(memoEdit.Properties.AdvancedModeOptions, me => me.UseDirectXPaint, x => x.UseDirectXPaint);
fluent.SetBinding(memoEdit, me => me.EditValue, x => x.Text);

VB.NET

winforms-memo-editor-advanced-mode/VB/MemoEditSample/Views/DemoView.vb#L23

fluent.SetBinding(memoEdit.Properties, Function([me]) [me].ScrollBars, Function(x) x.ScrollBars)
fluent.SetBinding(memoEdit.Properties.AdvancedModeOptions, Function([me]) [me].UseDirectXPaint, Function(x) x.UseDirectXPaint)
fluent.SetBinding(memoEdit, Function([me]) [me].EditValue, Function(x) x.Text)