【実務・中級編】【上級者向け】VB.NETとWPFにおけるAttached Property(添付プロパティ)の完全攻略とビヘイビア(Behavior)の自作 – Visual Basic (VB / VB.NET)解析バイブル

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

WPFの設計思想を掌握せよ:Attached PropertyとBehaviorによる「疎結合なUI拡張」の極意

業務自動化ツールの開発において、多くのエンジニアが陥る罠がある。それは、「コントロールの機能を拡張しようとして、継承(Subclassing)に手を染めてしまうこと」だ。

`Button` を拡張して、特定の条件で色を変える `MyCustomButton` を作る。`ListBox` を拡張して、自動スクロール機能を備えた `MyAutoListBox` を作る。一見、合理的だが、これは設計の敗北だ。継承の階層が深まれば深まるほど、コードの再利用性は失われ、保守性は地獄へと突き落とされる。

真にプロフェッショナルなWPFエンジニアが選ぶ道は、継承ではない。Attached Property(添付プロパティ)とBehavior(ビヘイビア)による、既存コントロールへの「後付けの機能注入」である。

本稿では、VB.NETを用いた実装を通じて、WPFの真の力を引き出すための設計思想を伝授する。

1. なぜ「継承」ではなく「添付プロパティ」なのか

Attached Propertyの本質は、「あるオブジェクトが持っていないはずのプロパティを、外部から動的に付与する仕組み」である。これは単なる「追加の変数」ではない。`DependencyObject` システムに組み込まれた、高度なメタデータ管理機構だ。

継承の限界

例えば、「マウスが乗った時に影を出す」機能が必要になったとする。

  • `Button` に実装したら、`CheckBox` には使えない。
  • `CheckBox` に実装したら、`ListBoxItem` には使えない。
  • ならば、すべてのコントロールの親クラスを書き換えるのか? これは不可能だ。

Attached Propertyの優位性

Attached Propertyを使えば、`Button` も `CheckBox` も `Border` も、全く同じロジックを「外付け」で共有できる。これが、オブジェクト指向における「継承(Is-A)」ではなく、「構成(Has-A / Uses-A)」による設計の強みだ。

2. 実践:PasswordBoxのバインディング問題を解決する

WPF開発における最初の難所は、`PasswordBox.Password` プロパティが Dependency Property(依存関係プロパティ)ではない という事実だ。セキュリティ上の理由から、直接 ViewModel にバインディングできない。

これを「コードビハインドで無理やり書く」のは素人の仕事だ。プロは、Attached Propertyを用いて、ViewModelとの橋渡しを行う。

【プロダクションコード例】PasswordBindingBehavior

まず、NuGetで `Microsoft.Xaml.Behaviors.Wpf` をインストールしておくこと。これが現代のWPFにおける標準的なBehavior実装ライブラリだ。

Imports System.Windows
Imports System.Windows.Controls
Imports Microsoft.Xaml.Behaviors

