DiagramDataBindingBehaviorBase.TemplateDiagram Property

Gets or sets the diagram whose settings are used to generate the diagram from the data source. This is a dependency property.

Namespace: DevExpress.Xpf.Diagram

Assembly: DevExpress.Xpf.Diagram.v24.1.dll

NuGet Package: DevExpress.Wpf.Diagram

Declaration

C#

public DiagramControl TemplateDiagram { get; set; }

VB.NET

Public Property TemplateDiagram As DiagramControl

Property Value

Type	Description
DiagramControl	A DiagramControl object.

Remarks

By default, the uppermost connector and diagram item defined in XAML within the TemplateDiagram are used as templates for the connectors and diagram items representing data objects.

You can use the DiagramDataBindingBehaviorBase.GenerateItem and DiagramDataBindingBehaviorBase.GenerateConnector events to implement custom logic for choosing the item and connector template. To do this, create diagram items/connectors in the TemplateDiagram and specify their names using the DiagramItem.TemplateName property. Specify the name of the desired template as the event’s CreateItemFromTemplate/CreateConnectorFromTemplate method parameter.

Alternatively, you can use the DiagramDataBindingBehaviorBase.ItemTemplateSelector property.

To learn more, see Data Binding.

Related GitHub Examples

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

XAML

wpf-diagram-use-diagramdatabindingbehavior-to-generate-diagram-from-collection/CS/DiagramDataBindingBehavior/MainWindow.xaml#L14

<dxdiag:DiagramDataBindingBehavior ItemsSource="{Binding ClassSource}" ConnectorsSource="{Binding ConnectionSource}" ConnectorFromMember="ConnectedFrom" ConnectorToMember="ConnectedTo" KeyMember="ClassName" LayoutKind="Sugiyama" ClearExistingItems="False" GenerateItem="DiagramDataBindingBehavior_GenerateItem" GenerateConnector="DiagramDataBindingBehavior_GenerateConnector">
    <dxdiag:DiagramDataBindingBehavior.TemplateDiagram>
        <dxdiag:DiagramControl CanvasSizeMode="Fill" SelectedStencils="TemplateDesigner" ShowPageBreaks="false">

wpf-diagram-use-diagramorgchartbehavior-to-generate-diagram-from-collection/CS/OrgChartBindingExample/MainWindow.xaml#L15

<dxdiag:DiagramOrgChartBehavior ItemsSource="{Binding Contacts}" KeyMember="Id" ParentMember="ParentId">
    <dxdiag:DiagramOrgChartBehavior.TemplateDiagram>
        <dxdiag:DiagramControl CanvasSizeMode="Fill" SelectedStencils="TemplateDesigner, BasicShapes" ShowPageBreaks="false" ShowRulers="false" ShowGrid="false">

wpf-diagram-bind-item-positions-to-source-objects/CS/dxSample/MainWindow.xaml#L25

KeyMember="Id">
<dxdiag:DiagramDataBindingBehavior.TemplateDiagram>
    <dxdiag:DiagramControl