Class ParameterAttributeBase
Base class for attributes that are used to decorate properties (parameters) related to application settings (storage) or parameters (control) like query string parameters.
Inheritance
Namespace: DotNetNuke.Entities.Modules.Settings
Assembly: DotNetNuke.dll
Syntax
public abstract class ParameterAttributeBase : Attribute
Properties
| Improve this Doc View SourceIsSecure
Gets or sets a value indicating whether the settings should be stored securely. This encrypts the value of the parameter.
Declaration
public bool IsSecure { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ParameterName
Gets or sets the name of the setting that will be stored in the settings table.
Declaration
public string ParameterName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
If parametername is not defined, then the name of the property will be used. If a prefix is defined, then that will be concatenated with the parametername (or the property name if no parametername is provided).
Prefix
Gets or sets the prefix to use when naming the setting in the settings table.
Declaration
public string Prefix { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
The settings tables are shared by the core platform and the extensions. Extensions should use a unique prefix to ensure that name clashes do not occur with settings defined by the core or other extensions.
Serializer
Gets or sets the serializer to use when saving or retrieving the setting value.
Declaration
public string Serializer { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
The serializer must implement the ISettingsSerializer<T> interface.