【実務・中級編】【初心者向け】VB.NETのWPFにおけるToolTipとAdornerの活用:操作ミスを防ぐ親切な入力ガイドとヘルプ表示 – Visual Basic (VB / VB.NET)解析バイブル

スポンサーリンク
スポンサーリンク

防御的UI設計の極意:ToolTipとAdornerで「誤入力をさせない」プロフェッショナルな業務画面を構築する

業務アプリケーションの開発において、最もコストがかかるのは「バグの修正」ではない。「ユーザーの誤入力に起因するデータの不整合を、いかにして防ぐか」という設計の欠如だ。

初心者のエンジニアは、ユーザーが間違えた後に「入力内容が正しくありません」とメッセージボックスを出す。だが、それはすでに遅い。プロのアーキテクトは、ユーザーが間違えようとした瞬間に、視覚的なガイドを与えて軌道修正させる。

本記事では、WPF(Windows Presentation Foundation)における2つの強力な武器、`ToolTip`の高度な活用と、レイアウトを破壊しない視覚装飾術`Adorner`(アドナー)について、その設計思想と実装方法を伝授する。

1. ToolTipの真価:単なる説明文から「動的な検証フィードバック」へ

多くの開発者は、`ToolTip`を「マウスを乗せた時に出る補足説明」程度にしか考えていない。しかし、業務システムにおけるToolTipの真の役割は、「入力コンテキストに応じた動的なヒントの提示」である。

非効率な設計 vs プロフェッショナルな設計

  • 非効率な設計: 全てのTextBoxに「半角数字を入力してください」という固定のToolTipを貼る。これは情報のノイズであり、ユーザーは次第に無視するようになる。
  • プロフェッショナルな設計: 入力値がバリデーション(検証)に失敗した時だけ、「なぜ失敗したのか」という具体的な理由をToolTipとして表示する。

実装例:エラー内容を動的に表示するToolTip

WPFの強力な機能である `Validation.ErrorTemplate` と組み合わせることで、エラー時にのみ詳細な情報を表示する実装が可能だ。

# XAML: エラー時に赤い枠とToolTipを表示するスタイル

<Window.Resources>
    <!-- エラー時に表示するテンプレートの定義 -->
    <ControlTemplate x:Key="ErrorAdornerTemplate">
        <StackPanel>
            <!-- 入力コントロール本体 -->
            <AdornedElementPlaceholder x:Name="controlPlaceholder"/>
            <!-- エラー時に表示する赤い枠(Adornerの一種として機能) -->
            <Border BorderBrush="Red" BorderThickness="2" CornerRadius="2" 
                    IsHitTestVisible="False" VerticalAlignment="Stretch" HorizontalAlignment="Stretch"/>
        </StackPanel>
    </ControlTemplate>

    <!-- TextBox用の共通スタイル -->
    <Style x:Key="SmartInputStyle" TargetType="TextBox">
        <Setter Property="Margin" Value="5"/>
        <Setter Property="VerticalContentAlignment" Value="Center"/>
        <!-- バリデーションエラーが発生した際の見た目を設定 -->
        <Setter Property="Validation.ErrorTemplate" Value="{StaticResource ErrorAdornerTemplate}"/>
        <Style.Triggers>
            <!-- エラーがある場合、ToolTipにエラーメッセージをバインドする -->
            <Trigger Property="Validation.HasError" Value="true">
                <Setter Property="ToolTip" 
                        Value="{Binding RelativeSource={RelativeSource Self}, 
                        Path=(Validation.Errors)[0].ErrorContent}"/>
            </Trigger>
        </Style.Triggers>
    </Style>
</Window.Resources>

<StackPanel Margin="20">
    <Label Content="商品コード (例: ABC-123)"/>
    <!-- ValidationRuleを適用したTextBox -->
    <TextBox Style="{StaticResource SmartInputStyle}" Name="txtProductCode">
        <TextBox.Text>
            <Binding Path="ProductCode" UpdateSourceTrigger="PropertyChanged">
                <Binding.ValidationRules>
                    <!-- ここにカスタムの検証ルールを投入する -->
                    <local:ProductCodeValidationRule/>
                </Binding.ValidationRules>
            </Binding>
        </TextBox.Text>
    </TextBox>
</StackPanel>

2. Adorner(アドナー)の掌握:レイアウトを破壊しない「視覚的介入」

次に、`Adorner`について解説する。業務画面で「ここが重要です」「入力待ちです」と強調したい時、初心者はコントロールの`Background`の色を変えたり、隣に`TextBlock`を配置しようとする。

これは極めて悪質な設計だ。

背景色を変えると、色のコントラスト比の問題で視認性が落ちる可能性がある。また、隣に要素を追加すれば、既存のコントロールのレイアウト(位置やサイズ)がズレてしまう。

`Adorner`は、「コントロールのレイアウト計算(Measure/Arrange)に一切干渉せず、その上に浮いたレイヤーとして描画する」という、極めて高度でクリーンな仕組みだ。

