DiagramCustomShape.BackgroundImageHeight Property

Specifies the height of the shape background image.

Namespace: DevExpress.Web.ASPxDiagram

Assembly: DevExpress.Web.ASPxDiagram.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(typeof(decimal), "1")]
public decimal BackgroundImageHeight { get; set; }

VB.NET

<DefaultValue(GetType(Decimal), "1")>
Public Property BackgroundImageHeight As Decimal

Property Value

Type	Default	Description
Decimal	"1"	A decimal number from 0 to 1.

Remarks

The BackgroundImageHeight property specifies the ratio of the shape background image’s height to the shape’s height. If the BackgroundImageHeight property is set to 1, the image height is equal to the shape height.

The absolute image height is calculated by multiplying the BackgroundImageHeight value by the shape’s height.

Online Demo

Diagram - Custom Shapes

Example

ASPX

<dx:ASPxDiagram ID="Diagram" runat="server" Width="100%" Height="600px">
    <SettingsToolbox>
        <Groups>
            <dx:DiagramToolboxGroup Category="Custom" CustomCategoryName="hardware" Title="Hardware" />
        </Groups>
    </SettingsToolbox>
    <CustomShapes>
        <dx:DiagramCustomShape CategoryName="hardware" Type="internet" Title="Internet" 
        BackgroundImageUrl="../Content/customshapes/shapes/internet.svg" 
        BackgroundImageLeft="0.15" BackgroundImageTop="0" BackgroundImageWidth="0.7" BackgroundImageHeight="0.7"
        DefaultWidth="0.75" DefaultHeight="0.75" DefaultText="Internet" AllowEditText="false" 
        TextLeft="0" TextTop="0.7" TextWidth="1" TextHeight="0.3">
            <ConnectionPoints>
                <dx:DiagramShapeConnectionPoint Left="0.5" Top="0" />
                <dx:DiagramShapeConnectionPoint Left="0.9" Top="0.5" />
                <dx:DiagramShapeConnectionPoint Left="0.5" Top="1" />
                <dx:DiagramShapeConnectionPoint Left="0.1" Top="0.5" />
            </ConnectionPoints>
        </dx:DiagramCustomShape>
        ...
    </CustomShapes>
</dx:ASPxDiagram>