PopupColorEdit Class

Represents a color editor displayed within a dropdown window.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v18.2.dll

Declaration

C#

public class PopupColorEdit :
    PopupBaseEdit,
    IColorEdit

VB.NET

Public Class PopupColorEdit
    Inherits PopupBaseEdit
    Implements IColorEdit

Related API Members

The following members return PopupColorEdit objects:

• PopupColorEdit.GetOwnerPopupEdit(DependencyObject)

Remarks

The PopupColorEdit editor allows an end-user to choose the required color using the Color Picker interface.

Its features include:

• 20 Preset Palettes - Apex, Civic, Grayscale, Office, etc.
• Recent Colors Palette - includes custom colors which can be added via the More Colors dialog.
• Unlimited Number of Custom Color Palettes - by default, the editor displays three color palettes: Theme Colors, Gradient Theme Colors and Standard Colors. You can replace default palettes or add any number of custom color palettes. To create a color palette, create a new instance of the CustomPalette class and define the colors. Use the static ColorPalette.CreateGradientPalette method to create a palette with gradient colors. To display a custom palette within the editor, add it to the PopupColorEdit.Palettes collection.
• Configurable Palette Layout - you can manually specify the number of color columns using the PopupColorEdit.ColumnCount property. Alternatively, the number of columns is automatically calculated.
• Customizable Default Color - you can specify the default color, which is applied by clicking the Default Color Button. To do this, use the ColorEdit.DefaultColor property.
• Optional Empty Color - to allow an end-user to select an empty color (ColorEdit.EmptyColor), set the PopupColorEdit.ShowNoColorButton property to true. This shows the No Color Button within the editor.
• Localizable UI

Example

This example shows how to create custom palettes and display them within the PopupColorEdit control.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/popupcoloredit-create-custom-palettes-e2357.

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Data
Imports System.Windows.Documents
Imports System.Windows.Input
Imports System.Windows.Media
Imports System.Windows.Media.Imaging
Imports System.Windows.Navigation
Imports System.Windows.Shapes
Imports DevExpress.Xpf.Editors

Namespace DXEditors_PopupColorEdit
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            ' Removes the 'Standard Colors' palette.
            popupColorEdit1.Palettes.Remove(popupColorEdit1.Palettes("Standard Colors"))
            ' Adds a custom gradient palette.
            popupColorEdit1.Palettes.Add(CustomPalette.CreateGradientPalette("Apex Colors", PredefinedColorCollections.Apex))
            ' Adds a new palette with three custom RGB colors.
            Dim customColors As List(Of Color) = New List(Of Color)
            customColors.Add(Color.FromRgb(150, 18, 30))
            customColors.Add(Color.FromRgb(20, 40, 20))
            customColors.Add(Color.FromRgb(88, 73, 29))
            Dim palette As CustomPalette = New CustomPalette("Custom RGB Colors", customColors)
            popupColorEdit1.Palettes.Add(palette)
        End Sub
    End Class
End Namespace

MainWindow.xaml

<Window x:Class="DXEditors_PopupColorEdit.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" xmlns:dxc="http://schemas.devexpress.com/winfx/2008/xaml/core">
    <Grid>
        <Grid.Resources>
            <ResourceDictionary>
                <dxc:ColorToBrushConverter x:Key="ColorToBrushConverter" />
            </ResourceDictionary>
        </Grid.Resources>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto" />
            <RowDefinition />
        </Grid.RowDefinitions>
        <GroupBox Header="Text Color" Grid.Row="0" HorizontalAlignment="Left" Margin="3" Name="groupBox1" VerticalAlignment="Top">
            <Grid>
                <dxe:PopupColorEdit Name="popupColorEdit1" Color="Green" Width="130" />
            </Grid>
        </GroupBox>
        <GroupBox HorizontalAlignment="Stretch" Header="Text Box" Grid.Row="1" Margin="3" Name="groupBox2" VerticalAlignment="Stretch">
            <Grid>
                <TextBox Text="Sample text..." Grid.Column="1" Foreground="{Binding Path=Color, ElementName=popupColorEdit1, Converter={StaticResource ColorToBrushConverter}}" Margin="3" Name="textBox1" />
            </Grid>
        </GroupBox>
    </Grid>
</Window>

MainWindow.xaml.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;
using DevExpress.Xpf.Editors;

namespace DXEditors_PopupColorEdit {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            // Removes the 'Standard Colors' palette.
            popupColorEdit1.Palettes.Remove(popupColorEdit1.Palettes["Standard Colors"]);
            // Adds a custom gradient palette.
            popupColorEdit1.Palettes.Add(CustomPalette.CreateGradientPalette("Apex Colors", PredefinedColorCollections.Apex));
            // Adds a new palette with three custom RGB colors.
            popupColorEdit1.Palettes.Add(
                new CustomPalette("Custom RGB Colors",
                new List<Color>() {
                    Color.FromRgb(150, 18, 30),
                    Color.FromRgb(20, 40, 20),
                    Color.FromRgb(88, 73, 29) }));
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PopupColorEdit 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#

popupcoloredit-create-custom-palettes-e2357/VB/MainWindow.xaml#L14

<Grid>
    <dxe:PopupColorEdit Name="popupColorEdit1" Color="Green" Width="130" />
</Grid>

bookmarks-and-hyperlinks-simple-example-t549304/CS/BookmarksAndHyperlinksSimpleExample/MainWindow.xaml#L28

<TextBlock Text="Bookmark color:" Margin="0,6,0,3" VerticalAlignment="Top" HorizontalAlignment="Left" Grid.Row="1"/>
<dxe:PopupColorEdit x:Name="colorEdit1" VerticalAlignment="Top" HorizontalAlignment="Left" Margin="0,3,0,0" Grid.Row="2" Color="SteelBlue">
</dxe:PopupColorEdit>

how-to-implement-a-custom-mapping-converter-for-color-values-t587301/CS/ColorMappingExample/MainWindow.xaml#L24

<WrapPanel Grid.Row="0">
    <dxe:PopupColorEdit
        Height="Auto"

Inheritance

Show 13 items

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

BaseEdit

TextEditBase

TextEdit

ButtonEdit

PopupBaseEdit

PopupColorEdit

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)