Class DashboardRow

Describes a dashboard
Row Object for table 'dashboard'. 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

System.Object

SqlCommand

PrivateSave

TableRowBase

DashboardRow

Implements

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

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class DashboardRow : 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) DashboardRow DashboardRow.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(DashboardRow.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 DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) 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 DashboardRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, DashboardTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Dashboard are:

Index fields	Nested index class name

Constructors

DashboardRow(DashboardRow.DashboardRowIdxBase)

Constructor for the class taking an index as argument. Describes a dashboard

Declaration

protected DashboardRow(DashboardRow.DashboardRowIdxBase idx)

Parameters

Type	Name	Description
DashboardRow.DashboardRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentAssociateId

Current value, see property AssociateId.

Declaration

protected int _currentAssociateId

Field Value

Type	Description
System.Int32

_currentColumns

Current value, see property Columns.

Declaration

protected int _currentColumns

Field Value

Type	Description
System.Int32

_currentDashboardId

Current value, see property DashboardId.

Declaration

protected int _currentDashboardId

Field Value

Type	Description
System.Int32

_currentDashboardThemeId

Current value, see property DashboardThemeId.

Declaration

protected int _currentDashboardThemeId

Field Value

Type	Description
System.Int32

_currentDescription

Current value, see property Description.

Declaration

protected string _currentDescription

Field Value

Type	Description
System.String

_currentGuid

Current value, see property Guid.

Declaration

protected string _currentGuid

Field Value

Type	Description
System.String

_currentName

Current value, see property Name.

Declaration

protected string _currentName

Field Value

Type	Description
System.String

_currentPinForAll

Current value, see property PinForAll.

Declaration

protected short _currentPinForAll

Field Value

Type	Description
System.Int16

_currentPinForAssociates

Current value, see property PinForAssociates.

Declaration

protected int[] _currentPinForAssociates

Field Value

Type	Description
System.Int32[]

_currentPinForGroups

Current value, see property PinForGroups.

Declaration

protected int[] _currentPinForGroups

Field Value

Type	Description
System.Int32[]

_currentRegistered

Current value, see property Registered.

Declaration

protected DateTime _currentRegistered

Field Value

Type	Description
System.DateTime

_currentRegisteredAssociateId

Current value, see property RegisteredAssociateId.

Declaration

protected int _currentRegisteredAssociateId

Field Value

Type	Description
System.Int32

_currentUpdated

Current value, see property Updated.

Declaration

protected DateTime _currentUpdated

Field Value

Type	Description
System.DateTime

_currentUpdatedAssociateId

Current value, see property UpdatedAssociateId.

Declaration

protected int _currentUpdatedAssociateId

Field Value

Type	Description
System.Int32

_currentUpdatedCount

Current value, see property UpdatedCount.

Declaration

protected short _currentUpdatedCount

Field Value

Type	Description
System.Int16

_currentVisibleForAll

Current value, see property VisibleForAll.

Declaration

protected short _currentVisibleForAll

Field Value

Type	Description
System.Int16

_currentVisibleForAssociates

Current value, see property VisibleForAssociates.

Declaration

protected int[] _currentVisibleForAssociates

Field Value

Type	Description
System.Int32[]

_currentVisibleForGroups

Current value, see property VisibleForGroups.

Declaration

protected int[] _currentVisibleForGroups

Field Value

Type	Description
System.Int32[]

_persistedAssociateId

Persisted value, see property AssociateId.

Declaration

protected int _persistedAssociateId

Field Value

Type	Description
System.Int32

_persistedColumns

Persisted value, see property Columns.

Declaration

protected int _persistedColumns

Field Value

Type	Description
System.Int32

_persistedDashboardId

Persisted value, see property DashboardId.

Declaration

protected int _persistedDashboardId

Field Value

Type	Description
System.Int32

_persistedDashboardThemeId

Persisted value, see property DashboardThemeId.

Declaration

protected int _persistedDashboardThemeId

Field Value

Type	Description
System.Int32

_persistedDescription

