Show / Hide Table of Contents

Class MsFilterRow

This table contains email filters. These are the filters allowing you to do advanced parsing of incomming emails.
Row Object for table 'ms_filter'. 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
MsFilterRow
Implements
INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem
Inherited Members
TableRowBase._saveOwner
TableRowBase._sentries
TableRowBase._onValueChange
TableRowBase._relatedNestedPersistMembers
TableRowBase._sqlType
TableRowBase.InternalSetValue(Int32, Object)
TableRowBase.InternalSetValue(SoField, Object)
TableRowBase.GetFieldValue(FieldInfo)
TableRowBase.GetKnownFields()
TableRowBase.ISoDataLookup.GetPersistedFieldValue(FieldInfo)
TableRowBase.ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo)
TableRowBase.IsGhostField(FieldInfo)
TableRowBase.RowLoad()
TableRowBase.RowLoad(ITableRowLoadHandler)
TableRowBase.OnLoaded(IdxBase)
TableRowBase.Load(IdxBase, SoDataReader)
TableRowBase.Load(SoDataReader, TableInfo)
TableRowBase.SetDefaults()
TableRowBase.SetDefaults(DashboardTileDefinitionRow, String)
TableRowBase.SetSaveOwner(INestedPersist)
TableRowBase.Save()
TableRowBase.Delete()
TableRowBase.Validate()
TableRowBase.SetDirty(Int32, Object, Object)
TableRowBase.INestedPersist.OnPreIdUpdate()
TableRowBase.INestedPersist.OnPrimaryKeyRequest(PKContainer)
TableRowBase.INestedPersist.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.INestedPersist.OnIdUpdate()
TableRowBase.INestedPersist.OnSave(BatchSave)
TableRowBase.INestedPersist.OnSaved(Boolean)
TableRowBase.OnPreIdUpdate()
TableRowBase.OnPrimaryKeyRequest(PKContainer)
TableRowBase.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.OnIdUpdate()
TableRowBase.BeginIgnoreSentryCheck()
TableRowBase.EndIgnoreSentryCheck()
TableRowBase.GetRelatedNestedPersist()
TableRowBase.Item[Int32]
TableRowBase.Item[SoField]
TableRowBase.Sentries
TableRowBase.ForeignKeyHelper
TableRowBase.IsDeleted
TableRowBase.IsSaving
TableRowBase.SqlType
TableRowBase.IsSentryIgnored
TableRowBase.IsMarkedForDelete
TableRowBase.OnValueChanged
TableRowBase.OnElementSaved
TableRowBase.OnElementIdUpdate
PrivateSave.GetTableInfos()
PrivateSave.CloneToBasicUpdatingQuery()
PrivateSave.OnUpdateField
SqlCommand.Origin
SqlCommand.AddIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.AddIgnoreAutoSentryTableInfo(IEnumerable<TableInfo>)
SqlCommand.RemoveIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.ClearIgnoreAutoSentryTableInfos()
SqlCommand.IsAutoSentryIgnoredOnTableInfo(TableInfo)
SqlCommand.GetPrivateSaves()
SqlCommand.GetInserts()
SqlCommand.GetUpdates()
SqlCommand.GetDeletes()
SqlCommand.GetSelect()
SqlCommand.AutoSentryIgnoredTables
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MsFilterRow : 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) MsFilterRow MsFilterRow.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(MsFilterRow.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 MsFilterTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, MsFilterTableInfo) 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 MsFilterRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, MsFilterTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table MsFilter are:

Index fieldsNested index class name

Constructors

MsFilterRow(MsFilterRow.MsFilterRowIdxBase)

Constructor for the class taking an index as argument. This table contains email filters. These are the filters allowing you to do advanced parsing of incomming emails.

Declaration
protected MsFilterRow(MsFilterRow.MsFilterRowIdxBase idx)
Parameters
Type Name Description
MsFilterRow.MsFilterRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAction

Current value, see property Action.

Declaration
protected int _currentAction
Field Value
Type Description
Int32

_currentActionWhen

Current value, see property ActionWhen.

Declaration
protected short _currentActionWhen
Field Value
Type Description
Int16

_currentAutofaqReplyCategory

Current value, see property AutofaqReplyCategory.

Declaration
protected int _currentAutofaqReplyCategory
Field Value
Type Description
Int32

_currentBodyTemplate

Current value, see property BodyTemplate.

