Action Customization: Visibility of an Action

To Set an Action's Visibility at Run Time (Custom Graph)

To set the visibility of an action's corresponding button on a toolbar or command on the More menu (or both), you need to use the SetVisible method. You should use the SetVisible method in the following locations:

• The RowSelected event handler in the code of a graph or its extensions. The event handler usually belongs to the primary DAC of the form.
• The graph constructor.
• The Initialize method of a graph extension.

Suppose that on a particular form, when the Status field of a document is changed to Open, you need to make the MyAction action's corresponding button on the form toolbar and the command on the More menu visible. You do the following:

1. Implement the RowSelected event handler, as shown in the following code.

   protected virtual void _(Events.RowSelected<PrimaryDAC> e)
   {
     if (e.Row == null) return;
   
   }

   For details on creating event handlers, see To Add an Event Handler.

2. In the event handler, call the SetVisible method, as the following code shows.

   MyAction.SetVisible(row.Status != Open);

   The code above makes the MyAction action's corresponding button on the form toolbar and the command on the More menu visible when the status of a document is Open.

To Hide or Show a Button on a Form Toolbar

The command corresponding to an action defined for a form is visible on the More menu.

You can also show an action as a button on the form toolbar of a particular form by doing one of the following:

• To show the action on the form toolbar for a particular state of a record defined on the form, call the IsDuplicateOnToolbar method when you are adding an action to the state. An example is shown in the following code.

  flowState.WithActions(actions => {
    actions.Add(g => g.putOnHold, a => a.IsDuplicatedInToolbar());})

  Note:

  This approach works only if a workflow is defined for a form.
• To place the button corresponding to an action on the form toolbar without removing the equivalent command from the More menu permanently, specify DisplayOnMainToolbar = true on the PXButton attribute in the action definition. The button will be displayed on the form toolbar only if the action is enabled.
• To place the button corresponding to an action on the toolbar and remove the equivalent command from the More menu, specify IsLockedOnToolbar = true in the PXButton attribute in the action definition. The button will be displayed on the form toolbar even if the action is disabled. An example is shown in the following code.

  [PXButton(IsLockedOnToolbar = true)]

  This property can be changed dynamically by using the SetIsLockedOnToolbar method of the action.

• To place on the form toolbar the button corresponding to a system action (such as Save, Cancel, or Previous) for which no category is specified, do nothing. This action is automatically displayed on the form toolbar.

To Hide or Show a Button of a Predefined Action at Run Time

Suppose that you need to hide the button corresponding to the MyAction action, which is defined in the original code of MYOB Acumatica. The visibility of the MyAction action is defined by using the PXUIField attribute, and you need to hide this button by default. To do this, you need to change the visibility of the action in a graph extension by doing the following:

1. Explore the original action declaration, as described in Action Customization: Customization of an Action but without copying the declaration to the graph extension.
2. In the graph extension, add the following code.

   #region Extended initialization
   
   public override void Initialize()
   {
     base.Initialize();
     Base.MyAction.SetVisible(false);
   }
   #endregion
   

   Note:

   To show the action button, use true instead of false for the SetVisible method call.

To Hide or Show the Button of an Action Statically

To override action attributes in a graph extension statically, you should declare both the delegate and the graph member of the PXAction type. You should attach a new set of attributes to the action delegate declared within the graph extension. Also, you need to invoke the Press() method on the base graph action. Because you have re-declared the member of PXAction, you prevent the execution of the action delegate from infinite loops.