IUiCommandActionCustomize.RemoveByName

Syntax

RemoveByName(Name: String): Boolean;

Parameters

Name - name of the action, which parameters are to be removed from the collection.

Select one of the following reserved names as a parameter value:

Common actions:
- Open - opens an object.
- Save - saves changes to the object.
- SaveAs - saves all changes to a new repository object.
- OpenFile - opens object from file.
- SaveFile - saves object to a file.
- Export - exports object to supported formats.
- Print - prints object.
- PrintPreview - object preview before printing.
- EditData - edits object data.
- SaveData - saves changed data.
Specific actions:
- Report.Modules - regular report units.
- Report.Map - inserts a new map into regular report.
- Report.Mapselection - changes the current regular report map.
- Express.Datasources - changes list of express report data sources.
- Express.Map - shows express report map.
- Express.Mapselection - changes the current express report map.

If required, the prefix of the objects, to which the settings are applied, can be determined for the common actions:

Report - regular reports (for example, Report.SaveAs).
Express - express reports (for example, Express.Export).

Description

The RemoveByName method removes parameters of action from the collection by name and returns removal was successful.

Comments

Action names are case-insensitive. After removal action parameters are determined by the platform's system settings. The method returns True if action parameters are removed, and False if they are not removed.