Class ConfigRow

This table contains certain system-wide configuration values.
Row Object for table 'config'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
ConfigRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ConfigRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem
Remarks

Row objects can be created in several ways.

  • Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database.
  • You can create a (nested) ConfigRow ConfigRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(ConfigRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
  • For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
  • Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the ConfigTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ConfigTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Non-unique indexes are handled through the ConfigRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ConfigTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Config are:

Index fieldsNested index class name

Constructors

ConfigRow(ConfigRow.ConfigRowIdxBase)

Constructor for the class taking an index as argument. This table contains certain system-wide configuration values.

Declaration
protected ConfigRow(ConfigRow.ConfigRowIdxBase idx)
Parameters
Type Name Description
ConfigRow.ConfigRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAdminMail

Current value, see property AdminMail.

Declaration
protected string _currentAdminMail
Field Value
Type Description
String

_currentAttachmentPath

Current value, see property AttachmentPath.

Declaration
protected string _currentAttachmentPath
Field Value
Type Description
String

_currentAutologout

Current value, see property Autologout.

Declaration
protected int _currentAutologout
Field Value
Type Description
Int32

_currentCgiBin

Current value, see property CgiBin.

Declaration
protected string _currentCgiBin
Field Value
Type Description
String

_currentCgiUrl

Current value, see property CgiUrl.

Declaration
protected string _currentCgiUrl
Field Value
Type Description
String

_currentCgiUrlInternal

Current value, see property CgiUrlInternal.

Declaration
protected string _currentCgiUrlInternal
Field Value
Type Description
String

_currentConfigId

Current value, see property ConfigId.

Declaration
protected int _currentConfigId
Field Value
Type Description
Int32

_currentDebugFlags

Current value, see property DebugFlags.

Declaration
protected int _currentDebugFlags
Field Value
Type Description
Int32

_currentDefaultMail

Current value, see property DefaultMail.

Declaration
protected string _currentDefaultMail
Field Value
Type Description
String

_currentFeatureToggle

Current value, see property FeatureToggle.

Declaration
protected string _currentFeatureToggle
Field Value
Type Description
String

_currentFlags

Current value, see property Flags.

Declaration
protected int _currentFlags
Field Value
Type Description
Int32

_currentGfxUrl

Current value, see property GfxUrl.

Declaration
protected string _currentGfxUrl
Field Value
Type Description
String

_currentInstalledAt

Current value, see property InstalledAt.

Declaration
protected DateTime _currentInstalledAt
Field Value
Type Description
DateTime

_currentInstalledBy

Current value, see property InstalledBy.

Declaration
protected string _currentInstalledBy
Field Value
Type Description
String

_currentLanguage

Current value, see property Language.

Declaration
protected string _currentLanguage
Field Value
Type Description
String

_currentMailheader

Current value, see property Mailheader.

Declaration
protected string _currentMailheader
Field Value
Type Description
String

_currentMbMaxValue

Current value, see property MbMaxValue.

Declaration
protected int _currentMbMaxValue
Field Value
Type Description
Int32

_currentMbModifier

Current value, see property MbModifier.

Declaration
protected int _currentMbModifier
Field Value
Type Description
Int32

_currentMbThreshold

Current value, see property MbThreshold.

Declaration
protected int _currentMbThreshold
Field Value
Type Description
Int32

_currentPanicMail

Current value, see property PanicMail.

Declaration
protected string _currentPanicMail
Field Value
Type Description
String

_currentSimautologout

Current value, see property Simautologout.

Declaration
protected int _currentSimautologout
Field Value
Type Description
Int32

_currentSmtpHost

Current value, see property SmtpHost.

Declaration
protected string _currentSmtpHost
Field Value
Type Description
String

_currentSmtpPort

Current value, see property SmtpPort.

Declaration
protected int _currentSmtpPort
Field Value
Type Description
Int32

_currentTag

Current value, see property Tag.

Declaration
protected string _currentTag
Field Value
Type Description
String

_currentTemplatePath

Current value, see property TemplatePath.

Declaration
protected string _currentTemplatePath
Field Value
Type Description
String

_currentTempLicense

Current value, see property TempLicense.

Declaration
protected string _currentTempLicense
Field Value
Type Description
String

_currentTextPath

Current value, see property TextPath.

Declaration
protected string _currentTextPath
Field Value
Type Description
String

_currentUniqueId

Current value, see property UniqueId.

Declaration
protected string _currentUniqueId
Field Value
Type Description
String

_currentVersion

Current value, see property Version.

Declaration
protected string _currentVersion
Field Value
Type Description
String

_currentWarning

Current value, see property Warning.

Declaration
protected string _currentWarning
Field Value
Type Description
String

_persistedAdminMail

Persisted value, see property AdminMail.

Declaration
protected string _persistedAdminMail
Field Value
Type Description
String

_persistedAttachmentPath

Persisted value, see property AttachmentPath.

Declaration
protected string _persistedAttachmentPath
Field Value
Type Description
String

_persistedAutologout

Persisted value, see property Autologout.

Declaration
protected int _persistedAutologout
Field Value
Type Description
Int32

_persistedCgiBin

Persisted value, see property CgiBin.

Declaration
protected string _persistedCgiBin
Field Value
Type Description
String

_persistedCgiUrl

Persisted value, see property CgiUrl.

Declaration
protected string _persistedCgiUrl
Field Value
Type Description
String

_persistedCgiUrlInternal

Persisted value, see property CgiUrlInternal.

Declaration
protected string _persistedCgiUrlInternal
Field Value
Type Description
String

_persistedConfigId

Persisted value, see property ConfigId.

Declaration
protected int _persistedConfigId
Field Value
Type Description
Int32

_persistedDebugFlags

Persisted value, see property DebugFlags.

Declaration
protected int _persistedDebugFlags
Field Value
Type Description
Int32

_persistedDefaultMail

Persisted value, see property DefaultMail.

Declaration
protected string _persistedDefaultMail
Field Value
Type Description
String

_persistedFeatureToggle

Persisted value, see property FeatureToggle.

Declaration
protected string _persistedFeatureToggle
Field Value
Type Description
String

_persistedFlags

Persisted value, see property Flags.

Declaration
protected int _persistedFlags
Field Value
Type Description
Int32

_persistedGfxUrl

Persisted value, see property GfxUrl.

Declaration
protected string _persistedGfxUrl
Field Value
Type Description
String

_persistedInstalledAt

Persisted value, see property InstalledAt.

Declaration
protected DateTime _persistedInstalledAt
Field Value
Type Description
DateTime

_persistedInstalledBy

Persisted value, see property InstalledBy.

Declaration
protected string _persistedInstalledBy
Field Value
Type Description
String

_persistedLanguage

Persisted value, see property Language.

Declaration
protected string _persistedLanguage
Field Value
Type Description
String

_persistedMailheader

Persisted value, see property Mailheader.

Declaration
protected string _persistedMailheader
Field Value
Type Description
String

_persistedMbMaxValue

Persisted value, see property MbMaxValue.

Declaration
protected int _persistedMbMaxValue
Field Value
Type Description
Int32

_persistedMbModifier

Persisted value, see property MbModifier.

Declaration
protected int _persistedMbModifier
Field Value
Type Description
Int32

_persistedMbThreshold

Persisted value, see property MbThreshold.

Declaration
protected int _persistedMbThreshold
Field Value
Type Description
Int32

_persistedPanicMail

Persisted value, see property PanicMail.

Declaration
protected string _persistedPanicMail
Field Value
Type Description
String

_persistedSimautologout

Persisted value, see property Simautologout.

Declaration
protected int _persistedSimautologout
Field Value
Type Description
Int32

_persistedSmtpHost

Persisted value, see property SmtpHost.

Declaration
protected string _persistedSmtpHost
Field Value
Type Description
String

_persistedSmtpPort

Persisted value, see property SmtpPort.

Declaration
protected int _persistedSmtpPort
Field Value
Type Description
Int32

_persistedTag

Persisted value, see property Tag.

Declaration
protected string _persistedTag
Field Value
Type Description
String

_persistedTemplatePath

Persisted value, see property TemplatePath.

Declaration
protected string _persistedTemplatePath
Field Value
Type Description
String

_persistedTempLicense

Persisted value, see property TempLicense.

Declaration
protected string _persistedTempLicense
Field Value
Type Description
String

_persistedTextPath

Persisted value, see property TextPath.

Declaration
protected string _persistedTextPath
Field Value
Type Description
String

_persistedUniqueId

Persisted value, see property UniqueId.

Declaration
protected string _persistedUniqueId
Field Value
Type Description
String

_persistedVersion

Persisted value, see property Version.

Declaration
protected string _persistedVersion
Field Value
Type Description
String

_persistedWarning

Persisted value, see property Warning.

Declaration
protected string _persistedWarning
Field Value
Type Description
String

Properties

AdminMail

.NET type: string. The email address to the administrator of the system. E.g. ejournal-admin@company.com.

Declaration
public virtual string AdminMail { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

AttachmentPath

.NET type: string. The path to the folder containing the attachments.

Declaration
public virtual string AttachmentPath { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Autologout

.NET type: int. The number of minutes if idle time before a user is logged ut. A zero value means no autologout.

Declaration
public virtual int Autologout { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

CgiBin

.NET type: string. The cgi-bin alias used to access the executables through HTTP. E.g. '/bin'

Declaration
public virtual string CgiBin { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

CgiUrl

.NET type: string. The base URL to the system. E.g. 'http://ejournal.company.com'.

Declaration
public virtual string CgiUrl { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

CgiUrlInternal

.NET type: string. The internal base URL to the system. E.g. 'http://ejournal.company.com'.

Declaration
public virtual string CgiUrlInternal { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ConfigId

.NET type: int. The primary key (auto-incremented)

Declaration
public virtual int ConfigId { get; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: PK.

This field is the primary key and can only be read, never written.

This field is not protected by the Sentry system, and can always be read

ConfigTableInfo

Get the ConfigTableInfo object associated with the row.

Declaration
public ConfigTableInfo ConfigTableInfo { get; }
Property Value
Type Description
ConfigTableInfo

DebugFlags

.NET type: int. A default bitmask of flags controlling debug logging.

Declaration
public virtual int DebugFlags { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

DefaultMail

.NET type: string. The default from address in emails being sent from the system. E.g. support@company.com.

Declaration
public virtual string DefaultMail { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

FeatureToggle

.NET type: string. Temporary values used for feature toggles

Declaration
public virtual string FeatureToggle { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: Clob.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Flags

.NET type: int. A bitmask of flags controlling various options.

Declaration
public virtual int Flags { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

GfxUrl

.NET type: string. The base URL to the graphics files.

Declaration
public virtual string GfxUrl { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

InnerFieldValuePairs

The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name of the field returned from the Fields property.

Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type Description
ArgumentParameterCollection
Overrides

InnerPrimaryKey

The primary key needed to decide which specific row to alter with the current sql-command.

Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type Description
FieldInfo
Overrides

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides

InstalledAt

.NET type: DateTime. The timestamp of when the system was installed, or last upgraded.

Declaration
public virtual DateTime InstalledAt { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

InstalledBy

.NET type: string. Whoever installed the software.

Declaration
public virtual string InstalledBy { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

IsDirty

Is the row dirty, e.g. been modified since the last time it was saved to the database.

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
Boolean
Overrides

IsNew

Is this object new, meaning that it does not exist in the database.

Declaration
public override bool IsNew { get; }
Property Value
Type Description
Boolean
Overrides

Item[String]

Get or set a value based on the name of the field.

Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type Name Description
String fieldName

Name of the field in the database
Property Value
Type Description
Object

Value of the field.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

Language

.NET type: string. The systemlanguage. 'no' or 'en'.

Declaration
public virtual string Language { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[6].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Mailheader

.NET type: string. The default header used (i.e. line 1) in outbound email.

Declaration
public virtual string Mailheader { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

MbMaxValue

.NET type: int. This is the upper (initial) value for the spam-control algorithm, which makes sure that a single email address does not recieve too many emails.

Declaration
public virtual int MbMaxValue { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

MbModifier

.NET type: int. This is the 'cost' of sending an email, which is subtracted from the mb-value for the given email address. The mb-value is increased with 1 every second.

Declaration
public virtual int MbModifier { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

MbThreshold

.NET type: int. This is the treshold value for the spam-contol algorithm. When the value for a given email address is below this value, emails will be blocked.

Declaration
public virtual int MbThreshold { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

PanicMail

.NET type: string. The email address to where error messages are sent. Normally error@superoffice.com.

Declaration
public virtual string PanicMail { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Simautologout

.NET type: int. The number of minutes if idle time before a simultaneus user is logged ut. A zero value means no autologout.

Declaration
public virtual int Simautologout { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

SmtpHost

.NET type: string. The hostname or IP-address of the SMTP server used for sending email.

Declaration
public virtual string SmtpHost { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

SmtpPort

.NET type: int. The port of the SMTP server used for sending email.

Declaration
public virtual int SmtpPort { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.
Overrides

Tag

.NET type: string. The tag used as ticket id identificator in the subject of emails.

Declaration
public virtual string Tag { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[33].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TemplatePath

.NET type: string. The path to the templates used for the customer front-end.

Declaration
public virtual string TemplatePath { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TempLicense

.NET type: string. Temporary license key created for this session.

Declaration
public virtual string TempLicense { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TextPath

.NET type: string. The path to the text-folder containing the emailBackup, trashbin, etc. subfolders.

Declaration
public virtual string TextPath { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

UniqueId

.NET type: string. An ID that should be unique for all eJournal installations.

Declaration
public virtual string UniqueId { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[33].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Version

.NET type: string. The version of the installed software.

Declaration
public virtual string Version { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[33].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Warning

.NET type: string. The path + leading filename for the warning logfiles.

Declaration
public virtual string Warning { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Methods

CreateNew()

Create a new instance of the ConfigRow object. This table contains certain system-wide configuration values.

Declaration
public static ConfigRow CreateNew()
Returns
Type Description
ConfigRow

A new instance of the ConfigRow object.

GetFromCustomSearch(ConfigRow.CustomSearch)

Create a new instance of the ConfigRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).

Declaration
public static ConfigRow GetFromCustomSearch(ConfigRow.CustomSearch query)
Parameters
Type Name Description
ConfigRow.CustomSearch query

The custom search to execute against the database
Returns
Type Description
ConfigRow

A new instance of the ConfigRow object, reflecting the result of the query.

GetFromIdxConfigId(Int32)

Create a new instance of the ConfigRow object, by querying the database table via the index 'IDXConfigId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static ConfigRow GetFromIdxConfigId(int configId)
Parameters
Type Name Description
Int32 configId
Returns
Type Description
ConfigRow

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the Config table. Non-unique indexes have corresponding inner classes and methods in the ConfigRows collection, since they may return more than one row.

GetFromReader(SoDataReader, ConfigTableInfo)

Create a new instance of the ConfigRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. This table contains certain system-wide configuration values.

Declaration
public static ConfigRow GetFromReader(SoDataReader reader, ConfigTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ConfigTableInfo tableInfo

ConfigTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.
Returns
Type Description
ConfigRow

A new instance of the ConfigRow object.

GetPersistedFieldValue(FieldInfo)

Get the persisted value of a field.

Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Object

Field value, such as an int, DateTime, string ... Null can be returned if the value is not known.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

InternalSetValue(String, Object)

Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type Name Description
String fieldName
Object value
Overrides

IsPersistedFieldValueKnown(FieldInfo)

Check if the persisted value for a field is known.

Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Boolean

True if the value is known and sentry permits read.
Overrides

OnLoad(SoDataReader, TableInfo)

Fill the object with data returned from the database.

Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

Object holding the data returned from the database.
TableInfo tableInfo

The TableInfo used for the SELECT statement.
Overrides

OnSave(BatchSave)

Add the object to the BatchSave list if it needs saving.

Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type Name Description
BatchSave batchSave

Collection of objects to be saved within the transaction.
Overrides
Remarks

Classes overriding this method should call it.

OnSaved(Boolean)

Method called after the save operation has been performed.

Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type Name Description
Boolean bSucceeded

True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back)
Overrides

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
Remarks

If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.

SetDefaults(DefaulterStrategy)

Set default values for the row.

Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type Name Description
DefaulterStrategy strategy

Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle
Overrides

SetPrimaryKey(Int32)

Set the primary key for the row.

Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type Name Description
Int32 primaryKey

The new primary key for the row.
Overrides

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides

ToString()

ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Validate(RowValidator)

Validate this row.

Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type Name Description
RowValidator rowValidator

RowValidator for inserting the result of the validation
Overrides

Events

_onAdminMailChange

Change envent for property AdminMail; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onAdminMailChange
Event Type
Type Description
OnFieldChange<String>

_onAttachmentPathChange

Change envent for property AttachmentPath; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onAttachmentPathChange
Event Type
Type Description
OnFieldChange<String>

_onAutologoutChange

Change envent for property Autologout; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onAutologoutChange
Event Type
Type Description
OnFieldChange<Int32>

_onCgiBinChange

Change envent for property CgiBin; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onCgiBinChange
Event Type
Type Description
OnFieldChange<String>

_onCgiUrlChange

Change envent for property CgiUrl; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onCgiUrlChange
Event Type
Type Description
OnFieldChange<String>

_onCgiUrlInternalChange

Change envent for property CgiUrlInternal; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onCgiUrlInternalChange
Event Type
Type Description
OnFieldChange<String>

_onDebugFlagsChange

Change envent for property DebugFlags; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onDebugFlagsChange
Event Type
Type Description
OnFieldChange<Int32>

_onDefaultMailChange

Change envent for property DefaultMail; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onDefaultMailChange
Event Type
Type Description
OnFieldChange<String>

_onFeatureToggleChange

Change envent for property FeatureToggle; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onFeatureToggleChange
Event Type
Type Description
OnFieldChange<String>

_onFlagsChange

Change envent for property Flags; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onFlagsChange
Event Type
Type Description
OnFieldChange<Int32>

_onGfxUrlChange

Change envent for property GfxUrl; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onGfxUrlChange
Event Type
Type Description
OnFieldChange<String>

_onInstalledAtChange

Change envent for property InstalledAt; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onInstalledAtChange
Event Type
Type Description
OnFieldChange<DateTime>

_onInstalledByChange

Change envent for property InstalledBy; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onInstalledByChange
Event Type
Type Description
OnFieldChange<String>

_onLanguageChange

Change envent for property Language; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onLanguageChange
Event Type
Type Description
OnFieldChange<String>

_onMailheaderChange

Change envent for property Mailheader; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onMailheaderChange
Event Type
Type Description
OnFieldChange<String>

_onMbMaxValueChange

Change envent for property MbMaxValue; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onMbMaxValueChange
Event Type
Type Description
OnFieldChange<Int32>

_onMbModifierChange

Change envent for property MbModifier; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onMbModifierChange
Event Type
Type Description
OnFieldChange<Int32>

_onMbThresholdChange

Change envent for property MbThreshold; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onMbThresholdChange
Event Type
Type Description
OnFieldChange<Int32>

_onPanicMailChange

Change envent for property PanicMail; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onPanicMailChange
Event Type
Type Description
OnFieldChange<String>

_onSimautologoutChange

Change envent for property Simautologout; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onSimautologoutChange
Event Type
Type Description
OnFieldChange<Int32>

_onSmtpHostChange

Change envent for property SmtpHost; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onSmtpHostChange
Event Type
Type Description
OnFieldChange<String>

_onSmtpPortChange

Change envent for property SmtpPort; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onSmtpPortChange
Event Type
Type Description
OnFieldChange<Int32>

_onTagChange

Change envent for property Tag; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onTagChange
Event Type
Type Description
OnFieldChange<String>

_onTemplatePathChange

Change envent for property TemplatePath; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onTemplatePathChange
Event Type
Type Description
OnFieldChange<String>

_onTempLicenseChange

Change envent for property TempLicense; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onTempLicenseChange
Event Type
Type Description
OnFieldChange<String>

_onTextPathChange

Change envent for property TextPath; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onTextPathChange
Event Type
Type Description
OnFieldChange<String>

_onUniqueIdChange

Change envent for property UniqueId; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onUniqueIdChange
Event Type
Type Description
OnFieldChange<String>

_onVersionChange

Change envent for property Version; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onVersionChange
Event Type
Type Description
OnFieldChange<String>

_onWarningChange

Change envent for property Warning; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onWarningChange
Event Type
Type Description
OnFieldChange<String>

OnAdminMailChange

Event raised when AdminMail is changing.

Declaration
public event OnFieldChange<string> OnAdminMailChange
Event Type
Type Description
OnFieldChange<String>

OnAttachmentPathChange

Event raised when AttachmentPath is changing.

Declaration
public event OnFieldChange<string> OnAttachmentPathChange
Event Type
Type Description
OnFieldChange<String>

OnAutologoutChange

Event raised when Autologout is changing.

Declaration
public event OnFieldChange<int> OnAutologoutChange
Event Type
Type Description
OnFieldChange<Int32>

OnCgiBinChange

Event raised when CgiBin is changing.

Declaration
public event OnFieldChange<string> OnCgiBinChange
Event Type
Type Description
OnFieldChange<String>

OnCgiUrlChange

Event raised when CgiUrl is changing.

Declaration
public event OnFieldChange<string> OnCgiUrlChange
Event Type
Type Description
OnFieldChange<String>

OnCgiUrlInternalChange

Event raised when CgiUrlInternal is changing.

Declaration
public event OnFieldChange<string> OnCgiUrlInternalChange
Event Type
Type Description
OnFieldChange<String>

OnDebugFlagsChange

Event raised when DebugFlags is changing.

Declaration
public event OnFieldChange<int> OnDebugFlagsChange
Event Type
Type Description
OnFieldChange<Int32>

OnDefaultMailChange

Event raised when DefaultMail is changing.

Declaration
public event OnFieldChange<string> OnDefaultMailChange
Event Type
Type Description
OnFieldChange<String>

OnFeatureToggleChange

Event raised when FeatureToggle is changing.

Declaration
public event OnFieldChange<string> OnFeatureToggleChange
Event Type
Type Description
OnFieldChange<String>

OnFlagsChange

Event raised when Flags is changing.

Declaration
public event OnFieldChange<int> OnFlagsChange
Event Type
Type Description
OnFieldChange<Int32>

OnGfxUrlChange

Event raised when GfxUrl is changing.

Declaration
public event OnFieldChange<string> OnGfxUrlChange
Event Type
Type Description
OnFieldChange<String>

OnInstalledAtChange

Event raised when InstalledAt is changing.

Declaration
public event OnFieldChange<DateTime> OnInstalledAtChange
Event Type
Type Description
OnFieldChange<DateTime>

OnInstalledByChange

Event raised when InstalledBy is changing.

Declaration
public event OnFieldChange<string> OnInstalledByChange
Event Type
Type Description
OnFieldChange<String>

OnLanguageChange

Event raised when Language is changing.

Declaration
public event OnFieldChange<string> OnLanguageChange
Event Type
Type Description
OnFieldChange<String>

OnMailheaderChange

Event raised when Mailheader is changing.

Declaration
public event OnFieldChange<string> OnMailheaderChange
Event Type
Type Description
OnFieldChange<String>

OnMbMaxValueChange

Event raised when MbMaxValue is changing.

Declaration
public event OnFieldChange<int> OnMbMaxValueChange
Event Type
Type Description
OnFieldChange<Int32>

OnMbModifierChange

Event raised when MbModifier is changing.

Declaration
public event OnFieldChange<int> OnMbModifierChange
Event Type
Type Description
OnFieldChange<Int32>

OnMbThresholdChange

Event raised when MbThreshold is changing.

Declaration
public event OnFieldChange<int> OnMbThresholdChange
Event Type
Type Description
OnFieldChange<Int32>

OnPanicMailChange

Event raised when PanicMail is changing.

Declaration
public event OnFieldChange<string> OnPanicMailChange
Event Type
Type Description
OnFieldChange<String>

OnSimautologoutChange

Event raised when Simautologout is changing.

Declaration
public event OnFieldChange<int> OnSimautologoutChange
Event Type
Type Description
OnFieldChange<Int32>

OnSmtpHostChange

Event raised when SmtpHost is changing.

Declaration
public event OnFieldChange<string> OnSmtpHostChange
Event Type
Type Description
OnFieldChange<String>

OnSmtpPortChange

Event raised when SmtpPort is changing.

Declaration
public event OnFieldChange<int> OnSmtpPortChange
Event Type
Type Description
OnFieldChange<Int32>

OnTagChange

Event raised when Tag is changing.

Declaration
public event OnFieldChange<string> OnTagChange
Event Type
Type Description
OnFieldChange<String>

OnTemplatePathChange

Event raised when TemplatePath is changing.

Declaration
public event OnFieldChange<string> OnTemplatePathChange
Event Type
Type Description
OnFieldChange<String>

OnTempLicenseChange

Event raised when TempLicense is changing.

Declaration
public event OnFieldChange<string> OnTempLicenseChange
Event Type
Type Description
OnFieldChange<String>

OnTextPathChange

Event raised when TextPath is changing.

Declaration
public event OnFieldChange<string> OnTextPathChange
Event Type
Type Description
OnFieldChange<String>

OnUniqueIdChange

Event raised when UniqueId is changing.

Declaration
public event OnFieldChange<string> OnUniqueIdChange
Event Type
Type Description
OnFieldChange<String>

OnVersionChange

Event raised when Version is changing.

Declaration
public event OnFieldChange<string> OnVersionChange
Event Type
Type Description
OnFieldChange<String>

OnWarningChange

Event raised when Warning is changing.

Declaration
public event OnFieldChange<string> OnWarningChange
Event Type
Type Description
OnFieldChange<String>

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)