ButtonEdit.ButtonTemplate Property

Gets or sets the data template used to render buttons of the current ButtonEdit.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v19.1.dll

Declaration

C#

public DataTemplate ButtonTemplate { get; set; }

VB.NET

Public Property ButtonTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A DataTemplate object that is used to render buttons of the current ButtonEdit.

Remarks

The ButtonTemplate property specifies the data template used to render buttons from the ButtonEdit.ButtonsSource collection.

XAML

<dxe:ButtonEdit.ButtonTemplate>
    <DataTemplate>
        <ContentControl>
            <dxe:ButtonInfo 
                Command="{Binding Command}"
                Content="{Binding Content}"
                IsLeft="{Binding IsLeft}" />
        </ContentControl>
    </DataTemplate>
</dxe:ButtonEdit.ButtonTemplate>

If you want to declare several data templates and apply one of them according to your own logic, use the ButtonEdit.ButtonTemplateSelector property.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bind-a-buttonedit-buttons-to-a-collection-in-a-view-model-t328449.

MainViewModel.vb

Imports DevExpress.Mvvm
Imports System.Collections.ObjectModel

Namespace DXSample.ViewModels
    Public Class MainViewModel
        Inherits ViewModelBase

        Private ReadOnly Property MessageBoxService() As IMessageBoxService
            Get
                Return GetService(Of IMessageBoxService)()
            End Get
        End Property

        Public Property Items() As ObservableCollection(Of ButtonViewModel)
            Get
                Return GetProperty(Function() Items)
            End Get
            Set(ByVal value As ObservableCollection(Of ButtonViewModel))
                SetProperty(Function() Items, value)
            End Set
        End Property
        Public Sub New()
            Items = New ObservableCollection(Of ButtonViewModel)() From {
                New ButtonViewModel() With {
                    .Content = "A",
                    .Command = New DelegateCommand(Function() MessageBoxService.ShowMessage("A")),
                    .IsLeft = True
                },
                New ButtonViewModel() With {
                    .Content = "B",
                    .Command = New DelegateCommand(Function() MessageBoxService.ShowMessage("B")),
                    .IsLeft = True},
                New ButtonViewModel() With {
                    .Content = "C",
                    .Command = New DelegateCommand(Function() MessageBoxService.ShowMessage("C")),
                    .IsLeft = True},
                New ButtonViewModel() With {
                    .Content = "X",
                    .Command = New DelegateCommand(Function() MessageBoxService.ShowMessage("X"))
                },
                New ButtonViewModel() With {
                    .Content = "Y",
                    .Command = New DelegateCommand(Function() MessageBoxService.ShowMessage("Y"))},
                New ButtonViewModel() With {
                    .Content = "Z",
                    .Command = New DelegateCommand(Function() MessageBoxService.ShowMessage("Z"))},
                New ButtonViewModel() With {
                    .Content = "Clear",
                    .Command = New DelegateCommand(
                        Sub()
                            Items.Clear()
                            Items = New ObservableCollection(Of ButtonViewModel)(Items)
                        End Sub)
                },
                New ButtonViewModel() With {
                    .Content = "Add",
                    .Command = New DelegateCommand(
                        Sub()
                            Items.Add(New ButtonViewModel() With {
                                .Content = "New",
                                .IsLeft = Items.Count Mod 2 = 0
                            })
                            Items = New ObservableCollection(Of ButtonViewModel)(Items)
                        End Sub)
                }
            }
        End Sub
    End Class
End Namespace

MainView.xaml

<UserControl
    x:Class="DXSample.Views.MainView"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:ViewModels="clr-namespace:DXSample.ViewModels"
    xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm"
    xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
    mc:Ignorable="d"
    d:DesignHeight="300"
    d:DesignWidth="300">

    <UserControl.DataContext>
        <ViewModels:MainViewModel />
    </UserControl.DataContext>

    <dxmvvm:Interaction.Behaviors>
        <dx:DXMessageBoxService />
    </dxmvvm:Interaction.Behaviors>

    <Grid>
        <dxe:ButtonEdit
            Margin="20"
            HorizontalAlignment="Stretch"
            VerticalAlignment="Center"
            ButtonsSource="{Binding Items}">
            <dxe:ButtonEdit.ButtonTemplate>
                <DataTemplate>
                    <ContentControl>
                        <dxe:ButtonInfo
                            Command="{Binding Command}"
                            Content="{Binding Content}"
                            IsLeft="{Binding IsLeft}" />
                    </ContentControl>
                </DataTemplate>
            </dxe:ButtonEdit.ButtonTemplate>
        </dxe:ButtonEdit>
    </Grid>

</UserControl>

MainViewModel.cs

using DevExpress.Mvvm;
using System.Collections.ObjectModel;

namespace DXSample.ViewModels {
    public class MainViewModel : ViewModelBase {

        private IMessageBoxService MessageBoxService { get { return GetService<IMessageBoxService>(); } }

        public ObservableCollection<ButtonViewModel> Items {
            get { return GetProperty(() => Items); }
            set { SetProperty(() => Items, value); }
        }
        public MainViewModel() {
            Items = new ObservableCollection<ButtonViewModel>() {
                new ButtonViewModel() {
                    Content = "A",
                    Command = new DelegateCommand(()=> {
                        MessageBoxService.ShowMessage("A");
                    }),
                    IsLeft = true,
                },
                new ButtonViewModel() {
                    Content = "B",
                    Command = new DelegateCommand(()=> {
                        MessageBoxService.ShowMessage("B");
                    }),
                    IsLeft = true,
                },
                new ButtonViewModel() {
                    Content = "C",
                    Command = new DelegateCommand(()=> {
                        MessageBoxService.ShowMessage("C");
                    }),
                    IsLeft = true,
                },
                new ButtonViewModel() {
                    Content = "X",
                    Command = new DelegateCommand(()=> {
                        MessageBoxService.ShowMessage("X");
                    }),
                },
                new ButtonViewModel() {
                    Content = "Y",
                    Command = new DelegateCommand(()=> {
                        MessageBoxService.ShowMessage("Y");
                    }),
                },
                new ButtonViewModel() {
                    Content = "Z",
                    Command = new DelegateCommand(()=> {
                        MessageBoxService.ShowMessage("Z");
                    }),
                },
                new ButtonViewModel() {
                    Content = "Clear",
                    Command = new DelegateCommand(()=> {
                        this.Items.Clear();
                        Items = new ObservableCollection<ButtonViewModel>(Items);
                    }),
                },
                new ButtonViewModel() {
                    Content = "Add",
                    Command = new DelegateCommand(()=> {
                        Items.Add(new ButtonViewModel() {
                            Content = "New",
                            IsLeft = this.Items.Count % 2 == 0
                        });
                        Items = new ObservableCollection<ButtonViewModel>(Items);
                    }),
                },
            };
        }
    }
}