Bundt Scripting Reference · Bundt Scripting Language version 1.0.1.0

alter enum type statement

Alters an existing enumerated item and puts it in context.

The enumerated type owning the enumerated item is also put in context.

Syntax

alter enum item [EnumItemName] as
    [name Name]
    [definition Definition]
    [comments Comments]
    [tagged
      [without WithoutTagList]
      [with WithTagList]
    ]

Element Type Optionality Notes
EnumItemName Enumerated item name Optional. If no enumerated item name is specified, the enumerated item in context is used. If no enumerated item is in context, an error occurs. Specifies the existing enumerated item to be altered.
Name Expression<Identifier> or Expression<Dictionary<Identifier>> Optional. If no name is specified, the current one is maintained. Specifies the new name of the enumerated item, either as an identifier or in multilingual dictionary format.
Definition Expression<Text> or Expression<Dictionary<Text>> Optional. If no definition is specified, the current one is maintained. Specifies the new definition of the enumerated item.
Comments Expression<Text> or Expression<Dictionary<Text>> Optional. If no commments are specified, the current ones are maintained. Specifies the new commments for the enumerated item.
WithoutTagList Element name list Optional. If no tags are specified, no tags are removed. Specifies the tags to remove from the enumerated item.
WithTagList Element name list Optional. If no tags are specified, no tags are added. Specifies the tags to add to the enumerated item.

Returns

The enumerated item just altered.

Examples

Intent Code
Alter an enumerated item to change its name alter enum item Colours.Blue/NavyBlue as name Navy;
Alter an enumerated item to add some comments alter enum item Colours.Blue/Navy as comments "This is not being used properly.";
Alter the context enumerated item to remove a tag alter enum item Colours.Blue/Navy as tagged without ToRevise;

See Also


Contents distributed under a Creative Commons Attribution 4.0 International License · About · Terms of Use · Contact Us · last updated on 08 October 2020