DiagramToolboxRegistrator.RegisterStencil(DiagramStencil) Method

Adds the specified stencil to the Shapes Panel.

Namespace: DevExpress.Diagram.Core

Assembly: DevExpress.Diagram.v20.2.Core.dll

NuGet Packages: DevExpress.Diagram.Core, DevExpress.WindowsDesktop.Diagram.Core

Declaration

C#

public static void RegisterStencil(
    DiagramStencil stencil
)

VB.NET

Public Shared Sub RegisterStencil(
    stencil As DiagramStencil
)

Parameters

Name	Type	Description
stencil	DiagramStencil	A DiagramStencil object that is the stencil to register.

Remarks

Use the DiagramStencil.Create method to create a new stencil.

See the examples:

• Winforms: How to: Create Custom Shapes with Connection Points
• WPF: How to Create Custom Shapes with Custom Connection Points for DiagramDesignerControl

Related GitHub Examples

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

winforms-diagram-create-custom-shapes-with-connection-points/CS/XtraDiagram.CreateCustomShapes/Form1.cs#L30

    var stencil = DiagramStencil.Create("CustomShapes", "Custom Shapes", stream, shapeName => shapeName);
    DiagramToolboxRegistrator.RegisterStencil(stencil);
}

diagramcontrol-how-to-create-custom-shapes-with-connection-points-using-xaml-markup-t381372/CS/XtraDiagram.CreateCustomShapesXaml/Form1.cs#L30

    var stencil = DiagramStencil.Create("CustomShapes", "Custom Shapes", shapesDictionary, shapeName => shapeName);
    DiagramToolboxRegistrator.RegisterStencil(stencil);
}

wpf-diagramcontrol-create-items-with-custom-content/CS/DXDiagram.ContentItem/MainWindow.xaml.cs#L52

    new Size(230, 80), true));
    DiagramToolboxRegistrator.RegisterStencil(stencil);
}

wpf-diagramdesigner-create-custom-shapes-with-connection-points/CS/DXDiagram.CreateCustomShapes/MainWindow.xaml.cs#L16

var stencil = DiagramStencil.Create("MyShapes", "Custom Shapes", customShapesDictionary, shapeName => shapeName);
DiagramToolboxRegistrator.RegisterStencil(stencil);
diagramControl.SelectedStencils.Add("MyShapes");

how-to-create-a-diagramshape-descendant-and-serialize-its-properties-t361265/CS/XtraDiagram.CustomShapeProperties/Form1.cs#L41

stencil.RegisterTool(itemTool);
DevExpress.Diagram.Core.DiagramToolboxRegistrator.RegisterStencil(stencil);
DiagramControl.ItemTypeRegistrator.Register(typeof(DiagramShapeEx));

VB.NET

winforms-diagram-create-custom-shapes-with-connection-points/VB/XtraDiagram.CreateCustomShapes/Form1.vb#L32

    Dim stencil = DiagramStencil.Create("CustomShapes", "Custom Shapes", stream, Function(shapeName) shapeName)
    DiagramToolboxRegistrator.RegisterStencil(stencil)
End Using

how-to-register-and-use-svg-shapes-in-diagramcontrol-t478161/VB/DiagramSVGItemsWpf/MainWindow.xaml.vb#L50

Next file
DevExpress.Diagram.Core.DiagramToolboxRegistrator.RegisterStencil(stencil)
diagramDesignerControl1.SelectedStencils.Add("SVGStencil")

diagramcontrol-how-to-create-custom-shapes-with-connection-points-using-xaml-markup-t381372/VB/XtraDiagram.CreateCustomShapesXaml/Form1.vb#L30

    Dim stencil = DiagramStencil.Create("CustomShapes", "Custom Shapes", shapesDictionary, Function(shapeName) shapeName)
    DiagramToolboxRegistrator.RegisterStencil(stencil)
End Sub

wpf-diagramcontrol-create-items-with-custom-content/VB/DXDiagram.ContentItem/MainWindow.xaml.vb#L22

    stencil.RegisterTool(New FactoryItemTool("Action", Function() "Button", Function(diagram) New DiagramContentItem() With {.CustomStyleId = "buttonContentItem"}, New Size(230, 80), True))
    DiagramToolboxRegistrator.RegisterStencil(stencil)
End Sub

wpf-diagramdesigner-create-custom-shapes-with-connection-points/VB/DXDiagram.CreateCustomShapes/MainWindow.xaml.vb#L18

Dim stencil = DiagramStencil.Create("MyShapes", "Custom Shapes", customShapesDictionary, Function(shapeName) shapeName)
DiagramToolboxRegistrator.RegisterStencil(stencil)
Me.diagramControl.SelectedStencils.Add("MyShapes")