wpf - 読み取り専用の GUI プロパティを ViewModel にプッシュする

Question

ビューからのいくつかの読み取り専用の依存関係プロパティの現在の状態を常に認識しているビューモデルを作成したいと考えています。

具体的には、私の GUI には、FlowDocument から一度に 1 ページを表示する FlowDocumentPageViewer が含まれています。FlowDocumentPageViewer は、CanGoToPreviousPage と CanGoToNextPage という 2 つの読み取り専用の依存関係プロパティを公開します。ViewModel がこれら 2 つの View プロパティの値を常に認識できるようにします。

私は OneWayToSource データバインディングでこれを行うことができると考えました:

<FlowDocumentPageViewer
    CanGoToNextPage="{Binding NextPageAvailable, Mode=OneWayToSource}" ...>

これが許可されていれば完璧です。FlowDocumentPageViewer の CanGoToNextPage プロパティが変更されるたびに、新しい値が ViewModel の NextPageAvailable プロパティにプッシュダウンされます。これはまさに私が望んでいることです。

残念ながら、これはコンパイルされません。「CanGoToPreviousPage」プロパティは読み取り専用であり、マークアップから設定できないというエラーが表示されます。どうやら読み取り専用プロパティは、そのプロパティに関して読み取り専用のデータバインディングでさえも、いかなる種類のデータバインディングもサポートしていません。

ViewModel のプロパティを DependencyProperties にして、OneWay バインディングを別の方法で作成することもできますが、懸念事項の分離違反に夢中になっているわけではありません (ViewModel には View への参照が必要であり、MVVM データバインディングでは回避する必要があります)。）。

FlowDocumentPageViewer は CanGoToNextPageChanged イベントを公開しません。別の DependencyProperty を作成してバインドする以外に、DependencyProperty から変更通知を取得する良い方法がわかりません。

ビューの読み取り専用プロパティの変更を ViewModel に通知するにはどうすればよいですか?

score 162 · Accepted Answer

はい、過去にActualWidthとActualHeightプロパティを使用してこれを実行しましたが、どちらも読み取り専用です。ObservedWidthおよびObservedHeight添付プロパティを持つ添付ビヘイビアを作成しました。またObserve、初期接続を行うために使用されるプロパティもあります。使用法は次のようになります。

<UserControl ...
    SizeObserver.Observe="True"
    SizeObserver.ObservedWidth="{Binding Width, Mode=OneWayToSource}"
    SizeObserver.ObservedHeight="{Binding Height, Mode=OneWayToSource}"

そのため、ビューモデルにはWidthおよび添付プロパティHeightと常に同期するおよびプロパティがObservedWidthあります。ObservedHeightプロパティは、単にのイベントにObserveアタッチされます。ハンドルでは、プロパティを更新します。したがって、ビューモデルのとは常にのと同期しています。SizeChangedFrameworkElementObservedWidthObservedHeightWidthHeightActualWidthActualHeightUserControl

おそらく完璧な解決策ではありません (同意します - 読み取り専用 DPはバインディングをサポートする必要OneWayToSourceがあります) が、動作し、MVVM パターンを支持します。明らかに、ObservedWidthおよびObservedHeightDP は読み取り専用ではありません。

更新: 上記の機能を実装するコードは次のとおりです。

public static class SizeObserver
{
    public static readonly DependencyProperty ObserveProperty = DependencyProperty.RegisterAttached(
        "Observe",
        typeof(bool),
        typeof(SizeObserver),
        new FrameworkPropertyMetadata(OnObserveChanged));

    public static readonly DependencyProperty ObservedWidthProperty = DependencyProperty.RegisterAttached(
        "ObservedWidth",
        typeof(double),
        typeof(SizeObserver));

    public static readonly DependencyProperty ObservedHeightProperty = DependencyProperty.RegisterAttached(
        "ObservedHeight",
        typeof(double),
        typeof(SizeObserver));

    public static bool GetObserve(FrameworkElement frameworkElement)
    {
        frameworkElement.AssertNotNull("frameworkElement");
        return (bool)frameworkElement.GetValue(ObserveProperty);
    }

    public static void SetObserve(FrameworkElement frameworkElement, bool observe)
    {
        frameworkElement.AssertNotNull("frameworkElement");
        frameworkElement.SetValue(ObserveProperty, observe);
    }

    public static double GetObservedWidth(FrameworkElement frameworkElement)
    {
        frameworkElement.AssertNotNull("frameworkElement");
        return (double)frameworkElement.GetValue(ObservedWidthProperty);
    }