Declaration
protected int _currentBodyTemplate
Field Value
Type Description
Int32

_currentDescription

Current value, see property Description.

Declaration
protected string _currentDescription
Field Value
Type Description
String

_currentEjscript

Current value, see property Ejscript.

Declaration
protected int _currentEjscript
Field Value
Type Description
Int32

_currentFlags

Current value, see property Flags.

Declaration
protected int _currentFlags
Field Value
Type Description
Int32

_currentForwardTo

Current value, see property ForwardTo.

Declaration
protected string _currentForwardTo
Field Value
Type Description
String

_currentMsFilterId

Current value, see property MsFilterId.

Declaration
protected int _currentMsFilterId
Field Value
Type Description
Int32

_currentNewCategory

Current value, see property NewCategory.

Declaration
protected int _currentNewCategory
Field Value
Type Description
Int32

_currentNewOwner

Current value, see property NewOwner.

Declaration
protected int _currentNewOwner
Field Value
Type Description
Int32

_currentNewPriority

Current value, see property NewPriority.

Declaration
protected int _currentNewPriority
Field Value
Type Description
Int32

_currentNewSlevel

Current value, see property NewSlevel.

Declaration
protected int _currentNewSlevel
Field Value
Type Description
Int32

_currentParseMode

Current value, see property ParseMode.

Declaration
protected short _currentParseMode
Field Value
Type Description
Int16

_currentPriority

Current value, see property Priority.

Declaration
protected int _currentPriority
Field Value
Type Description
Int32

_currentReplyTemplate

Current value, see property ReplyTemplate.

Declaration
protected int _currentReplyTemplate
Field Value
Type Description
Int32

_currentReplyTo

Current value, see property ReplyTo.

Declaration
protected string _currentReplyTo
Field Value
Type Description
String

_currentReplyToSms

Current value, see property ReplyToSms.

Declaration
protected string _currentReplyToSms
Field Value
Type Description
String

_currentSearchLocation

Current value, see property SearchLocation.

Declaration
protected short _currentSearchLocation
Field Value
Type Description
Int16

_currentSearchString

Current value, see property SearchString.

Declaration
protected string _currentSearchString
Field Value
Type Description
String

_currentSearchString2

Current value, see property SearchString2.

Declaration
protected string _currentSearchString2
Field Value
Type Description
String

_persistedAction

Persisted value, see property Action.

Declaration
protected int _persistedAction
Field Value
Type Description
Int32

_persistedActionWhen

Persisted value, see property ActionWhen.

Declaration
protected short _persistedActionWhen
Field Value
Type Description
Int16

_persistedAutofaqReplyCategory

Persisted value, see property AutofaqReplyCategory.

Declaration
protected int _persistedAutofaqReplyCategory
Field Value
Type Description
Int32

_persistedBodyTemplate

Persisted value, see property BodyTemplate.

Declaration
protected int _persistedBodyTemplate
Field Value
Type Description
Int32

_persistedDescription

Persisted value, see property Description.

Declaration
protected string _persistedDescription
Field Value
Type Description
String

_persistedEjscript

Persisted value, see property Ejscript.

Declaration
protected int _persistedEjscript
Field Value
Type Description
Int32

_persistedFlags

Persisted value, see property Flags.

Declaration
protected int _persistedFlags
Field Value
Type Description
Int32

_persistedForwardTo

Persisted value, see property ForwardTo.

Declaration
protected string _persistedForwardTo
Field Value
Type Description
String

_persistedMsFilterId

Persisted value, see property MsFilterId.

Declaration
protected int _persistedMsFilterId
Field Value
Type Description
Int32

_persistedNewCategory

Persisted value, see property NewCategory.

Declaration
protected int _persistedNewCategory
Field Value
Type Description
Int32

_persistedNewOwner

Persisted value, see property NewOwner.

Declaration
protected int _persistedNewOwner
Field Value
Type Description
Int32

_persistedNewPriority

Persisted value, see property NewPriority.

Declaration
protected int _persistedNewPriority
Field Value
Type Description
Int32

_persistedNewSlevel

Persisted value, see property NewSlevel.

Declaration
protected int _persistedNewSlevel
Field Value
Type Description
Int32

_persistedParseMode

Persisted value, see property ParseMode.

Declaration
protected short _persistedParseMode
Field Value
Type Description
Int16

_persistedPriority

Persisted value, see property Priority.

