Click or drag to resize

MetaEnum Class

A MetaEnum defines an enumerated list in a MetaData
Inheritance Hierarchy

Namespace:  Seal.Model
Assembly:  SealLibrary (in SealLibrary.dll) Version: 6.1.0.0 (6.1.0.0)
Syntax
public class MetaEnum : RootComponent

The MetaEnum type exposes the following members.

Constructors
  NameDescription
Public methodMetaEnum
Initializes a new instance of the MetaEnum class
Top
Properties
  NameDescription
Public propertyError
Last error message
Public propertyFilterChars
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
Public propertyGUID
The unique identifier
(Inherited from RootComponent.)
Public propertyHasDependencies
True if the list has dependencies to other list
Public propertyHasDynamicDisplay
True if the list has dynamic display
Public propertyHelperRefreshEnum
Editor Helper: Refresh values of this list using the SQL Statement
Public propertyInformation
Last information message when the enum list has been refreshed
Public propertyIsDbRefresh
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.
Public propertyIsDynamic
If True, the list is loaded using the 'SQL Select Statement' and/or the 'Script' defined.
Public propertyIsSQL
True if the source is a standard SQL source
Public propertyMessage
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').
Public propertyName
Name of the enumerated list
(Overrides RootComponentName.)
Public propertyNumberOfValues
The number of values in the collection
Protected propertyProperties
List of properties of the object
(Inherited from RootEditor.)
Public propertyRequestServerOnPopup
True if the list need to request the server on popup
Public propertyScript
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.
Public propertyScriptDisplay
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.
Public propertySource
Current MetaSource
Public propertySql
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.
Public propertySqlDisplay
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.
Public propertyTranslate
If True, the enumerated values are translated using the Repository translations
Public propertyUsePosition
If True, the current position of the values in the list is used to sort the column in the report result
Public propertyValues
The list of values used for this enumerated list
Public propertyValuesPerConnection
If True, the enum loads and stores the values for each connection.
Top
Methods
  NameDescription
Public methodStatic memberCreate
Create a basic enumerated list
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetDisplayValue
Return the display value from the identifer
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetProperty
Get a property descriptor from a property name
(Inherited from RootEditor.)
Public methodGetSubSetValues
Returns the list of the enum values to display after applying filter and depencies
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValues
Public methodInit
Init the editor objects
(Inherited from RootEditor.)
Public methodInitDefaultValues
Init the default values
(Inherited from RootEditor.)
Public methodInitEditor
Init the editor objects and the default values
(Inherited from RootEditor.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRefreshEnum
Refresh the values of the enumerated list
Public methodSetReadOnly
Set all properties to readonly
(Inherited from RootEditor.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateEditor
Update editor attributes
(Inherited from RootEditor.)
Protected methodUpdateEditorAttributes (Overrides RootEditorUpdateEditorAttributes.)
Top
Fields
  NameDescription
Protected field_dctd (Inherited from RootEditor.)
Protected field_GUID (Inherited from RootComponent.)
Protected field_name (Inherited from RootComponent.)
Protected field_source
Public fieldIsEditable
True if the list is editable
Public fieldNewValues
New enum values set by the dynamic display Script
Top
See Also