    public static void SetObservedWidth(FrameworkElement frameworkElement, double observedWidth)
    {
        frameworkElement.AssertNotNull("frameworkElement");
        frameworkElement.SetValue(ObservedWidthProperty, observedWidth);
    }

    public static double GetObservedHeight(FrameworkElement frameworkElement)
    {
        frameworkElement.AssertNotNull("frameworkElement");
        return (double)frameworkElement.GetValue(ObservedHeightProperty);
    }

    public static void SetObservedHeight(FrameworkElement frameworkElement, double observedHeight)
    {
        frameworkElement.AssertNotNull("frameworkElement");
        frameworkElement.SetValue(ObservedHeightProperty, observedHeight);
    }

    private static void OnObserveChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs e)
    {
        var frameworkElement = (FrameworkElement)dependencyObject;

        if ((bool)e.NewValue)
        {
            frameworkElement.SizeChanged += OnFrameworkElementSizeChanged;
            UpdateObservedSizesForFrameworkElement(frameworkElement);
        }
        else
        {
            frameworkElement.SizeChanged -= OnFrameworkElementSizeChanged;
        }
    }

    private static void OnFrameworkElementSizeChanged(object sender, SizeChangedEventArgs e)
    {
        UpdateObservedSizesForFrameworkElement((FrameworkElement)sender);
    }

    private static void UpdateObservedSizesForFrameworkElement(FrameworkElement frameworkElement)
    {
        // WPF 4.0 onwards
        frameworkElement.SetCurrentValue(ObservedWidthProperty, frameworkElement.ActualWidth);
        frameworkElement.SetCurrentValue(ObservedHeightProperty, frameworkElement.ActualHeight);

        // WPF 3.5 and prior
        ////SetObservedWidth(frameworkElement, frameworkElement.ActualWidth);
        ////SetObservedHeight(frameworkElement, frameworkElement.ActualHeight);
    }
}

score 64 · Accepted Answer

ActualWidth と ActualHeight だけでなく、少なくとも読み取りモードでバインドできるデータでも機能するユニバーサルソリューションを使用します。

ViewportWidth と ViewportHeight がビューモデルのプロパティである場合、マークアップは次のようになります。

<Canvas>
    <u:DataPiping.DataPipes>
         <u:DataPipeCollection>
             <u:DataPipe Source="{Binding RelativeSource={RelativeSource AncestorType={x:Type Canvas}}, Path=ActualWidth}"
                         Target="{Binding Path=ViewportWidth, Mode=OneWayToSource}"/>
             <u:DataPipe Source="{Binding RelativeSource={RelativeSource AncestorType={x:Type Canvas}}, Path=ActualHeight}"
                         Target="{Binding Path=ViewportHeight, Mode=OneWayToSource}"/>
          </u:DataPipeCollection>
     </u:DataPiping.DataPipes>
<Canvas>

カスタム要素のソースコードは次のとおりです。

public class DataPiping
{
    #region DataPipes (Attached DependencyProperty)

    public static readonly DependencyProperty DataPipesProperty =
        DependencyProperty.RegisterAttached("DataPipes",
        typeof(DataPipeCollection),
        typeof(DataPiping),
        new UIPropertyMetadata(null));

    public static void SetDataPipes(DependencyObject o, DataPipeCollection value)
    {
        o.SetValue(DataPipesProperty, value);
    }

    public static DataPipeCollection GetDataPipes(DependencyObject o)
    {
        return (DataPipeCollection)o.GetValue(DataPipesProperty);
    }

    #endregion
}

public class DataPipeCollection : FreezableCollection<DataPipe>
{

}

public class DataPipe : Freezable
{
    #region Source (DependencyProperty)

    public object Source
    {
        get { return (object)GetValue(SourceProperty); }
        set { SetValue(SourceProperty, value); }
    }
    public static readonly DependencyProperty SourceProperty =
        DependencyProperty.Register("Source", typeof(object), typeof(DataPipe),
        new FrameworkPropertyMetadata(null, new PropertyChangedCallback(OnSourceChanged)));

    private static void OnSourceChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        ((DataPipe)d).OnSourceChanged(e);
    }

    protected virtual void OnSourceChanged(DependencyPropertyChangedEventArgs e)
    {
        Target = e.NewValue;
    }

    #endregion

    #region Target (DependencyProperty)

    public object Target
    {
        get { return (object)GetValue(TargetProperty); }
        set { SetValue(TargetProperty, value); }
    }
    public static readonly DependencyProperty TargetProperty =
        DependencyProperty.Register("Target", typeof(object), typeof(DataPipe),
        new FrameworkPropertyMetadata(null));

    #endregion

    protected override Freezable CreateInstanceCore()
    {
        return new DataPipe();
    }
}

