NewObjectViewController.NewObjectActionItemListMode Property

Specifies the mode for populating the NewObjectViewController.NewObjectAction items list.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[DefaultValue(NewObjectActionItemListMode.Default)]
public NewObjectActionItemListMode NewObjectActionItemListMode { get; set; }

VB.NET

<DefaultValue(NewObjectActionItemListMode.Default)>
Public Property NewObjectActionItemListMode As NewObjectActionItemListMode

Property Value

Type	Default	Description
NewObjectActionItemListMode	Default	An NewObjectActionItemListMode enumeration value specifying the mode for populating the New Action’s items list.

Available values:

Name	Description
Default	The current type and all of its descendant types are added.
ExcludeBaseType	All descendants of the current type are added. The current type itself is excluded.
LastDescendantsOnly	Only the last types in the inheritance hierarchy of the current type are added.

Remarks

Use the following code to change the NewObjectActionItemListMode value in a specific View.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.SystemModule;
using DevExpress.Persistent.BaseImpl;
// ...
public class CustomizeNewActionItemsListController : ObjectViewController<ObjectView, Task> {
    protected override void OnActivated() {
        base.OnActivated();
        NewObjectViewController controller = Frame.GetController<NewObjectViewController>();
        if (controller != null) {
            controller.NewObjectActionItemListMode = NewObjectActionItemListMode.LastDescendantsOnly;
        } 
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.SystemModule
Imports DevExpress.Persistent.BaseImpl
' ...
Public Class CustomizeNewActionItemsListController
    Inherits ObjectViewController(Of ObjectView, Task)
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        Dim controller As NewObjectViewController = Frame.GetController(Of NewObjectViewController)()
        If controller IsNot Nothing Then
            controller.NewObjectActionItemListMode = NewObjectActionItemListMode.LastDescendantsOnly
        End If
    End Sub
End Class

To specify the default value applied in all Views, use the static NewObjectViewController.DefaultNewObjectActionItemListMode field.

The NewObjectActionItemListMode value is ignored in a case when there are no descendants of the current business object type. In the ExcludeBaseType and LastDescendantsOnly modes, the New Action may become inactive if it is impossible to instantiate any of the descendants (e.g., due to the Security System restrictions).

If the modes listed in the NewObjectActionItemListMode enumeration do not fit your requirements, handle the NewObjectViewController.CollectDescendantTypes and NewObjectViewController.CollectCreatableItemTypes events instead of using the NewObjectActionItemListMode property. An example is provided in the How to: Customize the New Action’s Items List topic.