実装例:入力エラー時に「警告アイコン」を浮かび上がらせるAdorner

以下に、コントロールの右上に「!」マークを浮かび上がらせるカスタムAdornerの実装を示す。

# VB.NET: カスタムAdornerのロジック

Imports System.Windows
Imports System.Windows.Documents
Imports System.Windows.Media

''' <summary>
''' コントロールの右上に警告アイコンを表示するアドナー
''' </summary>
Public Class WarningAdorner
    Inherits Adorner

    Private _iconBrush As Brush = Brushes.Red

    Public Sub New(adornedElement As UIElement)
        MyBase.New(adornedElement)
    End Sub

    ''' <summary>
    ''' 描画処理。コントロールのレイアウトには影響を与えない。
    ''' </summary>
    Protected Overrides Sub OnRender(drawingContext As DrawingContext)
        ' 描画対象の要素を取得
        Dim adornedElement = TryCast(AdornedElement, UIElement)
        If adornedElement Is Nothing Then Return

        ' アイコンのサイズと位置を計算(右上に配置)
        Dim iconSize As Double = 16
        Dim x As Double = adornedElement.ActualWidth - iconSize
        Dim y As Double = 0

        ' 警告アイコン(円と!マーク)を描画
        drawingContext.DrawEllipse(Brushes.Red, New Pen(Brushes.White, 1), 
                                   New Point(x + 8, y + 8), 8, 8)
        
        ' テキストの描画(簡易的な「!」)
        Dim text As New FormattedText("!", 
                                      System.Globalization.CultureInfo.CurrentCulture,
                                      FlowDirection.LeftToRight,
                                      New Typeface("Segoe UI"),
                                      12, Brushes.White, 1.0)
        
        drawingContext.DrawText(text, New Point(x + 5, y + 2))
    End Sub
End Class

# VB.NET: Adornerを呼び出す制御ロジック

実際にどのタイミングでAdornerを表示するかは、コードビハインドまたはBehaviorで行う。

''' <summary>
''' 指定した要素に警告アドナーを付加するメソッド
''' </summary>
Public Sub ShowWarning(target As UIElement)
    Dim layer As AdornerLayer = AdornerLayer.GetAdornerLayer(target)
    If layer IsNot Nothing Then
        ' 既に表示されている場合は重複させない設計が重要
        Dim existing = layer.GetAdorners(target).OfType(Of WarningAdorner)().FirstOrDefault()
        If existing Is Nothing Then
            layer.Add(New WarningAdorner(target))
        End If
    End If
End Sub

''' <summary>
''' アドナーを解除するメソッド
''' </summary>
Public Sub ClearWarning(target As UIElement)
    Dim layer As AdornerLayer = AdornerLayer.GetAdornerLayer(target)
    If layer IsNot Nothing Then
        Dim existing = layer.GetAdorners(target).OfType(Of WarningAdorner)().FirstOrDefault()
        If existing IsNot Nothing Then
            layer.Remove(existing)
        End If
    End If
End Sub

3. プロダクションレベルでの注意点:アーキテクトの視点

これらを実務に投入する際、多くのエンジニアが陥る落とし穴がある。設計段階で以下の3点を必ず考慮せよ。

① メモリリークの防止(Lifecycle Management)

`Adorner`は`AdornerLayer`という特殊な階層に紐付く。コントロールが破棄(Unload)される際、アドナーが適切に解除されないと、参照が残り続け、メモリリークの原因となる。

  • 対策: `Unloaded` イベントなどで、必ず `layer.Remove()` を呼び出すか、アドナーのライフサイクルをコントロールのライフサイクルと同期させる設計にせよ。

② 描画パフォーマンス(Drawing Overhead)

`OnRender` 内で重い計算(複雑な画像処理やフォントの動的生成など)を行うことは厳禁だ。`OnRender` は、描画が必要になるたびに呼び出される。

  • 対策: 描画に必要なリソース(ブラシやペン)は、コンストラクタで生成し、使い回せ。

③ データ整合性とUIの分離(MVVMの遵守)

「エラーだから赤くする」というロジックを、View(コードビハインド)に書きすぎると、ユニットテストが不可能になる。

  • 対策: 「エラー状態であるかどうか」という状態(State)はViewModelが持ち、Viewはその状態を見て、ToolTipを表示するか、Adornerを呼び出すかを判断する、という責務の分離を徹底せよ。

まとめ

優れた業務アプリケーションは、ユーザーを「叱る」のではなく、「導く」ものだ。

  • ToolTip は、単なる説明ではなく、「エラーの文脈を伝える通信手段」として使え。
  • Adorner は、レイアウトを壊さず、「ユーザーの視線を誘導する非侵襲的なガイド」として使え。

この使い分けができるようになれば、君が作るツールは「単なる入力フォーム」から、「プロフェッショナルな業務支援システム」へと昇華する。

タイトルとURLをコピーしました