Introduction:
Since the dawn of Business Central Era (2nd April 2018 - Today), there are many new data types introduced by Microsoft.
One such data type is Enum(Enumeration). Essentially, what enumeration is having a single select value with multiple options at a given time!
Well, I know what your thinking what about the 'Option' data type.
Anyways, enough of talking let's just dive in!
Pre-requisites:
Microsoft Dynamics Business Central (SaaS or On-Premise)
VS code with AL Language extension
Code:
1. Enum as an Object:
Just like Tables and Pages, Enum behaves like an Object.
Note that Extensible means that the Enum Object can be extended in another module. By default, this property is set to TRUE.
Enums and Enum Extensions behave differently. They follow a different number sequence altogether.
2. Getting List of Enums already present in Business Central.
As of now, there are no Enums present in Business Central (Out-of-the-box) as there were no suggestions.
3. Using Enums in Tables, Pages, and Codeunits.
Enums in Tables:
Enum in Pages:
Enum in Codeunits:
4. Typecasting of Enums to Options:
It is observed that there are no compile-time errors occurring whenever we equate Enums to Option. Vice versa is also applicable
When the Option Members are not the same as Enums, there are no compile-time errors
Note: Some table fields share options that are semantically identical. In those cases, the EnumTypeId and EnumTypeName must be the same across all the fields. There is no design or runtime check for collision of IDs, but loading generated symbols into the compiler will show collision errors. (Copied from docs.microsoft.com)
5. Pros and Cons:
Since the dawn of Business Central Era (2nd April 2018 - Today), there are many new data types introduced by Microsoft.
One such data type is Enum(Enumeration). Essentially, what enumeration is having a single select value with multiple options at a given time!
Well, I know what your thinking what about the 'Option' data type.
Anyways, enough of talking let's just dive in!
Disclaimer: The knowledge in this blog is true and complete to the best of authors and publishers knowledge. The author and publisher disclaim any liability in connection with the use of this information.
Pre-requisites:
Microsoft Dynamics Business Central (SaaS or On-Premise)
VS code with AL Language extension
Code:
1. Enum as an Object:
Just like Tables and Pages, Enum behaves like an Object.
Enum Object |
Enums created in a module(App), cannot be extended in the same module |
Enums and Enum Extensions behave differently. They follow a different number sequence altogether.
Enum and Enum Extension behaving different type of objects |
2. Getting List of Enums already present in Business Central.
As of now, there are no Enums present in Business Central (Out-of-the-box) as there were no suggestions.
3. Using Enums in Tables, Pages, and Codeunits.
Enums in Tables:
Enum in Pages:
Enum in Codeunits:
4. Typecasting of Enums to Options:
It is observed that there are no compile-time errors occurring whenever we equate Enums to Option. Vice versa is also applicable
When the Option Members are not the same as Enums, there are no compile-time errors
Option Member missing in Option with respect to Enum |
Even after the Option Member is missing, the Enum value can be used. Which means that Enums area treated as 'Strings' during typecasting. |
5. Pros and Cons:
Pros | Cons |
---|---|
1. You get access to Enum globally in all tables/pages/variables etc. Thus ensuring uniform implementation. | 1. If you want a slightly modified Enum, you cannot make a change to existing Enum as it might change wherever referenced. |
2. Extensible whenever needed. | 2. Cannot create an extension in the same module. |
Hey, was rinding your post looking for a different answer.
ReplyDeleteDo you know if you can access the test of the selected enum in a list and pass it to something else as Text?
I have a list of 12 items in an Enum and would like to display it on a report.
I can see from your article that I can use a switch statement but that would require me to write a procedure that could possibly be re-used. Is it built in to the Enum?
The FromInteger Method on the Enum could possibly work but it does not seem to on my version 13
Thanks
This comment has been removed by a blog administrator.
ReplyDelete