Skip to content

Properly restore focus when TabControl.SelectedIndex is set via DialogHost #3104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Keboo merged 11 commits into from
Feb 28, 2023
Merged

Properly restore focus when TabControl.SelectedIndex is set via DialogHost #3104

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c80a75e
Add sample project reproducing the issue
nicolaihenriksen Feb 25, 2023
b5031fb
"Hacky fix" to showcase what the root cause is
nicolaihenriksen Feb 25, 2023
0182649
Remove hacky fix
nicolaihenriksen Feb 27, 2023
6cb4c8b
Add failing UI test
nicolaihenriksen Feb 27, 2023
648ca20
Revert sample project commit; now replaced by UI test
nicolaihenriksen Feb 27, 2023
b39b73a
Add RestoreFocusElement DP to make test run green
nicolaihenriksen Feb 27, 2023
3d5e3eb
Add failing UI test for "disable" scenario
nicolaihenriksen Feb 27, 2023
64764d8
Add DialogHost.IsFocusRestoreDisabled DP to opt. disable focus restore
nicolaihenriksen Feb 27, 2023
adf82e2
Rename DP to DialogHost.IsRestoreFocusDisabled
nicolaihenriksen Feb 28, 2023
bb51d40
Add UI tests for navigation rail
nicolaihenriksen Feb 28, 2023
deeb97a
Region rephrase
nicolaihenriksen Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add DialogHost.IsFocusRestoreDisabled DP to opt. disable focus restore
  • Loading branch information
@nicolaihenriksen
nicolaihenriksen committed Feb 27, 2023
commit 64764d87fb263274dbf118645ef5017f11e1f31d
2 changes: 1 addition & 1 deletion MaterialDesignThemes.UITests/Samples/DialogHost/RestoreFocusNoOverride.xaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</UserControl.Resources>

<Grid>
<materialDesign:DialogHost x:Name="DialogHost">
<materialDesign:DialogHost x:Name="DialogHost" IsFocusRestoreDisabled="True">
<Grid>
<Grid.RowDefinitions>
<RowDefinition Height="Auto" />
Expand Down
28 changes: 22 additions & 6 deletions MaterialDesignThemes.Wpf/DialogHost.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,13 +367,16 @@ private static void IsOpenPropertyChangedCallback(DependencyObject dependencyObj

dialogHost.CurrentSession = new DialogSession(dialogHost);
var window = Window.GetWindow(dialogHost);
dialogHost._restoreFocusDialogClose = window != null ? FocusManager.GetFocusedElement(window) : null;

// Check restore focus overrides and optional disabling
if (dialogHost._restoreFocusDialogClose is DependencyObject dependencyObj &&
GetRestoreFocusElement(dependencyObj) is { } focusOverride)
if (!dialogHost.IsFocusRestoreDisabled)
{
dialogHost._restoreFocusDialogClose = focusOverride;
dialogHost._restoreFocusDialogClose = window != null ? FocusManager.GetFocusedElement(window) : null;

// Check restore focus overrides
if (dialogHost._restoreFocusDialogClose is DependencyObject dependencyObj &&
GetRestoreFocusElement(dependencyObj) is { } focusOverride)
{
dialogHost._restoreFocusDialogClose = focusOverride;
}
}

//multiple ways of calling back that the dialog has opened:
Expand Down Expand Up @@ -609,6 +612,8 @@ public override void OnApplyTemplate()
base.OnApplyTemplate();
}

#region focus restore properties

public static readonly DependencyProperty RestoreFocusElementProperty = DependencyProperty.RegisterAttached(
"RestoreFocusElement", typeof(IInputElement), typeof(DialogHost), new PropertyMetadata(default(IInputElement)));

Expand All @@ -618,6 +623,17 @@ public static void SetRestoreFocusElement(DependencyObject element, IInputElemen
public static IInputElement GetRestoreFocusElement(DependencyObject element)
=> (IInputElement) element.GetValue(RestoreFocusElementProperty);

public static readonly DependencyProperty IsFocusRestoreDisabledProperty = DependencyProperty.Register(
nameof(IsFocusRestoreDisabled), typeof(bool), typeof(DialogHost), new PropertyMetadata(false));

public bool IsFocusRestoreDisabled
{
get => (bool) GetValue(IsFocusRestoreDisabledProperty);
set => SetValue(IsFocusRestoreDisabledProperty, value);
}

#endregion

#region open dialog events/callbacks

public static readonly RoutedEvent DialogOpenedEvent =
Expand Down