Meta |
A MetaEnum defines an enumerated list in a MetaData
Inheritance HierarchyNamespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 8.1.0.0+4fe7975a95558d7cdf0d4c425e2c3a22827d67dd
SyntaxC#
public class MetaEnum : RootComponent
The MetaEnum type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Error | Last error message |
| FilterChars | If the list is dynamic, refreshed before execution and the SQL for prompted restriction contains the '{EnumFilter}' keyword, the number of characters typed by the used in the filter box before the enum is built and displayed |
| GUID |
The unique identifier
(Inherited from RootComponent) |
| HasDependencies | True if the list has dependencies to other list |
| HasDynamicDisplay | True if the list has dynamic display |
| HelperRefreshEnum | Editor Helper: Refresh values of this list using the SQL Statement |
| Information | Last information message when the enum list has been refreshed |
| IsDbRefresh | If True, the list is loaded before a report execution. Should be set to False if the SQL or the Load Script has poor performances. |
| IsDynamic | If True, the list is loaded using the 'SQL Select Statement' and/or the 'Script' defined. |
| IsSQL | True if the source is a standard SQL source |
| Message | If the list is dynamic, refreshed before execution and has filter characters or dependencies, the message displayed to the end user to trigger the list (e.g. 'Select a country first' or 'Type 5 characters'). |
| Name |
Name of the enumerated list
(Overrides RootComponentName) |
| NumberOfValues | The number of values in the collection |
| RequestServerOnPopup | True if the list need to request the server on popup |
| Script | If the list is dynamic, Razor Script executed to load or update the enumerated list values. The Script is executed after the optional SQL load when 'SQL Select Statement' is not empty. |
| ScriptDisplay | Optional Script used to build the values displayed in a prompted restriction. The Script is used only if the list is dynamic, refreshed before report execution. It can contain either the '{EnumFilter}' and/or '{EnumValues_<Name>}' keywords where <Name> is the name of another prompted enumerated list. |
| Source | Current MetaSource |
| Sql | If the list is dynamic, SQL Select statement with 1, 2, 3, 4 or 5 columns used to build the list of values. The first column is used for the identifier, the second optional column is the display value shown in the table result, the third optional column is the display value shown in the restriction list, the fourth optional column defines a custom CSS Style applied to the result cell, the fifth optional column defines a custom CSS Class applied to the result cell. |
| SqlDisplay | Optional SQL Select Statement used to build the values displayed in a prompted restriction. The SQL is used only if the list is dynamic, refreshed before report execution. |
| Translate | If True, the enumerated values are translated using the Repository translations |
| UsePosition | If True, the current position of the values in the list is used to sort the column in the report result |
| Values | The list of values used for this enumerated list |
| ValuesPerConnection | If True, the enum loads and stores the values for each connection. |
Methods| Name | Description | |
|---|---|---|
  | Create | Create a basic enumerated list |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetDisplayValue | Return the display value from the identifer |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetSubSetValues | Returns the list of the enum values to display after applying filter and depencies |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValues | |
| Init |
Init the editor objects
(Inherited from RootEditor) |
| InitDefaultValues |
Init the default values
(Inherited from RootEditor) |
| InitEditor |
Init the editor objects and the default values
(Inherited from RootEditor) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RefreshEnum | Refresh the values of the enumerated list |
| SetReadOnly |
Set all properties to readonly
(Inherited from RootEditor) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UpdateEditor |
Update editor attributes
(Inherited from RootEditor) |
| UpdateEditorAttributes |
Refresh properties attrivutes
(Inherited from RootEditor) |
Fields| Name | Description | |
|---|---|---|
 | _dctd | (Inherited from RootEditor) |
| _GUID | (Inherited from RootComponent) |
| _name | (Inherited from RootComponent) |
| _source | |
 | IsEditable | True if the list is editable |
| NewValues | New enum values set by the dynamic display Script |
| Tag | Object that can be used at run-time for any purpose |
| Tag2 | Object that can be used at run-time for any purpose |
See Also