CloneObjectViewController.CloneObjectAction Property

Gets a SingleChoiceAction Action used to clone persistent objects.

Namespace: DevExpress.ExpressApp.CloneObject

Assembly: DevExpress.ExpressApp.CloneObject.v20.2.dll

NuGet Package: DevExpress.ExpressApp.CloneObject

Declaration

C#

public SingleChoiceAction CloneObjectAction { get; }

VB.NET

Public ReadOnly Property CloneObjectAction As SingleChoiceAction

Property Value

Type	Description
SingleChoiceAction	A SingleChoiceAction object representing an Action used to clone persistent objects.

Remarks

This Action allows an end-user to clone an object currently selected in a List View or a Detail View’s current object. It invokes a Detail View with a new object. Property values of this object are copied from the object which has been cloned. To prohibit copying certain property value, apply the NonCloneableAttribute attribute to it.

The CloneObject Action is activated for the List and Detail Views representing an object type whose IModelClassCloneable.IsCloneable property is set to true in the Application Model. This Action enables you to create a clone of the current object as an object of the current type (it requires a single object to be selected). In addition, you can create an object of the class which is inherited from the current object’s base class. For this purpose, set the base class’ IModelClassCloneable.IsCloneable property to true. The following image demonstrates this Action activated for the Contact class. The Action’s dropdown list contains the Contact and User types, because the IsClonable property is set to true for the Person class - the base class for both Contact and User.

To change the behavior of the CloneObjectAction, create a custom View Controller, override the OnActivated method and access the CloneObjectViewController Controller and its Action. The following code demonstrates how to prohibit adding descendant types of the current object type’s base type to the Action’s ChoiceActionBase.Items collection:

C#

using DevExpress.ExpressApp.CloneObject;
//...
public partial class MyCloneObjectController : ViewController {
    //...
    protected override void OnActivated()
    {
        base.OnActivated();
        CloneObjectViewController cloneObjectController =
            Frame.GetController<CloneObjectViewController>();
        if (cloneObjectController != null) {
            cloneObjectController.CloneObjectAction.Items.Clear();
            ChoiceActionItem myItem =
                new ChoiceActionItem(View.ObjectTypeInfo.Name, View.ObjectTypeInfo.Type);
            myItem.ImageName =
                Application.Model.BOModel.GetNode<IModelClass>(View.ObjectTypeInfo.FullName).ImageName;
            cloneObjectController.CloneObjectAction.Items.Add(myItem);
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp.CloneObject
'...
Partial Public Class MyCloneObjectController
    Inherits ViewController
    '...
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        Dim cloneObjectController As CloneObjectViewController = Frame.GetController(Of CloneObjectViewController)()
        If cloneObjectController IsNot Nothing Then
            cloneObjectController.CloneObjectAction.Items.Clear()
            Dim myItem As New ChoiceActionItem(View.ObjectTypeInfo.Name, View.ObjectTypeInfo.Type)
            myItem.ImageName = Application.Model.BOModel.GetNode(Of IModelClass)(View.ObjectTypeInfo.FullName).ImageName
            cloneObjectController.CloneObjectAction.Items.Add(myItem)
        End If
    End Sub
End Class

With the code above, the CloneObject Action will clone the currently selected object to the object of the same type, because the only Action’s Item will be the current object type. Alternatively, you can manually fill the Items of the CloneObjectAction by handling the CloneObjectViewController.CustomGetCloneActionTargetTypes event. Refer to this event description to see an example.

By default, the CloneObject Action is disabled when there are unsaved changes in the current object, because the clone process works in a separate Object Space (see BaseObjectSpace). To change this behavior set the CloneObjectViewController.AllowCloneWhenModified property to true.

Note

The CloneObjectViewController adds a handler to the BaseObjectSpace.ModifiedChanged event of the View.ObjectSpace object. This handler updates the Action’s ActionBase.Enabled property by the “NotModified” key according to AllowCloneWhenModified and BaseObjectSpace.IsModified values. The “NotModified” key name is defined by the CloneObjectViewController.IsNotModifiedEnabledKey constant.

To ascertain why the CloneObject Action is currently deactivated or disabled, use the DiagnosticInfo Action. If you need to change the Action’s “active” or “enabled” state in code, use its ActionBase.Active or ActionBase.Enabled property, respectively.

Information on the CloneObject Action is available in the Application Model‘s ActionDesign node. To access it, use the Model Editor.