ShapeDescription.Update(String, Func<String>, Func<Size>, ShapeGetter, ShapeConnectionPointsGetter, Func<ParameterCollection>, EditorBoundsGetter, Func<DiagramItemStyleId>, Func<Boolean>, Func<Boolean>) Method

Returns the ShapeDescription instance with updated properties.

Namespace: DevExpress.Diagram.Core

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

NuGet Package: DevExpress.Diagram.Core

Declaration

C#

public ShapeDescription Update(
    string id = null,
    Func<string> getName = null,
    Func<Size> getDefaultSize = null,
    ShapeGetter getShape = null,
    ShapeConnectionPointsGetter getConnectionPoints = null,
    Func<ParameterCollection> getParameterCollection = null,
    EditorBoundsGetter getEditorBounds = null,
    Func<DiagramItemStyleId> getStyleId = null,
    Func<bool> getIsQuick = null,
    Func<bool> getUseBackgroundAsForeground = null
)

VB.NET

Public Function Update(
    id As String = Nothing,
    getName As Func(Of String) = Nothing,
    getDefaultSize As Func(Of Size) = Nothing,
    getShape As ShapeGetter = Nothing,
    getConnectionPoints As ShapeConnectionPointsGetter = Nothing,
    getParameterCollection As Func(Of ParameterCollection) = Nothing,
    getEditorBounds As EditorBoundsGetter = Nothing,
    getStyleId As Func(Of DiagramItemStyleId) = Nothing,
    getIsQuick As Func(Of Boolean) = Nothing,
    getUseBackgroundAsForeground As Func(Of Boolean) = Nothing
) As ShapeDescription

Optional Parameters

Name	Type	Default	Description
id	String	null	A System.String value that is the shape’s identifier.
getName	Func<String>	null	A function that returns the name of the shape.
getDefaultSize	Func<Size>	null	A function that returns the default size of the shape.
getShape	DevExpress.Diagram.Core.ShapeGetter	null	A delegate function that returns the width, height and parameters of the shape.
getConnectionPoints	DevExpress.Diagram.Core.ShapeConnectionPointsGetter	null	A delegate function that returns connection points.
getParameterCollection	Func<DevExpress.Diagram.Core.ParameterCollection>	null	A function that returns shape parameters.
getEditorBounds	DevExpress.Diagram.Core.EditorBoundsGetter	null	A delegate function that returns the boundaries of the shape’s editor.
getStyleId	Func<DevExpress.Diagram.Core.DiagramItemStyleId>	null	A function that returns the identifier of a style to apply to the shape.
getIsQuick	Func<Boolean>	null	A function that returns whether to display the shape within the Quick Shapes category of the toolbox.
getUseBackgroundAsForeground	Func<Boolean>	null	A function that returns whether to paint the shape with the background color.

Returns

Type	Description
ShapeDescription	A ShapeDescription instance with updated properties.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Update(String, Func<String>, Func<Size>, ShapeGetter, ShapeConnectionPointsGetter, Func<ParameterCollection>, EditorBoundsGetter, Func<DiagramItemStyleId>, Func<Boolean>, Func<Boolean>) 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#

wpf-diagram-register-and-use-svg-shapes/CS/DiagramSVGItemsWpf/MainWindow.xaml.cs#L22

using (FileStream stream = File.Open(file, FileMode.Open)) {
    var shape = DevExpress.Diagram.Core.ShapeDescription.CreateSvgShape(name, name, stream)
        .Update(getDefaultSize: () => new Size(100, 100))

how-to-register-and-use-svg-shapes-t478182/CS/DiagramSVGItemsWinForms/Form1.cs#L36

{
    var shape = DevExpress.Diagram.Core.ShapeDescription.CreateSvgShape(name, name, stream)
        .Update(getDefaultSize: () => new System.Windows.Size(100, 100))

VB.NET

wpf-diagram-register-and-use-svg-shapes/VB/DiagramSVGItemsWpf/MainWindow.xaml.vb#L42

'INSTANT VB WARNING: Instant VB cannot determine whether both operands of this division are integer types - if they are then you should use the VB integer division operator:
                        Dim shape = DevExpress.Diagram.Core.ShapeDescription.CreateSvgShape(name_Renamed, name_Renamed, stream).Update(getDefaultSize:= Function() New System.Windows.Size(100, 100)).Update(getConnectionPoints:= Function(w, h, p) { New System.Windows.Point(w / 2, h / 2) })
                        stencil.RegisterShape(shape)

how-to-register-and-use-svg-shapes-t478182/VB/DiagramSVGItemsWinForms/Form1.vb#L33

'INSTANT VB WARNING: Instant VB cannot determine whether both operands of this division are integer types - if they are then you should use the VB integer division operator:
                        Dim shape = DevExpress.Diagram.Core.ShapeDescription.CreateSvgShape(name_Renamed, name_Renamed, stream).Update(getDefaultSize:= Function() New System.Windows.Size(100, 100)).Update(getConnectionPoints:= Function(w, h, p) { New System.Windows.Point(w / 2, h / 2) })
                        stencil.RegisterShape(shape)