score 20 · Accepted Answer

他の誰かが興味を持っている場合は、ここでケントのソリューションの近似値をコード化しました。

class SizeObserver
{
    #region " Observe "

    public static bool GetObserve(FrameworkElement elem)
    {
        return (bool)elem.GetValue(ObserveProperty);
    }

    public static void SetObserve(
      FrameworkElement elem, bool value)
    {
        elem.SetValue(ObserveProperty, value);
    }

    public static readonly DependencyProperty ObserveProperty =
        DependencyProperty.RegisterAttached("Observe", typeof(bool), typeof(SizeObserver),
        new UIPropertyMetadata(false, OnObserveChanged));

    static void OnObserveChanged(
      DependencyObject depObj, DependencyPropertyChangedEventArgs e)
    {
        FrameworkElement elem = depObj as FrameworkElement;
        if (elem == null)
            return;

        if (e.NewValue is bool == false)
            return;

        if ((bool)e.NewValue)
            elem.SizeChanged += OnSizeChanged;
        else
            elem.SizeChanged -= OnSizeChanged;
    }

    static void OnSizeChanged(object sender, RoutedEventArgs e)
    {
        if (!Object.ReferenceEquals(sender, e.OriginalSource))
            return;

        FrameworkElement elem = e.OriginalSource as FrameworkElement;
        if (elem != null)
        {
            SetObservedWidth(elem, elem.ActualWidth);
            SetObservedHeight(elem, elem.ActualHeight);
        }
    }

    #endregion

    #region " ObservedWidth "

    public static double GetObservedWidth(DependencyObject obj)
    {
        return (double)obj.GetValue(ObservedWidthProperty);
    }

    public static void SetObservedWidth(DependencyObject obj, double value)
    {
        obj.SetValue(ObservedWidthProperty, value);
    }

    // Using a DependencyProperty as the backing store for ObservedWidth.  This enables animation, styling, binding, etc...
    public static readonly DependencyProperty ObservedWidthProperty =
        DependencyProperty.RegisterAttached("ObservedWidth", typeof(double), typeof(SizeObserver), new UIPropertyMetadata(0.0));

    #endregion

    #region " ObservedHeight "

    public static double GetObservedHeight(DependencyObject obj)
    {
        return (double)obj.GetValue(ObservedHeightProperty);
    }

    public static void SetObservedHeight(DependencyObject obj, double value)
    {
        obj.SetValue(ObservedHeightProperty, value);
    }

    // Using a DependencyProperty as the backing store for ObservedHeight.  This enables animation, styling, binding, etc...
    public static readonly DependencyProperty ObservedHeightProperty =
        DependencyProperty.RegisterAttached("ObservedHeight", typeof(double), typeof(SizeObserver), new UIPropertyMetadata(0.0));

    #endregion
}

アプリで自由に使用してください。それはうまくいきます。（ありがとうケント！）

score 10 · Accepted Answer

ここでブログを書いたこの「バグ」の別の解決策を次に示します。
ReadOnly 依存関係プロパティの OneWayToSource Binding

これは、Listener と Mirror という 2 つの Dependency Properties を使用して機能します。リスナーは、TargetProperty に OneWay でバインドされ、PropertyChangedCallback で、Binding で指定されたものに OneWayToSource にバインドされた Mirror プロパティを更新します。私はそれを呼び出し、PushBindingこのように読み取り専用の依存関係プロパティに設定できます

<TextBlock Name="myTextBlock"
           Background="LightBlue">
    <pb:PushBindingManager.PushBindings>
        <pb:PushBinding TargetProperty="ActualHeight" Path="Height"/>
        <pb:PushBinding TargetProperty="ActualWidth" Path="Width"/>
    </pb:PushBindingManager.PushBindings>
</TextBlock>

デモプロジェクトはこちらからダウンロードしてください。
ソースコードと短いサンプルの使用法が含まれています。

最後に 1 つ注意してください。.NET 4.0 以降、 OneWayToSource Binding は更新後に Source から値を読み取るため、これに対する組み込みサポートからさらに遠ざかっています。

score 5 · Accepted Answer

ドミトリー・タシキノフのソリューションが好きです！ただし、デザインモードで VS がクラッシュしました。そのため、OnSourceChanged メソッドに次の行を追加しました。

    private static void OnSourceChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        if (!((bool)DesignerProperties.IsInDesignModeProperty.GetMetadata(typeof(DependencyObject)).DefaultValue))
            ((DataPipe)d).OnSourceChanged(e);
    }

wpf - 読み取り専用の GUI プロパティを ViewModel にプッシュする

6 に答える 6

Related

Reference