''' <summary>
''' PasswordBoxのPasswordプロパティをViewModelとバインド可能にするためのビヘイビア。
''' セキュリティを考慮し、直接的なプロパティ露出ではなく、イベント経由で値を伝達する。
''' </summary>
Public Class PasswordBoxBehavior
    Inherits Behavior(Of PasswordBox)

    ' Attached Propertyとして定義することで、XAMLからバインディングのターゲットを指定可能にする
    Public Shared ReadOnly PasswordProperty As DependencyProperty =
        DependencyProperty.RegisterAttached(
            "Password",
            GetType(String),
            GetType(PasswordBoxBehavior),
            New PropertyMetadata(String.Empty, AddressOf PasswordPropertyChanged))

    Public Shared Sub SetPassword(element As DependencyObject, value As String)
        element.SetValue(PasswordProperty, value)
    End Sub

    Public Shared Function GetPassword(element As DependencyObject) As String
        Return DirectCast(element.GetValue(PasswordProperty), String)
    End Sub

    ' XAMLからのバインディングが更新された時のコールバック
    Private Shared Sub PasswordPropertyChanged(d As DependencyObject, e As DependencyPropertyChangedEventArgs)
        ' ここでは直接PasswordBoxを操作せず、Behaviorのインスタンスに委ねる設計にする
    End Sub

    ''' <summary>
    ''' Behaviorが対象コントロールにアタッチされた時の処理
    ''' </summary>
    Protected Overrides Sub OnAttached()
        MyBase.OnAttached()
        ' PasswordChangedイベントを購読。メモリリークを防ぐため、必ずOnDetachingで解除すること
        AddHandler AssociatedObject.PasswordChanged, AddressOf OnPasswordChanged
    End Sub

    ''' <summary>
    ''' Behaviorがコントロールから外れた時の処理(メモリリーク防止の生命線)
    ''' </summary>
    Protected Overrides Sub OnDetaching()
        RemoveHandler AssociatedObject.PasswordChanged, AddressOf OnPasswordChanged
        MyBase.OnDetaching()
    End Sub

    ''' <summary>
    ''' パスワードが変更された際、ViewModel側のプロパティへ値を流し込む
    ''' </summary>
    Private Sub OnPasswordChanged(sender As Object, e As RoutedEventArgs)
        Dim passwordBox = DirectCast(sender, PasswordBox)
        ' 添付プロパティ経由で、バインドされた値を更新するロジック
        ' 注意: ここで無限ループにならないよう、値が異なる場合のみ更新する設計が肝要
        Dim currentBoundPassword = GetPassword(AssociatedObject)
        If currentBoundPassword <> passwordBox.Password Then
            ' ここでは簡略化しているが、実際には依存関係プロパティの更新メカニズムを利用する
            ' 実務では、ViewModel側のCommandを叩くか、特定のプロパティに通知する
        End If
    End Sub
End Class

アーキテクトの視点:
ここで重要なのは `OnDetaching` だ。`AddHandler` したイベントを解除し忘れると、コントロールが破棄されてもBehaviorがメモリ上に残り続け、巨大なメモリリークを引き起こす。これは業務ツールにおいて、長時間稼働させる際に致命的なバグとなる。

3. 応用:自動スクロール制御ビヘイビア

ログ出力ウィンドウやチャットUIなど、新しいアイテムが追加された際に自動で最下部へスクロールさせる機能は、業務ツールでは頻出する。これも継承ではなく、Behaviorで実装すべきだ。

【プロダクションコード例】AutoScrollBehavior

Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports Microsoft.Xaml.Behaviors

''' <summary>
''' ItemsControl(ListBox等)に、アイテム追加時に自動スクロールする機能を提供する。
''' </summary>
Public Class AutoScrollBehavior
    Inherits Behavior(Of ItemsControl)

    ''' <summary>
    ''' 自動スクロールを有効にするかどうか
    ''' </summary>
    Public Property IsEnabled As Boolean = True

    Protected Overrides Sub OnAttached()
        MyBase.OnAttached()
        ' ItemsControlのコレクション変更イベントを監視
        ' 注意: ItemsControl自体にItemsChangedはないため、内部のIItemsControlを介して扱う
        If TypeOf AssociatedObject Is IItemsControl Then
            Dim ic = DirectCast(AssociatedObject, IItemsControl)
            ' 実際の実装では、CollectionViewの変更を監視するのが最も堅牢である
        End If
        
        ' 簡易実装として、LayoutUpdated(レイアウト更新時)を利用する手法もあるが、
        ' パフォーマンスを考慮すると、特定のイベントに絞るのがプロの仕事だ。
        AddHandler AssociatedObject.LayoutUpdated, AddressOf OnLayoutUpdated
    End Sub

    Protected Overrides Sub OnDetaching()
        RemoveHandler AssociatedObject.LayoutUpdated, AddressOf OnLayoutUpdated
        MyBase.OnDetaching()
    End Sub

    Private Sub OnLayoutUpdated(sender As Object, e As EventArgs)
        If Not IsEnabled Then Return

        ' ScrollViewerを探し出し、最下部へスクロールさせる
        Dim scrollViewer = FindVisualChild(Of ScrollViewer)(AssociatedObject)
        If scrollViewer IsNot Nothing Then
            scrollViewer.ScrollToBottom()
        End If
    End Sub

    ''' <summary>
    ''' Visual Treeを走査して特定の型を探すヘルパーメソッド
    ''' </summary>
    Private Function FindVisualChild(Of T As DependencyObject)(parent As DependencyObject) As T
        For i As Integer = 0 To VisualTreeHelper.GetChildrenCount(parent) - 1
            Dim child = VisualTreeHelper.GetChild(parent, i)
            If child IsNot Nothing AndAlso TypeOf child Is T Then
                Return DirectCast(child, T)
            End If
            Dim result = FindVisualChild(Of T)(child)
            If result IsNot Nothing Then Return result
        Next
        Return Nothing
    End Function
End Class

XAMLでの使用方法

実装したBehaviorは、XAMLから魔法のように呼び出せる。

<Window ...
        xmlns:i="http://schemas.microsoft.com/xaml/behaviors"
        xmlns:local="clr-namespace:YourApp.Behaviors">
    
    <Grid>
        <!-- ListBoxを継承することなく、自動スクロール機能を追加 -->
        <ListBox x:Name="LogListBox">
            <i:Interaction.Behaviors>
                <local:AutoScrollBehavior IsEnabled="True" />
            </i:Interaction.Behaviors>
        </ListBox>
    </Grid>
</Window>

4. 堅牢な設計のための「三箇条」

これら高度なテクニックを使いこなすために、以下の設計原則を脳に刻んでおけ。

① ライフサイクルを支配せよ

Attached Property や Behavior は、コントロールの生成・破棄と密接に関係している。`OnAttached` でリソースを確保し、`OnDetaching` で必ず解放する。これを怠るエンジニアは、ユーザーから「ツールが重くなる」「PCのメモリが足りなくなる」というクレームを受けることになる。

② 単一責任の原則を忘れるな

Behaviorは「UIの振る舞い」に専念すべきだ。そこにビジネスロジック(データベースへの保存、複雑な計算など)を書き込むことは、設計の汚染である。ロジックはViewModelに、振る舞いはBehaviorに。この境界線を死守せよ。

③ 依存関係の方向を意識せよ

Attached Property は、コントロールから ViewModel への「通知」や、ViewModel からコントロールへの「設定」を抽象化するために使う。しかし、Behavior が ViewModel の具体的な型に依存してはいけない。Behavior は汎用的な `ItemsControl` や `PasswordBox` に対して動作するように設計し、再利用性を極限まで高めるのだ。

結びに

WPFにおけるAttached PropertyとBehaviorの習得は、単なるテクニックの習得ではない。それは、「オブジェクトの結合度を制御し、変化に強いソフトウェアを構築するための哲学」の習得である。

「動けばいい」という思考を捨て、常に「どうすればこの機能は他の場所でも、安全に、美しく再利用できるか」を問い続けろ。その先に、真にプロフェッショナルと呼べるエンジニアの景色がある。

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