EditingFieldExtensionsWin.RegisterImageCollectionEditor(String, String, IEnumerable<Image>) Method
Registers an image editor with a collection of predefined images to be used for changing image content in Print Preview.
Namespace: DevExpress.XtraPrinting.Preview
Assembly: DevExpress.XtraPrinting.v23.2.dll
NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.Printing
Declaration
public virtual bool RegisterImageCollectionEditor(
string name,
string displayName,
IEnumerable<Image> images
)Parameters
| Name | Type | Description |
|---|---|---|
| name | String | The name of the registered image collection editor. |
| displayName | String | The display name of the registered image collection editor. |
| images | IEnumerable<Image> | The editor’s image collection. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the image list has been successfully registered; otherwise, false. |
Remarks
Use this method to register an image editor with a collection of predefined images in the application.
using System.Collections.Generic;
using System.Drawing;
using System.IO;
using DevExpress.XtraPrinting.Preview;
//...
List<Image> images = new List<Image>();
foreach (var file in Directory.GetFiles("../../Flags/", "*.png")) {
Image img = Image.FromFile(file);
if (img != null) {
images.Add(img);
}
}
EditingFieldExtensionsWin.Instance.RegisterImageCollectionEditor("Nationality", "Nationality", images);
To use this editor for image editing in Print Preview, set a XRPictureBox control’s EditOptions | Enabled property to true and the EditOptions | EditorName property - to the registered editor’s name.
Set image edit options in the end-user Report Designer’ Property Grid.
The following sample demonstrates how to do this in code.
using DevExpress.XtraReports.UI;
//...
XtraReport1 report = new XtraReport1();
XRPictureBox pictureBox = report.Bands["ReportHeader"].FindControl("xrPictureBox1", true) as XRPictureBox;
pictureBox.EditOptions.Enabled = true;
pictureBox.EditOptions.EditorName = "Nationality";
When an end user clicks the Picture Box in Print Preview, the assigned editor activates. This editor allows end users to choose a predefined image or reset to the initial image.
Note
Use the RegisterImageEditor(String, String, ImageEditorOptions) method instead if you need to add the Brush Options and/or Load Image menu items as well.