Persisted value, see property Description.

Declaration

protected string _persistedDescription

Field Value

Type	Description
System.String

_persistedGuid

Persisted value, see property Guid.

Declaration

protected string _persistedGuid

Field Value

Type	Description
System.String

_persistedName

Persisted value, see property Name.

Declaration

protected string _persistedName

Field Value

Type	Description
System.String

_persistedPinForAll

Persisted value, see property PinForAll.

Declaration

protected short _persistedPinForAll

Field Value

Type	Description
System.Int16

_persistedPinForAssociates

Persisted value, see property PinForAssociates.

Declaration

protected int[] _persistedPinForAssociates

Field Value

Type	Description
System.Int32[]

_persistedPinForGroups

Persisted value, see property PinForGroups.

Declaration

protected int[] _persistedPinForGroups

Field Value

Type	Description
System.Int32[]

_persistedRegistered

Persisted value, see property Registered.

Declaration

protected DateTime _persistedRegistered

Field Value

Type	Description
System.DateTime

_persistedRegisteredAssociateId

Persisted value, see property RegisteredAssociateId.

Declaration

protected int _persistedRegisteredAssociateId

Field Value

Type	Description
System.Int32

_persistedUpdated

Persisted value, see property Updated.

Declaration

protected DateTime _persistedUpdated

Field Value

Type	Description
System.DateTime

_persistedUpdatedAssociateId

Persisted value, see property UpdatedAssociateId.

Declaration

protected int _persistedUpdatedAssociateId

Field Value

Type	Description
System.Int32

_persistedUpdatedCount

Persisted value, see property UpdatedCount.

Declaration

protected short _persistedUpdatedCount

Field Value

Type	Description
System.Int16

_persistedVisibleForAll

Persisted value, see property VisibleForAll.

Declaration

protected short _persistedVisibleForAll

Field Value

Type	Description
System.Int16

_persistedVisibleForAssociates

Persisted value, see property VisibleForAssociates.

Declaration

protected int[] _persistedVisibleForAssociates

Field Value

Type	Description
System.Int32[]

_persistedVisibleForGroups

Persisted value, see property VisibleForGroups.

Declaration

protected int[] _persistedVisibleForGroups

Field Value

Type	Description
System.Int32[]

Properties

AssociateId

.NET type: int. Associate who owns this dashboard

Declaration

public virtual int AssociateId { get; set; }

Property Value

Type	Description
System.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

Columns

.NET type: int. How many columns there will be in the dashboard.

Declaration

public virtual int Columns { get; set; }

Property Value

Type	Description
System.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

DashboardId

.NET type: int. Primary key

Declaration

public virtual int DashboardId { get; }

Property Value

Type	Description
System.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

DashboardTableInfo

Get the DashboardTableInfo object associated with the row.

Declaration

public DashboardTableInfo DashboardTableInfo { get; }

Property Value

Type	Description
DashboardTableInfo

DashboardThemeId

.NET type: int. The theme belongs to set of slyle rules for the dashboard

Declaration

public virtual int DashboardThemeId { get; set; }

Property Value

Type	Description
System.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. Detailed description

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
System.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

Guid

.NET type: string. GUID identifying a default dashboard from SuperOffice

Declaration

