RichEditControl.DockLayoutManagerName Property

Obtains the name of the DockLayoutManager containing RichEditControl and Reviewing Pane.

Namespace: DevExpress.Xpf.RichEdit

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

Declaration

C#

public static string DockLayoutManagerName { get; }

VB.NET

Public Shared ReadOnly Property DockLayoutManagerName As String

Property Value

Type	Description
String	A string that is the name of the DockLayoutManager used to access the Reviewing Pane.

Remarks

Use the DockLayoutManagerName property to access the Reviewing Pane and customize it, as shown in the code snippet below.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-an-integrated-reviewing-pane-t510789.

MainWindow.xaml.cs (C#)

//Access the DockLayoutManager in the template: 
string name = RichEditControl.DockLayoutManagerName;
DockLayoutManager manager = (DockLayoutManager)richEdit.Template.FindName(name, richEdit);

//Retireve the Reviewing Pane 
LayoutPanel commentPanel = manager.LayoutRoot.Items[0] as LayoutPanel;
DocumentPanel documentPanel = manager.LayoutRoot.Items[1] as DocumentPanel;

//Dock panel to the right 
manager.DockController.Dock(commentPanel, documentPanel, DockType.Right);

//Hide the pane to the tab 
commentPanel.AutoHidden = true;

//Disable floating 
commentPanel.AllowFloat = false;

MainWindow.xaml.vb

'Access the DockLayoutManager in the template: 
Dim name As String = RichEditControl.DockLayoutManagerName
Dim manager As DockLayoutManager = CType(richEdit.Template.FindName(name, richEdit), DockLayoutManager)

'Retireve the Reviewing Pane 
Dim commentPanel As LayoutPanel = TryCast(manager.LayoutRoot.Items(0), LayoutPanel)
Dim documentPanel As DocumentPanel = TryCast(manager.LayoutRoot.Items(1), DocumentPanel)

'Dock panel to the right 
manager.DockController.Dock(commentPanel, documentPanel, DockType.Right)

'Hide the pane to the tab 
commentPanel.AutoHidden = True

'Disable floating 
commentPanel.AllowFloat = False

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DockLayoutManagerName property.

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#

how-to-customize-an-integrated-reviewing-pane-t510789/CS/ReviewingPaneSimpleExample/MainWindow.xaml.cs#L24

//Access the DockLayoutManager in the template:
string name = RichEditControl.DockLayoutManagerName;
DockLayoutManager manager = (DockLayoutManager)richEdit.Template.FindName(name, richEdit);

VB.NET

how-to-customize-an-integrated-reviewing-pane-t510789/VB/ReviewingPaneSimpleExample/MainWindow.xaml.vb#L22

'Access the DockLayoutManager in the template:
Dim name As String = RichEditControl.DockLayoutManagerName
Dim manager As DockLayoutManager = CType(richEdit.Template.FindName(name, richEdit), DockLayoutManager)