Parameter Class

Parameters are used to configure report templates, outputs and repository security

Inheritance Hierarchy

Namespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 10.0.0.0+c1250b26c169a4ba4d702dc7579506e87ba2cd3a

Syntax

public class Parameter : RootComponent

The Parameter type exposes the following members.

Constructors

	Name	Description
	Parameter	Initializes a new instance of the Parameter class

Properties

	Name	Description
	BoolValue	The boolean parameter value
	ConfigObject	Default configuration value
	Description	The parameter description
	DisplayName	The parameter display name
	DoubleValue	The double parameter value
	EditorLanguage
	EnumDisplays	List of enum display values if the parameter is an enum
	Enums	List of string values if the parameter is an enum. Each enum can have an id and an optional display.
	EnumType
	EnumValue	The enum parameter value
	EnumValues	List of enum values if the parameter is an enum
	GUID	The unique identifier (Inherited from RootComponent)
	HelperResetParameterValue	Editor Helper: Reset parameter to its default value
	IconValue	The Font Awesome icon parameter value, edited with a glyph preview in the property grid.
	IsFontAwesomeIcon	True if this parameter holds a Font Awesome icon class (all its enum values are Font Awesome classes). Detected by content rather than by reference, because view parameters get a copy of the enum list.
	MultipleEnumValues
	Name	The name (Inherited from RootComponent)
	NumericValue	The numeric parameter value
	ResultOptionDisplayName	Display name when used as a result option paramter
	ResultOptionName	Name when used as a result option paramter
	ShowInResultOptions	If true, the parameter value can be modified in the report result dialog
	TextSamples
	TextValue	The text parameter value
	Type	Parameter type
	UseOnlyEnumValues	If true and the parameter is an enum, only the enum values defined can be selected
	Value	The parameter value

Methods

	Name	Description
	EnumGetDisplayFromValue	For an enum, returns the display text from the value
	EnumGetValueFromDisplay	For an enum, returns the value from the display text
	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)
	GetFontAwesomeIcon	Resolves a stored icon value to a Font Awesome 6 class. Values already in Font Awesome form (containing "fa-") are returned unchanged; legacy Bootstrap 3 Glyphicon names (optionally prefixed with "glyphicon-") are mapped; anything unknown falls back to a default icon.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	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)
	InitFromConfiguration	Init parameter values from a reference
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	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)
	AutoScrollParameter
	ChartAddNullPointParameter
	ColumnsHiddenParameter
	ConfigValue	String to store the default configuration value
	CSVUtf8Parameter
	DrillAllParameter
	DrillEnabledParameter
	EnableResultsMenuParameter
	FontAwesomeIcons	Distinct, sorted list of Font Awesome 6 icon classes available as icon enum values.
	ForceExecutionParameter
	ForceModelsLoad
	ForceRefreshParameter
	GlyphiconToFontAwesome	Maps each legacy Bootstrap 3 Glyphicon name to its Font Awesome 6 (Free) equivalent. Used to migrate stored icon values (e.g. widget_icon) after the Bootstrap 5 / FA6 migration, which dropped the Glyphicons font.
	NavigationView
	ReportFormatParameter
	RestrictionsExecView
	ResultOptionNameTabs
	ServerPaginationParameter
	SubReportsEnabledParameter