Declaration
protected int _persistedPriority
Field Value
Type Description
Int32

_persistedReplyTemplate

Persisted value, see property ReplyTemplate.

Declaration
protected int _persistedReplyTemplate
Field Value
Type Description
Int32

_persistedReplyTo

Persisted value, see property ReplyTo.

Declaration
protected string _persistedReplyTo
Field Value
Type Description
String

_persistedReplyToSms

Persisted value, see property ReplyToSms.

Declaration
protected string _persistedReplyToSms
Field Value
Type Description
String

_persistedSearchLocation

Persisted value, see property SearchLocation.

Declaration
protected short _persistedSearchLocation
Field Value
Type Description
Int16

_persistedSearchString

Persisted value, see property SearchString.

Declaration
protected string _persistedSearchString
Field Value
Type Description
String

_persistedSearchString2

Persisted value, see property SearchString2.

Declaration
protected string _persistedSearchString2
Field Value
Type Description
String

Properties

Action

.NET type: int. A bitmask representing the actions that should be performed if this filter is executed.

Declaration
public virtual int Action { 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

ActionWhen

.NET type: short. Enum indicating what should trigger this filter.

Declaration
public virtual short ActionWhen { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Enum.

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

AutofaqReplyCategory

.NET type: int. The root folder for the auto faq search.

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

Original type in dictionary: FK.

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

BodyTemplate

.NET type: int. The template to use for the body of the message.

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

Original type in dictionary: FK.

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

Description

.NET type: string. A description for this filter.

Declaration
public virtual string Description { 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

Ejscript

.NET type: int. The reference to the ejscript to execute for this filter.

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

Original type in dictionary: FK.

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. Flags

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

ForwardTo

.NET type: string. An email address to forward the ticket to.

Declaration
public virtual string ForwardTo { 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
PrivateSave.InnerFieldValuePairs

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
PrivateSave.InnerPrimaryKey

InnerPrimaryKeyValue

The actual value the primary key must have.

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

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
TableRowBase.IsDirty

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
TableRowBase.IsNew

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
TableRowBase.Item[String]
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

MsFilterId

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

Declaration
public virtual int MsFilterId { 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

MsFilterTableInfo

Get the MsFilterTableInfo object associated with the row.

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

NewCategory

.NET type: int. The id of the category to set for the ticket if specified by action.

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

Original type in dictionary: FK.

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

NewOwner

.NET type: int. The id of the owner to set for the ticket if specified by action.

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

Original type in dictionary: FK.

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

NewPriority

.NET type: int. The id of the priority to set for the ticket if specified by action.

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

Original type in dictionary: FK.

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

NewSlevel

.NET type: int. The security level to set for the ticket if specified by action.

Declaration
public virtual int NewSlevel { 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

ParseMode

.NET type: short. If automatic parsing this column indicate mode

Declaration
public virtual short ParseMode { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Short.

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

Priority

.NET type: int. A number indicating the priority for this filter (0..10).

Declaration
public virtual int Priority { 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

ReplyTemplate

.NET type: int. The id of the template to use as the reply template if specified by action.

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

Original type in dictionary: FK.

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

ReplyTo

.NET type: string. The email address to reply to.

Declaration
public virtual string ReplyTo { 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

ReplyToSms

.NET type: string. The SMS number to reply to.

Declaration
public virtual string ReplyToSms { 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

SearchLocation

.NET type: short. Enum indicating where to search.

Declaration
public virtual short SearchLocation { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Enum.

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

SearchString

.NET type: string. The string to search for.

Declaration
public virtual string SearchString { 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

SearchString2

.NET type: string. A second string to search for. Only used if not empty.

Declaration
public virtual string SearchString2 { 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

TableInfo

Get the TableInfo for the table.

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

The TableInfo for the table.

Overrides
TableRowBase.TableInfo

Methods

CreateNew()

Create a new instance of the MsFilterRow object. This table contains email filters. These are the filters allowing you to do advanced parsing of incomming emails.

Declaration
public static MsFilterRow CreateNew()
Returns
Type Description
MsFilterRow

A new instance of the MsFilterRow object.

GetFromCustomSearch(MsFilterRow.CustomSearch)

Create a new instance of the MsFilterRow 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 MsFilterRow GetFromCustomSearch(MsFilterRow.CustomSearch query)
Parameters
Type Name Description
MsFilterRow.CustomSearch query

The custom search to execute against the database

Returns
Type Description
MsFilterRow

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

GetFromIdxMsFilterId(Int32)

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

Declaration
public static MsFilterRow GetFromIdxMsFilterId(int msFilterId)
Parameters
Type Name Description
Int32 msFilterId
Returns
Type Description
MsFilterRow

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromReader(SoDataReader, MsFilterTableInfo)

Create a new instance of the MsFilterRow 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 email filters. These are the filters allowing you to do advanced parsing of incomming emails.

Declaration
public static MsFilterRow GetFromReader(SoDataReader reader, MsFilterTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

MsFilterTableInfo tableInfo

MsFilterTableInfo 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
MsFilterRow

A new instance of the MsFilterRow 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
PrivateSave.GetPersistedFieldValue(FieldInfo)
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
TableRowBase.InternalSetValue(String, Object)

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
PrivateSave.IsPersistedFieldValueKnown(FieldInfo)

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
TableRowBase.OnLoad(SoDataReader, TableInfo)

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
TableRowBase.OnSave(BatchSave)
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
TableRowBase.OnSaved(Boolean)

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
TableRowBase.Reset()
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
TableRowBase.SetDefaults(DefaulterStrategy)

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
TableRowBase.SetPrimaryKey(Int32)

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides
TableRowBase.SetRowAsNew()

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
Object.ToString()

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
TableRowBase.Validate(RowValidator)

Events

_onActionChange

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

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

_onActionWhenChange

Change envent for property ActionWhen; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onActionWhenChange
Event Type
Type Description
OnFieldChange<Int16>

_onAutofaqReplyCategoryChange

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

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

_onBodyTemplateChange

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

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

_onDescriptionChange

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

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

_onEjscriptChange

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

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

_onFlagsChange

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

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

_onForwardToChange

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

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

_onNewCategoryChange

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

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

_onNewOwnerChange

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

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

_onNewPriorityChange

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

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

_onNewSlevelChange

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

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

_onParseModeChange

Change envent for property ParseMode; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onParseModeChange
Event Type
Type Description
OnFieldChange<Int16>

_onPriorityChange

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

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

_onReplyTemplateChange

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

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

_onReplyToChange

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

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

_onReplyToSmsChange

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

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

_onSearchLocationChange

Change envent for property SearchLocation; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onSearchLocationChange
Event Type
Type Description
OnFieldChange<Int16>

_onSearchString2Change

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

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

_onSearchStringChange

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

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

OnActionChange

Event raised when Action is changing.

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

OnActionWhenChange

Event raised when ActionWhen is changing.

Declaration
public event OnFieldChange<short> OnActionWhenChange
Event Type
Type Description
OnFieldChange<Int16>

OnAutofaqReplyCategoryChange

Event raised when AutofaqReplyCategory is changing.

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

OnBodyTemplateChange

Event raised when BodyTemplate is changing.

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

OnDescriptionChange

Event raised when Description is changing.

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

OnEjscriptChange

Event raised when Ejscript is changing.

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

OnFlagsChange

Event raised when Flags is changing.

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

OnForwardToChange

Event raised when ForwardTo is changing.

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

OnNewCategoryChange

Event raised when NewCategory is changing.

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

OnNewOwnerChange

Event raised when NewOwner is changing.

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

OnNewPriorityChange

Event raised when NewPriority is changing.

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

OnNewSlevelChange

Event raised when NewSlevel is changing.

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

OnParseModeChange

Event raised when ParseMode is changing.

Declaration
public event OnFieldChange<short> OnParseModeChange
Event Type
Type Description
OnFieldChange<Int16>

OnPriorityChange

Event raised when Priority is changing.

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

OnReplyTemplateChange

Event raised when ReplyTemplate is changing.

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

OnReplyToChange

Event raised when ReplyTo is changing.

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

OnReplyToSmsChange

Event raised when ReplyToSms is changing.

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

OnSearchLocationChange

Event raised when SearchLocation is changing.

Declaration
public event OnFieldChange<short> OnSearchLocationChange
Event Type
Type Description
OnFieldChange<Int16>

OnSearchString2Change

Event raised when SearchString2 is changing.

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

OnSearchStringChange

Event raised when SearchString is changing.

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

Implements

INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)
QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)
QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)
QueryExectionExtensions.ExecuteNonQuery(SqlCommand)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top