EditingFieldExtensions.RegisterEditorInfo(String, String, String) Method

Registers a custom editor to be used for changing control content in Print Preview.

Namespace: DevExpress.Xpf.Printing

Assembly: DevExpress.Xpf.Printing.v19.2.dll

Declaration

C#

public bool RegisterEditorInfo(
    string editorName,
    string category,
    string editorDisplayName = null
)

VB.NET

Public Function RegisterEditorInfo(
    editorName As String,
    category As String,
    editorDisplayName As String = Nothing
) As Boolean

Parameters

Name	Type	Description
editorName	String	The name of a custom editor.
category	String	The name of a category to which an editor should be added.

Optional Parameters

Name	Type	Default	Description
editorDisplayName	String	*null*	The display name of a custom editor.

Returns

Type	Description
Boolean	true, if an editor has been successfully registered; otherwise, false.

Remarks

To learn how to use custom controls for report editing in Print Preview, view the following example online: How to use custom controls for editing report content in Print Preview.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RegisterEditorInfo(String, String, String) method.

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_how-to-use-custom-controls-for-editing-report-content-in-print-preview-t456791/CS/WpfApplication1/MainViewModel.cs#L12

// Register custom editors.
EditingFieldExtensions.Instance.RegisterEditorInfo("ComboBoxEditor", "Custom", "ComboBox Editor");
EditingFieldExtensions.Instance.RegisterEditorInfo("DateEditor", "Custom", "Date Editor");

VB.NET

Reporting_how-to-use-custom-controls-for-editing-report-content-in-print-preview-t456791/VB/WpfApplication1/MainViewModel.vb#L14

' Register custom editors.
EditingFieldExtensions.Instance.RegisterEditorInfo("ComboBoxEditor", "Custom", "ComboBox Editor")
EditingFieldExtensions.Instance.RegisterEditorInfo("DateEditor", "Custom", "Date Editor")