public virtual string Guid { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[37].

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
System.String	fieldName	Name of the field in the database

Property Value

Type	Description
System.Object	Value of the field.

Overrides

TableRowBase.Item[String]

Exceptions

Type	Condition
ArgumentException	Thrown if the field is not known.

Name

.NET type: string. The name of this dashboard

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
System.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

PinForAll

.NET type: short. True if pinned for all

Declaration

public virtual short PinForAll { get; set; }

Property Value

Type	Description
System.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

PinForAssociates

.NET type: Int32[]. Array of references to the pinned associates

Declaration

public virtual int[] PinForAssociates { get; set; }

Property Value

Type	Description
System.Int32[]

Remarks

Original type in dictionary: FKArray.

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

PinForGroups

.NET type: Int32[]. Array of references to the pinned groups

Declaration

public virtual int[] PinForGroups { get; set; }

Property Value

Type	Description
System.Int32[]

Remarks

Original type in dictionary: FKArray.

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

Updated

.NET type: DateTime. Last updated when in UTC

Declaration

public virtual DateTime Updated { get; set; }

Property Value

Type	Description
System.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
System.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
System.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

VisibleForAll

.NET type: short. True if visible for all

Declaration

public virtual short VisibleForAll { get; set; }

Property Value

Type	Description
System.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

VisibleForAssociates

.NET type: Int32[]. Array of references to the visible for associates

Declaration

public virtual int[] VisibleForAssociates { get; set; }

Property Value

Type	Description
System.Int32[]

Remarks

Original type in dictionary: FKArray.

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

VisibleForGroups

.NET type: Int32[]. Array of references to the visible for groups

Declaration

public virtual int[] VisibleForGroups { get; set; }

Property Value

Type	Description
System.Int32[]

Remarks

Original type in dictionary: FKArray.

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 DashboardRow object. Describes a dashboard

Declaration

public static DashboardRow CreateNew()

Returns

Type	Description
DashboardRow	A new instance of the DashboardRow object.

GetFromCustomSearch(DashboardRow.CustomSearch)

Create a new instance of the DashboardRow 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 DashboardRow GetFromCustomSearch(DashboardRow.CustomSearch query)

Parameters

Type	Name	Description
DashboardRow.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
DashboardRow	A new instance of the DashboardRow object, reflecting the result of the query.

GetFromIdxDashboardId(Int32)

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

Declaration

public static DashboardRow GetFromIdxDashboardId(int dashboardId)

Parameters

Type	Name	Description
System.Int32	dashboardId

Returns

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

GetFromReader(SoDataReader, DashboardTableInfo)

Create a new instance of the DashboardRow 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. Describes a dashboard

Declaration

public static DashboardRow GetFromReader(SoDataReader reader, DashboardTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
DashboardTableInfo	tableInfo	DashboardTableInfo 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
DashboardRow	A new instance of the DashboardRow 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
System.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
System.String	fieldName
System.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
System.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
System.String

Overrides

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

_onAssociateIdChange

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

Declaration

protected event OnFieldChange<int> _onAssociateIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

_onColumnsChange

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

Declaration

protected event OnFieldChange<int> _onColumnsChange

Event Type

Type	Description
OnFieldChange<System.Int32>

_onDashboardThemeIdChange

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

Declaration

protected event OnFieldChange<int> _onDashboardThemeIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

_onDescriptionChange

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

Declaration

protected event OnFieldChange<string> _onDescriptionChange

Event Type

Type	Description
OnFieldChange<System.String>

_onGuidChange

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

Declaration

protected event OnFieldChange<string> _onGuidChange

Event Type

Type	Description
OnFieldChange<System.String>

_onNameChange

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

Declaration

protected event OnFieldChange<string> _onNameChange

Event Type

Type	Description
OnFieldChange<System.String>

_onPinForAllChange

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

Declaration

protected event OnFieldChange<short> _onPinForAllChange

Event Type

Type	Description
OnFieldChange<System.Int16>

_onPinForAssociatesChange

Change envent for property PinForAssociates; field is of .NET type Int32[].

Declaration

protected event OnFieldChange<int[]> _onPinForAssociatesChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

_onPinForGroupsChange

Change envent for property PinForGroups; field is of .NET type Int32[].

Declaration

protected event OnFieldChange<int[]> _onPinForGroupsChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

_onRegisteredAssociateIdChange

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

Declaration

protected event OnFieldChange<int> _onRegisteredAssociateIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

_onRegisteredChange

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

Declaration

protected event OnFieldChange<DateTime> _onRegisteredChange

Event Type

Type	Description
OnFieldChange<System.DateTime>

_onUpdatedAssociateIdChange

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

Declaration

protected event OnFieldChange<int> _onUpdatedAssociateIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

_onUpdatedChange

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

Declaration

protected event OnFieldChange<DateTime> _onUpdatedChange

Event Type

Type	Description
OnFieldChange<System.DateTime>

_onUpdatedCountChange

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

Declaration

protected event OnFieldChange<short> _onUpdatedCountChange

Event Type

Type	Description
OnFieldChange<System.Int16>

_onVisibleForAllChange

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

Declaration

protected event OnFieldChange<short> _onVisibleForAllChange

Event Type

Type	Description
OnFieldChange<System.Int16>

_onVisibleForAssociatesChange

Change envent for property VisibleForAssociates; field is of .NET type Int32[].

Declaration

protected event OnFieldChange<int[]> _onVisibleForAssociatesChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

_onVisibleForGroupsChange

Change envent for property VisibleForGroups; field is of .NET type Int32[].

Declaration

protected event OnFieldChange<int[]> _onVisibleForGroupsChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

OnAssociateIdChange

Event raised when AssociateId is changing.

Declaration

public event OnFieldChange<int> OnAssociateIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

OnColumnsChange

Event raised when Columns is changing.

Declaration

public event OnFieldChange<int> OnColumnsChange

Event Type

Type	Description
OnFieldChange<System.Int32>

OnDashboardThemeIdChange

Event raised when DashboardThemeId is changing.

Declaration

public event OnFieldChange<int> OnDashboardThemeIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

OnDescriptionChange

Event raised when Description is changing.

Declaration

public event OnFieldChange<string> OnDescriptionChange

Event Type

Type	Description
OnFieldChange<System.String>

OnGuidChange

Event raised when Guid is changing.

Declaration

public event OnFieldChange<string> OnGuidChange

Event Type

Type	Description
OnFieldChange<System.String>

OnNameChange

Event raised when Name is changing.

Declaration

public event OnFieldChange<string> OnNameChange

Event Type

Type	Description
OnFieldChange<System.String>

OnPinForAllChange

Event raised when PinForAll is changing.

Declaration

public event OnFieldChange<short> OnPinForAllChange

Event Type

Type	Description
OnFieldChange<System.Int16>

OnPinForAssociatesChange

Event raised when PinForAssociates is changing.

Declaration

public event OnFieldChange<int[]> OnPinForAssociatesChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

OnPinForGroupsChange

Event raised when PinForGroups is changing.

Declaration

public event OnFieldChange<int[]> OnPinForGroupsChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

OnRegisteredAssociateIdChange

Event raised when RegisteredAssociateId is changing.

Declaration

public event OnFieldChange<int> OnRegisteredAssociateIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

OnRegisteredChange

Event raised when Registered is changing.

Declaration

public event OnFieldChange<DateTime> OnRegisteredChange

Event Type

Type	Description
OnFieldChange<System.DateTime>

OnUpdatedAssociateIdChange

Event raised when UpdatedAssociateId is changing.

Declaration

public event OnFieldChange<int> OnUpdatedAssociateIdChange

Event Type

Type	Description
OnFieldChange<System.Int32>

OnUpdatedChange

Event raised when Updated is changing.

Declaration

public event OnFieldChange<DateTime> OnUpdatedChange

Event Type

Type	Description
OnFieldChange<System.DateTime>

OnUpdatedCountChange

Event raised when UpdatedCount is changing.

Declaration

public event OnFieldChange<short> OnUpdatedCountChange

Event Type

Type	Description
OnFieldChange<System.Int16>

OnVisibleForAllChange

Event raised when VisibleForAll is changing.

Declaration

public event OnFieldChange<short> OnVisibleForAllChange

Event Type

Type	Description
OnFieldChange<System.Int16>

OnVisibleForAssociatesChange

Event raised when VisibleForAssociates is changing.

Declaration

public event OnFieldChange<int[]> OnVisibleForAssociatesChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

OnVisibleForGroupsChange

Event raised when VisibleForGroups is changing.

Declaration

public event OnFieldChange<int[]> OnVisibleForGroupsChange

Event Type

Type	Description
OnFieldChange<System.Int32[]>

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)