DiagramCustomGetEditableItemPropertiesCacheKeyEventArgs.CacheKey Property

Gets or sets the cache key assigned to the edited diagram item.

Namespace: DevExpress.XtraDiagram

Assembly: DevExpress.XtraDiagram.v23.2.dll

NuGet Package: DevExpress.Win.Diagram

Declaration

C#

public object CacheKey { get; set; }

VB.NET

Public Property CacheKey As Object

Property Value

Type	Description
Object	An object that is the cache key associated with the edited item.

Remarks

The following example demonstrates a custom shape that derives from the DiagramShape. When the ShowInfo property value is set to true, the property grid displays the Info property.

C#

 //DiagramShapeEx.cs
public class DiagramShapeEx : DiagramShape {
    //the NotifyParentProperty attribute is used to notify the DiagramControl
    //that the ShowInfo value has changed.
    [NotifyParentProperty(true)]
    public bool ShowInfo {
        get;
        set;
    }
    public string Info {
        get;
        set;
    }
}

//...

void diagramControl1_CustomGetEditableItemProperties(object sender, DiagramCustomGetEditableItemPropertiesEventArgs e) {
    DiagramShapeEx shapeEx = e.Item as DiagramShapeEx;
    if (shapeEx != null) {
        e.Properties.Add(TypeDescriptor.GetProperties(typeof(DiagramShapeEx))["ShowInfo"]);
        if (shapeEx.ShowInfo)
            e.Properties.Add(TypeDescriptor.GetProperties(typeof(DiagramShapeEx))["Info"]);
    }
}

void diagramControl1_CustomGetEditableItemPropertiesCacheKey(object sender, DiagramCustomGetEditableItemPropertiesCacheKeyEventArgs e) {
    if (e.Item is DiagramShapeEx)
        e.CacheKey = Tuple.Create(typeof(DiagramShapeEx), ((DiagramShapeEx)e.Item).ShowInfo);
}

VB.NET

 'DiagramShapeEx.vb
Public Class DiagramShapeEx
    Inherits DiagramShape

    'the NotifyParentProperty attribute is used to notify the DiagramControl
    'that the ShowInfo value has changed.
    <NotifyParentProperty(True)>
    Public Property ShowInfo() As Boolean
    Public Property Info() As String
End Class

'...

Private Sub diagramControl1_CustomGetEditableItemProperties(ByVal sender As Object, ByVal e As DiagramCustomGetEditableItemPropertiesEventArgs)
    Dim shapeEx As DiagramShapeEx = TryCast(e.Item, DiagramShapeEx)
    If shapeEx IsNot Nothing Then
        e.Properties.Add(TypeDescriptor.GetProperties(GetType(DiagramShapeEx))("ShowInfo"))
        If shapeEx.ShowInfo Then
            e.Properties.Add(TypeDescriptor.GetProperties(GetType(DiagramShapeEx))("Info"))
        End If
    End If
End Sub

Private Sub diagramControl1_CustomGetEditableItemPropertiesCacheKey(ByVal sender As Object, ByVal e As DiagramCustomGetEditableItemPropertiesCacheKeyEventArgs)
    If TypeOf e.Item Is DiagramShapeEx Then
        e.CacheKey = Tuple.Create(GetType(DiagramShapeEx), CType(e.Item, DiagramShapeEx).ShowInfo)
    End If
End Sub

Tip

If you have a reasonable number of shapes on the canvas, you can set the e.CacheKey to null without affecting the performance.