Grid User Action

SelectionUserActionImg01

User Action node has the following properties:

Categoy Property  
General Properties Control Type SelectionUserActionImg02
Name
GxObject
General Tooltip
Condition
Popup
Popup Width
Width
Refresh After Popup
Image Image Type
Image
Image Class
Disabled Image
Disabled Image Class
Button Caption
Disabled Button Class
Image Image
Image Class
Disabled Image
Disabled Image Class
Advanced Security Security Functionality Key
Confirmation Confirm
Message
Title
Type
Comment
Comment invite message
Drop Down Component Web Component Load
Responsive Customization Visible (Extra Small)
Visible (Small)
Visible (Medium)
Visible (Large)
Fix Column Fixed column  

General Properties:

Control type:

Specifies whether the control for the action will be a Button, an Image, or a Drop Down Component. 


Name:

Specifies the action's name. This property is required as to identify the action in the object.


GxObject:

Specifies the object which will be invoked after the user clicks on the action. This field allows an empty value in which none object will be called.

Properties Of Category General:

Tooltip:

Specifies the tooltip which is going to be shown on the form, for that action. It applies to Images or Button actions.


Condition :

Specifies the condition which will have to accomplish in order to let the action enabled.


Popup:

Specifies whether the object invoked will be opened in a popup or on the same page. This property only applies when the property GxObject has some value (an object to invoke when clicking in the action). 

Popup Width:

Specifies the width of the popup. This only applies when you have the property 'Popup' as true and you select in the 'GX Object' property a Web Component, in order to use the WorkWithPlus Popup.

Width:

Specifies the width of the column which contains the user action. If you leave with 0 it will Auto resize the column.

Refresh After Popup:

Specifies whether a refresh command will be added after the popup sentence or not.

Properties Of Category Image:

The properties inside this category only apply for Image actions (its control type is Image).

Image Type:

Specifies the type of image. The options are:

  • Image.
  • FontIcon.

If you select font icon you need to specifies the font in the property 'Image Class'.

Image:

Specifies the image which is going to appear in the form.

Image Class:

Specifies the class for the image.

Disabled Image:

Specifies the image that will be shown at runtime in case the condition is not accomplished (condition set in Condition property) and the action is disabled. Only applies if the property Disabled Actions of WorkWithPlus Settings -> Standard Actions node -> property DisabledActions is 'Disabled' .

Disabled Image Class:

Specifies the theme class to be used when the action is disabled.

Properties Of Category Button:

Caption.

Specifies the button's caption (title).

Disabled Button Class:

Specifies the theme class to apply to actions which its control type is a button when they have to be disabled.

Properties Of Category Image:

The properties inside this category only apply for Image actions (its control type is Image).

Image:

Specifies the image which is going to appear in the form. 

Image Class:

Specifies the class for the image.

Disabled Image:

Image to appear in the Grid when the action is not enabled (to make the button invisible, use a transparent image). Only applies to Grid actions.

Disabled Image Class:

Specifies the theme class to be used when the action is disabled.

 For example, let's create a User Action in PersonWW that prints all records of persons, but is enabled only if there are more than eight persons inserted in DB. We can visualize below the User Action created:

SelectionUserActionImg03

We set to the User Action the following properties:

SelectionUserActionImg04

We don't set a GXObject because we want to print records but not to invoke some object. We open PersonWW to see the result:

SelectionUserActionImg05

We must develop the event associated with the User Action ('DoPrintAllRecords'), in order to set the behavior we want (print records). Then, we visualize it at runtime:

SelectionUserActionImg06

As we can see, the User Action is disabled and is not on the screen. Now we insert one more records in order to have at least eight records in DB and analyze the results:

SelectionUserActionImg07

Properties Of Category Advanced Security:

Security Functionality Key:

Specifies the functionality key to apply to this action. This property only applies when Advanced Security is enabled, and the property GXObject has some value. For more information click in Advanced Security .

Properties Of Category Confirmation:

Confirm:

Specifies whether the action will need confirmation from the user in order to continue its process or not. This will open a pop-up with the message, title, and type described in the following properties. This confirm panel is supported by actions inside or outside from grid.


Message:

Specifies the message that will be shown on the confirmation pop up.


Title:

Specifies the title that will be shown on the confirmation pop up.


Type:

Specifies whether the confirmation will have two options (YesNo type) or will have the option to cancel the operation (YesNoCancel type). The labels of Yes button, No button and Cancel button are parametrized in WWP Configuration -> Labels -> Confirm Text Yes, Confirm Text No, Confirm Text Cancel

Comment:

Specifies whether the confirmation will contain a field in which the end-user can write something. The possible values are: 'Do not include', 'Optional' and 'Required'

Comment invite message:

Specifies the invite message that will be included in the comment field.

If you want to read more information about ConfirmPanel, follow this link: Confirm Panel

Properties Of Category Drop Down Component:

Web Component Load:

Specifies how the Web Component will be loaded. The options are: 'On Web Panel load', 'On first click', 'On every click'. This property only apply when the 'Control Type' of the action is 'Drop Down Component'

Properties Of Category Responsive Customization:

Visible (Extra Small) - Visible (Small) - Visible (Medium) - Visible (Large):

With these properties, you can set whether the User Action will be visible in the different browser sizes. For example, you can set that is visible when the browser is Large and not visible when the browser is Extra Small. The possible values for these properties are true or false.

Fix Column

This Category is only visible when the User Action is inside a grid.

Fixed Column:

Specifies whether the action will be fixed to the left of the grid, to the right, or not fixed.