SettingDefinition Class

Class to store a settingdefinition in.

Inheritance Hierarchy

SystemObject
SD.LLBLGen.Pro.ApplicationCore.CodeGenerationMetaData.FrameworksSettingDefinition

Namespace: SD.LLBLGen.Pro.ApplicationCore.CodeGenerationMetaData.Frameworks
Assembly: SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

public class SettingDefinition

Public Class SettingDefinition

The SettingDefinition type exposes the following members.

Constructors

	Name	Description
	SettingDefinition	Initializes a new instance of the SettingDefinition class.

Top

Properties

	Name	Description
	CanBeEmpty	Gets or sets a value indicating whether this instance can be the empty string. Only used with string based setting definitions. Default is true.
	Category	Gets or sets the category.
	Default	Gets or sets the default value for the setting. Should be convertable to the type specified
	DefaultSource	Gets or sets the name of the source to obtain the default value from. This name is the name of a setting instance.
	Description	Gets or sets the description.
	EnumType	Gets or sets the type instance of the enum type if Type is set to 'enum' and source is set to the name of the enum type instance.
	IsVisible	Gets or sets a value indicating whether this setting is visible in the UI. Default is true. Set to false for settings which should be used during code generation but shouldn't be editable by the user.
	LegacyDefault	Gets or sets the default value for the setting, if the targetframeworkholder container (e.g. the project) is set to use legacy defaults. Should be convertable to the type specified. The value of this property is equal to 'Default' if no legacydefault is defined in the frameworksettings file for this setting. If legacy defaults have to be used, this value is used as 'the default' in the SettingDefinition clone returned by the framework instance instead of the value 'Default'. Legacy defaults are used unless the targetframework is set to a new framework in the targetframeworkholder.
	Name	Gets or sets the name.
	Source	Gets or sets the name of the source for the values for this setting. If type is a string, this is a valuelist name and if type is an enum, this is the enum type name. Can be empty
	TargetElement	Gets or sets the target element for which this setting definition is to be used for.
	Type	Gets or sets the type of the setting. This is a shortcut (string, bool, int, enum)

Top

Methods

	Name	Description
	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.)
	GetDefaultAsRealValue	Gets the default as a real value of the type of this settingdefinition. If the default is empty, null is returned
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetSettingType	Gets the setting Type as Type instance.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

SD.LLBLGen.Pro.ApplicationCore.CodeGenerationMetaData.Frameworks Namespace