Show / Hide Table of Contents

Class FormRow

A form which can be published on a webpage and submitted by visitors
Row Object for table 'form'. 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
FormRow
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 FormRow : 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) FormRow FormRow.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(FormRow.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 FormTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, FormTableInfo) 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 FormRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, FormTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Form are:

Index fieldsNested index class name

Constructors

FormRow(FormRow.FormRowIdxBase)

Constructor for the class taking an index as argument. A form which can be published on a webpage and submitted by visitors

Declaration
protected FormRow(FormRow.FormRowIdxBase idx)
Parameters
Type Name Description
FormRow.FormRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentActive

Current value, see property Active.

Declaration
protected short _currentActive
Field Value
Type Description
Int16

_currentConfig

Current value, see property Config.

Declaration
protected string _currentConfig
Field Value
Type Description
String

_currentDescription

Current value, see property Description.

Declaration
protected string _currentDescription
Field Value
Type Description
String

_currentExpires

Current value, see property Expires.

Declaration
protected DateTime _currentExpires
Field Value
Type Description
DateTime

_currentFolderId

Current value, see property FolderId.

Declaration
protected int _currentFolderId
Field Value
Type Description
Int32

_currentFormId

Current value, see property FormId.

Declaration
protected int _currentFormId
Field Value
Type Description
Int32

_currentFormKey

Current value, see property FormKey.

Declaration
protected string _currentFormKey
Field Value
Type Description
String

_currentGroupId

Current value, see property GroupId.

Declaration
protected int _currentGroupId
Field Value
Type Description
Int32

_currentMaxSubmits

Current value, see property MaxSubmits.

Declaration
protected int _currentMaxSubmits
Field Value
Type Description
Int32

_currentName

Current value, see property Name.

Declaration
protected string _currentName
Field Value
Type Description
String

_currentNewTicket

Current value, see property NewTicket.

Declaration
protected short _currentNewTicket
Field Value
Type Description
Int16

_currentRecipe

Current value, see property Recipe.

Declaration
protected string _currentRecipe
Field Value
Type Description
String

_currentRegistered

Current value, see property Registered.

Declaration
protected DateTime _currentRegistered
Field Value
Type Description
DateTime

_currentRegisteredAssociateId

Current value, see property RegisteredAssociateId.

Declaration
protected int _currentRegisteredAssociateId
Field Value
Type Description
Int32

_currentResponseShipmentId

Current value, see property ResponseShipmentId.

Declaration
protected int _currentResponseShipmentId
Field Value
Type Description
Int32

_currentScriptId

Current value, see property ScriptId.

Declaration
protected int _currentScriptId
Field Value
Type Description
Int32

_currentType

Current value, see property Type.

Declaration
protected FormType _currentType
Field Value
Type Description
FormType

_currentUpdated

Current value, see property Updated.

Declaration
protected DateTime _currentUpdated
Field Value
Type Description
DateTime

_currentUpdatedAssociateId

Current value, see property UpdatedAssociateId.

Declaration
protected int _currentUpdatedAssociateId
Field Value
Type Description
Int32

_currentUpdatedCount

Current value, see property UpdatedCount.

Declaration
protected short _currentUpdatedCount
Field Value
Type Description
Int16

_persistedActive

Persisted value, see property Active.

Declaration
protected short _persistedActive
Field Value
Type Description
Int16

_persistedConfig

Persisted value, see property Config.

Declaration
protected string _persistedConfig
Field Value
Type Description
String

_persistedDescription

Persisted value, see property Description.

Declaration
protected string _persistedDescription
Field Value
Type Description
String

_persistedExpires

Persisted value, see property Expires.

Declaration
protected DateTime _persistedExpires
Field Value
Type Description
DateTime

_persistedFolderId

Persisted value, see property FolderId.

Declaration
protected int _persistedFolderId
Field Value
Type Description
Int32

_persistedFormId

Persisted value, see property FormId.

Declaration
protected int _persistedFormId
Field Value
Type Description
Int32

_persistedFormKey

Persisted value, see property FormKey.

Declaration
protected string _persistedFormKey
Field Value
Type Description
String

_persistedGroupId

Persisted value, see property GroupId.

Declaration
protected int _persistedGroupId
Field Value
Type Description
Int32

_persistedMaxSubmits

Persisted value, see property MaxSubmits.

Declaration
protected int _persistedMaxSubmits
Field Value
Type Description
Int32

_persistedName

Persisted value, see property Name.

Declaration
protected string _persistedName
Field Value
Type Description
String

_persistedNewTicket

Persisted value, see property NewTicket.

Declaration
protected short _persistedNewTicket
Field Value
Type Description
Int16

_persistedRecipe

Persisted value, see property Recipe.

Declaration
protected string _persistedRecipe
Field Value
Type Description
String

_persistedRegistered

Persisted value, see property Registered.

Declaration
protected DateTime _persistedRegistered
Field Value
Type Description
DateTime

_persistedRegisteredAssociateId

Persisted value, see property RegisteredAssociateId.

Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type Description
Int32

_persistedResponseShipmentId

Persisted value, see property ResponseShipmentId.

Declaration
protected int _persistedResponseShipmentId
Field Value
Type Description
Int32

_persistedScriptId

Persisted value, see property ScriptId.

Declaration
protected int _persistedScriptId
Field Value
Type Description
Int32

_persistedType

Persisted value, see property Type.

Declaration
protected FormType _persistedType
Field Value
Type Description
FormType

