README.md

Update This code base hasn't been maintained for years since there is better library at https://github.com/fsprojects/FsXaml.

Introduction

This library is built as an alternative to use XAML in F#.

Nuget repository

Library is available at Nuget

Code Behind in F#

While FsXaml's Type Provider is useful and simple, it does not give ease to work with XAML compared with C#. I propose an alternative solution by following example. Suppose we have a "Hello, World!" XAML as a project Resource.

Sample.xaml

<Window xmlns="http://schemas.microsoft.com/netfx/2009/xaml/presentation">
  <StackPanel>
    <Label>Hello, world!</Label>
    <Button>Click me!</Button>
  </StackPanel>
</Window>

To declare type for this window with FsXaml Type Provider.

type MainWindow = FsXaml.XAML<"Sample.xaml">

But using this library, the declaration becomes following:

open System.Windows
open RZ.Wpf.CodeBehind

type MainWindow() as me =
  inherit Window()
  do me.InitializeCodeBehind("Sample.xaml")

It is longer, but it gives you flexibility to extend the control like in C# (e.g. make a User Control with custom properties).

Handle Routed Events (1.0.1)

Version 1.0.1 has introduced a way to handle routed events. This works between View Model, which is assigned to DataContext, and code behind (as the view logic). This design uses some idea from MVVM of FsXaml and FsXaml.ViewModel libraries.

Suppose that our sample XAML utilizes Command pattern.

Sample.xaml

<Window xmlns="http://schemas.microsoft.com/netfx/2009/xaml/presentation"
        xmlns:model="clr-namespace:Sample;assembly=Sample">
  <Window.DataContext>
    <model:MainWindowModel />
  </Window.DataContext>
  <StackPanel>
    <Label>Hello, world!</Label>
    <Button Command="Open" CommandParameter="http://google.com/">Click me!</Button>
  </StackPanel>
</Window>

Codebehind.fs

Here we create a view model and use it in the XAML. The model is a bridge between View and Model (or Controller).

namespace Sample
open System.Windows
open System.Windows.Input
open RZ.Wpf.CodeBehind

type MainWindowEvent =
| Help of string

type MainWindowModel() =
  let handler = function
    | Help url -> System.Diagnostics.Process.Start url |> ignore

  let mapper =
    [ ApplicationCommands.Open |> CommandMap.to' (fun p -> Help (p :?> string)) ]
    |> CommandControlCenter handler
    
  interface ICommandHandler with
    member __.ControlCenter = mapper

type MainWindow() as me =
  inherit Window()
  do me.InitializeCodeBehind("Sample.xaml")
  do me.InstallCommandForwarder()   // install command forwarder to `DataContext`'s ICommandHandler.

With this sample, when you click the button it will raise command Open which will be forward to ICommandHandler via DataContext. The ICommandHandler will return command handler which, in this case, is created by pre-defined function in the library. Finally, the handler is called with the raised command accordingly.

XamlLoader changes (1.1.0)

XamlLoader module is re-written and now has simple 4 functions to create/load XAML object.

Function	Description
createFromFile: string -> obj option	Load XAML from file and instantiate.
createFromResource: string -> Assembly -> obj option	Load XAML from the assembly's resource
createFromXaml: string -> obj	Create directly from XAML string.
createFromXamlObj: obj -> string -> obj	Create directly from XAML string with root object.

Note that createFromXaml and createFromXamlObj functions do not return option. These functions throw an exception if XAML text is malformed or incompatible with its code behind class. This behavior is by design for most of usage, IMO, is in an application itself and bad XAML should be seriously fixed.

Event to command markup extension (1.1.1)

This extension allows converting an event into a command directly without using Blend SDK.

Sample.xaml

<Window xmlns="http://schemas.microsoft.com/netfx/2009/xaml/presentation"
        xmlns:rzmk="clr-namespace:RZ.Wpf.Markups;assembly=RZ.Wpf"
        xmlns:model="clr-namespace:Sample;assembly=Sample">
  <Window.DataContext>
    <model:MainWindowModel />
  </Window.DataContext>
  <StackPanel>
    <Label>Hello, world!</Label>
    <Button Command="{rzmk:BindCommand Open, CommandParameter=http://google.com/}">Click me to fire Open command.</Button>
  </StackPanel>
</Window>

When the button is clicked, Open command will be raised with command parameter "http://google.com/.

Event argument can be transformed and passed as command parameter as well by using EventArgumentConverter parameter. For example:

<Button Click="{rzmk:BindCommand Open, CommandParameter=Hiya, EventArgumentConverter=ToUpper}">Open command with 'HIYA'</Button>

ToUpper is a method in Data Context (this library is designed with Data Context cooperation in mind).

// snippet
type BindCommandSampleModel() as me =
  inherit ViewModelBase()

  member __.ToUpper(param: string, e: RoutedEventArgs) = param.ToUpper()

First parameter of a converter must always be string. The second parameter can be anything that is compatible with the event type. For example, if binding with MouseEnter event, this second parameter can be MouseEventArgs type. The return type of the converter can be anything but DependencyProperty.UnsetValue, it will directly be passed as a command parameter.

If the return is DependencyProperty.UnsetValue, the event will not be handled and command will not be raised.

Binding a custom command

BindCommand extension has CommandType parameter that can be either Standard(default) or ContextCommand. If it is set to ContextCommand, the specified command will be dynamically resolve at runtime with data context of the sender.

See more examples in BindCommandSample.xaml.

Other notes

Examples in this project come from the reference of book "WPF 5 Unleashed"