Functions for Table Entries

DeleteSelectedEntries function

Deletes selected entries from a grid.

Synopsis

CODE

%count = DeleteSelectedEntries(Main, HARD_DELETE, WITH_FLAGS, USER=AdminUser, PASSWORD=AdminPassword)

Parameters

Only the grid parameter is required, and it must be in the first position. The other, optional, parameters can be specified in any order after the grid parameter.

If an optional parameter is listed more than one time, its last occurrence is used.

All keywords listed in the following table are case insensitive.

Name	Type	Required	Description

Name	Type	Required	Description
`grid`	string	yes	Describes the grid to which this command refers. The only values allowed in this command are `ENTRIES` and `SEARCH_RESULT`, and `MAIN` as an alias for `ENTRIES`.
`delete_type`	string	no	Specifies hard or soft deletion. Valid values are `HARD_DELETE` and `SOFT_DELETE`. If not specified, `SOFT_DELETE` applies.
`flag_operation`	string	no	Specifies whether items should be delete or skipped which have flags set that would prevent deletion. Values are `with_flags` and `no_flags`. `no_flags` is the default.
`group_operation`	string	no	Specifies whether items that are members of a group or story should be deleted or skipped. Values are `with_groupmembers` and `no_groupmembers`. `with_groupmembers` is the default.
`future_date_operation`	string	no	Specifies whether items should be deleted or skipped which have a delete date which is in the future. Values are `with_futuredate` and `no_futuredate`. `with_futuredate` is the default.
`user`	string	no	Name of a user account to use for the deletion.
`password`	string	no	Password of the user account to use for the deletion.

To specify user and password, Supply strings of the form "user=Superuser" and _{"password=SuperPassword"}.

Returns

The count of items which were deleted.

ShowGroupMembers procedure

Displays the Group Members or Collection Members pane and loads it with the members of the specified entry.

Synopsis

CODE

ShowGroupMembers(ENTRIES, 3)

Parameters

Name	Type	Required?	Description
`grid`	string	yes	Describes the grid to which this command refers.
`row`	number	yes	The 0-based grid row number.

Returns

Nothing

Remarks

Valid grid names are ENTRIES, GROUP_MEMBERS, and COLLECTION_MEMBERS; MAIN is an alias for ENTRIES.
The top-most row of the grid has number 0. Vertical scrolling doesn’t change row numbers.
If the specified grid row doesn’t exist, or it doesn’t contain a group or collection, the script is aborted with error.