_persistedUpdated

Persisted value, see property Updated.

Declaration
protected DateTime _persistedUpdated
Field Value
Type Description
DateTime

_persistedUpdatedAssociateId

Persisted value, see property UpdatedAssociateId.

Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type Description
Int32

_persistedUpdatedCount

Persisted value, see property UpdatedCount.

Declaration
protected short _persistedUpdatedCount
Field Value
Type Description
Int16

Properties

Active

.NET type: short. Indicates if this form is active and available for customers

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

Original type in dictionary: Bool.

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

Config

.NET type: string. The JSON-formatted config of this form

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

Description

.NET type: string. Detailed description

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

Original type in dictionary: String[4001].

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

Expires

.NET type: DateTime. After this datetime, the form will become inactive

Declaration
public virtual DateTime Expires { 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

FolderId

.NET type: int. The folder which this form belongs to. -1 indicates that the shipment is on the root

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

FormId

.NET type: int. Primary key

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

FormKey

.NET type: string. A short string used as unique id to access this form

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

FormTableInfo

Get the FormTableInfo object associated with the row.

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

GroupId

.NET type: int. The group which this form belongs to.

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

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.

MaxSubmits

.NET type: int. After this number of submits, the form will become inactive

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

Name

.NET type: string. The name of this form

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

Original type in dictionary: String[4001].

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

NewTicket

.NET type: short. True if this form creates a new ticket

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

Original type in dictionary: Bool.

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

Recipe

.NET type: string. The JSON-formatted recipe of this form

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

Registered

.NET type: DateTime. Registered when in UTC

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

Original type in dictionary: UtcDateTime.

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

RegisteredAssociateId

.NET type: int. Registered by whom

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

ResponseShipmentId

.NET type: int. The id of the s_shipment that is used to send the response mails

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

ScriptId

.NET type: int. The CRMScript Macro which will be run when the form is submitted.

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

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

Type

.NET type: FormType. What kind of form is this? Indicates if this is a normal form or a template

Declaration
public virtual FormType Type { get; set; }
Property Value
Type Description
FormType
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

Updated

.NET type: DateTime. Last updated when in UTC

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

Original type in dictionary: UtcDateTime.

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

UpdatedAssociateId

.NET type: int. Last updated by whom

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

UpdatedCount

.NET type: short. Number of updates made to this record

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

Original type in dictionary: UShort.

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 FormRow object. A form which can be published on a webpage and submitted by visitors

Declaration
public static FormRow CreateNew()
Returns
Type Description
FormRow

A new instance of the FormRow object.

GetFromCustomSearch(FormRow.CustomSearch)

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

The custom search to execute against the database

Returns
Type Description
FormRow

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

GetFromIdxFormId(Int32)

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

Declaration
public static FormRow GetFromIdxFormId(int formId)
Parameters
Type Name Description
Int32 formId
Returns
Type Description
FormRow

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

GetFromReader(SoDataReader, FormTableInfo)

Create a new instance of the FormRow 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. A form which can be published on a webpage and submitted by visitors

Declaration
public static FormRow GetFromReader(SoDataReader reader, FormTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

FormTableInfo tableInfo

FormTableInfo 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
FormRow

A new instance of the FormRow 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

_onActiveChange

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

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

_onConfigChange

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

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

_onDescriptionChange

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

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

_onExpiresChange

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

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

_onFolderIdChange

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

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

_onFormKeyChange

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

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

_onGroupIdChange

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

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

_onMaxSubmitsChange

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

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

_onNameChange

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

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

_onNewTicketChange

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

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

_onRecipeChange

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

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

_onRegisteredAssociateIdChange

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

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

_onRegisteredChange

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

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

_onResponseShipmentIdChange

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

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

_onScriptIdChange

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

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

_onTypeChange

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

Declaration
protected event OnFieldChange<FormType> _onTypeChange
Event Type
Type Description
OnFieldChange<FormType>

_onUpdatedAssociateIdChange

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

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

_onUpdatedChange

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

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

_onUpdatedCountChange

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

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

OnActiveChange

Event raised when Active is changing.

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

OnConfigChange

Event raised when Config is changing.

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

OnDescriptionChange

Event raised when Description is changing.

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

OnExpiresChange

Event raised when Expires is changing.

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

OnFolderIdChange

Event raised when FolderId is changing.

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

OnFormKeyChange

Event raised when FormKey is changing.

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

OnGroupIdChange

Event raised when GroupId is changing.

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

OnMaxSubmitsChange

Event raised when MaxSubmits is changing.

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

OnNameChange

Event raised when Name is changing.

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

OnNewTicketChange

Event raised when NewTicket is changing.

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

OnRecipeChange

Event raised when Recipe is changing.

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

OnRegisteredAssociateIdChange

Event raised when RegisteredAssociateId is changing.

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

OnRegisteredChange

Event raised when Registered is changing.

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

OnResponseShipmentIdChange

Event raised when ResponseShipmentId is changing.

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

OnScriptIdChange

Event raised when ScriptId is changing.

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

OnTypeChange

Event raised when Type is changing.

Declaration
public event OnFieldChange<FormType> OnTypeChange
Event Type
Type Description
OnFieldChange<FormType>

OnUpdatedAssociateIdChange

Event raised when UpdatedAssociateId is changing.

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

OnUpdatedChange

Event raised when Updated is changing.

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

OnUpdatedCountChange

Event raised when UpdatedCount is changing.

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

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