ButtonInfo Class

Represents a button for a button editor.

Namespace: DevExpress.Xpf.Editors

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

Declaration

C#

public class ButtonInfo :
    ButtonInfoBase,
    ICommandSource

VB.NET

Public Class ButtonInfo
    Inherits ButtonInfoBase
    Implements ICommandSource

Remarks

The ButtonInfo class implements the functionality of an individual button that can be displayed within button editors (e.g., ButtonEdit, DateEdit, etc.).

Example

This example shows how to create a new edit button with a custom glyph in code.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-edit-buttons-with-custom-glyphs-in-code-e3601.

MainWindow.xaml

<Window x:Class="DXEditors_HowToCreateButtonEdit.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525" xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">
    <Grid>
        <dxe:ButtonEdit 
            HorizontalAlignment="Left" Margin="176,129,0,0" Height="22"
            Name="btnEdit" VerticalAlignment="Top" Width="150" />
    </Grid>
</Window>

MainWindow.xaml.cs

using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media.Imaging;
using DevExpress.Xpf.Editors;

namespace DXEditors_HowToCreateButtonEdit {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            CreateEditButton(btnEdit, @"/DXEditors_HowToCreateButtonEdit;component\plus.png");
        }

        private void CreateEditButton(ButtonEdit edit, string imgUri) {
            BitmapImage bitmap = new BitmapImage(new Uri(imgUri, UriKind.Relative));
            Image imgSource = new Image() { Source = bitmap };
            ButtonInfo btnInfo = new ButtonInfo() { GlyphKind = GlyphKind.User, Content = imgSource };
            edit.Buttons.Add(btnInfo);
        }
    }
}

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media.Imaging
Imports DevExpress.Xpf.Editors

Namespace DXEditors_HowToCreateButtonEdit
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            CreateEditButton(btnEdit, "/DXEditors_HowToCreateButtonEdit;component\plus.png")
        End Sub

        Private Sub CreateEditButton(ByVal edit As ButtonEdit, ByVal imgUri As String)
            Dim bitmap As New BitmapImage(New Uri(imgUri, UriKind.Relative))
            Dim imgSource As New Image() With {.Source = bitmap}
            Dim btnInfo As New ButtonInfo() With {.GlyphKind = GlyphKind.User, .Content = imgSource}
            edit.Buttons.Add(btnInfo)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ButtonInfo class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_wpf-end-user-report-designer-how-to-hide-a-property-in-the-properties-window-t285448/CS/Dictionary1.xaml#L198

<dxe:ButtonEdit.Buttons>
    <dxe:ButtonInfo Content="{Binding Source=True, ConverterParameter=LookUpAddNew, Converter={StaticResource EditorStringIdConverter}}">
        <dxe:ButtonInfo.ContentTemplate>

how-to-add-custom-buttons-before-the-dxwindows-default-buttons-t417702/CS/MainWindow.xaml#L23

<dxe:ButtonEdit.Buttons>
    <dxe:ButtonInfo GlyphKind="Search" Margin="0"/>
</dxe:ButtonEdit.Buttons>

how-to-create-a-buttonedit-with-a-custom-button-e1981/VB/ButtonEdit_Creating/Window1.xaml#L15

<dxe:ButtonEdit.Buttons>
    <dxe:ButtonInfo Content="Clear" Click="ButtonInfo_Click" />
</dxe:ButtonEdit.Buttons>

how-to-show-hide-a-custom-button-in-an-editor-e2589/VB/WpfApplication17/MainWindow.xaml#L17

    </local:MyButtonInfo>
    <dxe:ButtonInfo x:Name="btnCombobox" GlyphKind="DropDown" />
</dxe:ComboBoxEdit.Buttons>

VB.NET

how-to-show-hide-a-custom-button-in-an-editor-e2589/VB/WpfApplication17/MainWindow.xaml.vb#L39

Public Class MyButtonInfo
    Inherits ButtonInfo
    Public Property ButtonInfoVisibility() As Visibility

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

ButtonInfoBase

ButtonInfo

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)