Class DashboardTileDefinitionRow
Describes the contents of a tile
Row Object for table 'dashboard_tile_definition'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class DashboardTileDefinitionRow : 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) DashboardTileDefinitionRow DashboardTileDefinitionRow.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(DashboardTileDefinitionRow.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 DashboardTileDefinitionTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTileDefinitionTableInfo) 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.
Unique indexes on table DashboardTileDefinition are:
Index fields | Nested index class name |
---|
Constructors
DashboardTileDefinitionRow(DashboardTileDefinitionRow.DashboardTileDefinitionRowIdxBase)
Constructor for the class taking an index as argument. Describes the contents of a tile
Declaration
protected DashboardTileDefinitionRow(DashboardTileDefinitionRow.DashboardTileDefinitionRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
DashboardTileDefinitionRow.DashboardTileDefinitionRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentCurrencyId
Current value, see property CurrencyId.
Declaration
protected int _currentCurrencyId
Field Value
Type | Description |
---|---|
Int32 |
_currentCurrencyMode
Current value, see property CurrencyMode.
Declaration
protected DashTileCurrencyMode _currentCurrencyMode
Field Value
Type | Description |
---|---|
DashTileCurrencyMode |
_currentDashboardTileDefinitionId
Current value, see property DashboardTileDefinitionId.
Declaration
protected int _currentDashboardTileDefinitionId
Field Value
Type | Description |
---|---|
Int32 |
_currentDefaultHeight
Current value, see property DefaultHeight.
Declaration
protected int _currentDefaultHeight
Field Value
Type | Description |
---|---|
Int32 |
_currentDefaultWidth
Current value, see property DefaultWidth.
Declaration
protected int _currentDefaultWidth
Field Value
Type | Description |
---|---|
Int32 |
_currentDescription
Current value, see property Description.
Declaration
protected string _currentDescription
Field Value
Type | Description |
---|---|
String |
_currentEntityName
Current value, see property EntityName.
Declaration
protected string _currentEntityName
Field Value
Type | Description |
---|---|
String |
_currentEntityType
Current value, see property EntityType.
Declaration
protected DashTileEntityType _currentEntityType
Field Value
Type | Description |
---|---|
DashTileEntityType |
_currentLayoutConfig
Current value, see property LayoutConfig.
Declaration
protected string _currentLayoutConfig
Field Value
Type | Description |
---|---|
String |
_currentMeasure
Current value, see property Measure.
Declaration
protected DashTileMeasure _currentMeasure
Field Value
Type | Description |
---|---|
DashTileMeasure |
_currentMeasureByField
Current value, see property MeasureByField.
Declaration
protected string _currentMeasureByField
Field Value
Type | Description |
---|---|
String |
_currentMeasureField
Current value, see property MeasureField.
Declaration
protected string _currentMeasureField
Field Value
Type | Description |
---|---|
String |
_currentName
Current value, see property Name.
Declaration
protected string _currentName
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 |
_currentSecondarySelectionId
Current value, see property SecondarySelectionId.
Declaration
protected int _currentSecondarySelectionId
Field Value
Type | Description |
---|---|
Int32 |
_currentSelectionId
Current value, see property SelectionId.
Declaration
protected int _currentSelectionId
Field Value
Type | Description |
---|---|
Int32 |
_currentSortBy
Current value, see property SortBy.
Declaration
protected string _currentSortBy
Field Value
Type | Description |
---|---|
String |
_currentTileType
Current value, see property TileType.
Declaration
protected DashTileType _currentTileType
Field Value
Type | Description |
---|---|
DashTileType |
_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 |
_persistedCurrencyId
Persisted value, see property CurrencyId.
Declaration
protected int _persistedCurrencyId
Field Value
Type | Description |
---|---|
Int32 |
_persistedCurrencyMode
Persisted value, see property CurrencyMode.
Declaration
protected DashTileCurrencyMode _persistedCurrencyMode
Field Value
Type | Description |
---|---|
DashTileCurrencyMode |
_persistedDashboardTileDefinitionId
Persisted value, see property DashboardTileDefinitionId.
Declaration
protected int _persistedDashboardTileDefinitionId
Field Value
Type | Description |
---|---|
Int32 |
_persistedDefaultHeight
Persisted value, see property DefaultHeight.
Declaration
protected int _persistedDefaultHeight
Field Value
Type | Description |
---|---|
Int32 |
_persistedDefaultWidth
Persisted value, see property DefaultWidth.
Declaration
protected int _persistedDefaultWidth
Field Value
Type | Description |
---|---|
Int32 |
_persistedDescription
Persisted value, see property Description.
Declaration
protected string _persistedDescription
Field Value
Type | Description |
---|---|
String |
_persistedEntityName
Persisted value, see property EntityName.
Declaration
protected string _persistedEntityName
Field Value
Type | Description |
---|---|
String |
_persistedEntityType
Persisted value, see property EntityType.
Declaration
protected DashTileEntityType _persistedEntityType
Field Value
Type | Description |
---|---|
DashTileEntityType |
_persistedLayoutConfig
Persisted value, see property LayoutConfig.
Declaration
protected string _persistedLayoutConfig
Field Value
Type | Description |
---|---|
String |
_persistedMeasure
Persisted value, see property Measure.
Declaration
protected DashTileMeasure _persistedMeasure
Field Value
Type | Description |
---|---|
DashTileMeasure |
_persistedMeasureByField
Persisted value, see property MeasureByField.
Declaration
protected string _persistedMeasureByField
Field Value
Type | Description |
---|---|
String |
_persistedMeasureField
Persisted value, see property MeasureField.
Declaration
protected string _persistedMeasureField
Field Value
Type | Description |
---|---|
String |
_persistedName
Persisted value, see property Name.
Declaration
protected string _persistedName
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 |
_persistedSecondarySelectionId
Persisted value, see property SecondarySelectionId.
Declaration
protected int _persistedSecondarySelectionId
Field Value
Type | Description |
---|---|
Int32 |
_persistedSelectionId
Persisted value, see property SelectionId.
Declaration
protected int _persistedSelectionId
Field Value
Type | Description |
---|---|
Int32 |
_persistedSortBy
Persisted value, see property SortBy.
Declaration
protected string _persistedSortBy
Field Value
Type | Description |
---|---|
String |
_persistedTileType
Persisted value, see property TileType.
Declaration
protected DashTileType _persistedTileType
Field Value
Type | Description |
---|---|
DashTileType |
_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
CurrencyId
.NET type: int. Currency of sale
Declaration
public virtual int CurrencyId { 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
CurrencyMode
.NET type: DashTileCurrencyMode. Dashboard currency mode
Declaration
public virtual DashTileCurrencyMode CurrencyMode { get; set; }
Property Value
Type | Description |
---|---|
DashTileCurrencyMode |
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
DashboardTileDefinitionId
.NET type: int. Primary key
Declaration
public virtual int DashboardTileDefinitionId { 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
DashboardTileDefinitionTableInfo
Get the DashboardTileDefinitionTableInfo object associated with the row.
Declaration
public DashboardTileDefinitionTableInfo DashboardTileDefinitionTableInfo { get; }
Property Value
Type | Description |
---|---|
DashboardTileDefinitionTableInfo |
DefaultHeight
.NET type: int. Default height when added to a dashboard
Declaration
public virtual int DefaultHeight { 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
DefaultWidth
.NET type: int. Default width when added to a dashboard
Declaration
public virtual int DefaultWidth { 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
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
EntityName
.NET type: string. The entity measured by this tile, defines what provider to use
Declaration
public virtual string EntityName { 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
EntityType
.NET type: DashTileEntityType. Dashboard entity type
Declaration
public virtual DashTileEntityType EntityType { get; set; }
Property Value
Type | Description |
---|---|
DashTileEntityType |
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
InnerFieldValuePairs
The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name
of the field returned from the Fields property.
Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type | Description |
---|---|
ArgumentParameterCollection |
Overrides
InnerPrimaryKey
The primary key needed to decide which specific row to alter with the current sql-command.
Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type | Description |
---|---|
FieldInfo |
Overrides
InnerPrimaryKeyValue
The actual value the primary key must have.
Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type | Description |
---|---|
Parameter |
Overrides
IsDirty
Is the row dirty, e.g. been modified since the last time it was saved to the database.
Declaration
public override bool IsDirty { get; }
Property Value
Type | Description |
---|---|
Boolean |
Overrides
IsNew
Is this object new, meaning that it does not exist in the database.
Declaration
public override bool IsNew { get; }
Property Value
Type | Description |
---|---|
Boolean |
Overrides
Item[String]
Get or set a value based on the name of the field.
Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
String | fieldName | Name of the field in the database |
Property Value
Type | Description |
---|---|
Object | Value of the field. |
Overrides
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
LayoutConfig
.NET type: string. The JSON formatted layout config
Declaration
public virtual string LayoutConfig { 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
Measure
.NET type: DashTileMeasure. Dashboard measure type (Count, Sum, Avg, etc.)
Declaration
public virtual DashTileMeasure Measure { get; set; }
Property Value
Type | Description |
---|---|
DashTileMeasure |
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
MeasureByField
.NET type: string. Field to group by
Declaration
public virtual string MeasureByField { 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
MeasureField
.NET type: string. Field to be measured
Declaration
public virtual string MeasureField { 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
Name
.NET type: string. The name of the tile
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
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
SecondarySelectionId
.NET type: int. Selection holding the replaced or changed criterias (period comparisons etc)
Declaration
public virtual int SecondarySelectionId { 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
SelectionId
.NET type: int. Selection holding the criterias for the tile definition
Declaration
public virtual int SelectionId { 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
SortBy
.NET type: string. Sort by field
Declaration
public virtual string SortBy { 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
TileType
.NET type: DashTileType. Dashboard tile type
Declaration
public virtual DashTileType TileType { get; set; }
Property Value
Type | Description |
---|---|
DashTileType |
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 DashboardTileDefinitionRow object. Describes the contents of a tile
Declaration
public static DashboardTileDefinitionRow CreateNew()
Returns
Type | Description |
---|---|
DashboardTileDefinitionRow | A new instance of the DashboardTileDefinitionRow object. |
GetFromCustomSearch(DashboardTileDefinitionRow.CustomSearch)
Create a new instance of the DashboardTileDefinitionRow 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 DashboardTileDefinitionRow GetFromCustomSearch(DashboardTileDefinitionRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
DashboardTileDefinitionRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
DashboardTileDefinitionRow | A new instance of the DashboardTileDefinitionRow object, reflecting the result of the query. |
GetFromIdxDashboardTileDefinitionId(Int32)
Create a new instance of the DashboardTileDefinitionRow object, by querying the database table via the index 'IDXDashboard_tile_definitionId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static DashboardTileDefinitionRow GetFromIdxDashboardTileDefinitionId(int dashboardTileDefinitionId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | dashboardTileDefinitionId |
Returns
Type | Description |
---|---|
DashboardTileDefinitionRow | 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 DashboardTileDefinition table. Non-unique indexes have corresponding inner classes and methods in the DashboardTileDefinitionRows collection, since they may return more than one row.
GetFromReader(SoDataReader, DashboardTileDefinitionTableInfo)
Create a new instance of the DashboardTileDefinitionRow 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 the contents of a tile
Declaration
public static DashboardTileDefinitionRow GetFromReader(SoDataReader reader, DashboardTileDefinitionTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
DashboardTileDefinitionTableInfo | tableInfo | DashboardTileDefinitionTableInfo 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 |
---|---|
DashboardTileDefinitionRow | A new instance of the DashboardTileDefinitionRow object. |
GetPersistedFieldValue(FieldInfo)
Get the persisted value of a field.
Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type | Name | Description |
---|---|---|
FieldInfo | field | Specification of a field |
Returns
Type | Description |
---|---|
Object | Field value, such as an int, DateTime, string ... Null can be returned if the value is not known. |
Overrides
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
InternalSetValue(String, Object)
Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type | Name | Description |
---|---|---|
String | fieldName | |
Object | value |
Overrides
IsPersistedFieldValueKnown(FieldInfo)
Check if the persisted value for a field is known.
Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type | Name | Description |
---|---|---|
FieldInfo | field | Specification of a field |
Returns
Type | Description |
---|---|
Boolean | True if the value is known and sentry permits read. |
Overrides
OnLoad(SoDataReader, TableInfo)
Fill the object with data returned from the database.
Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | Object holding the data returned from the database. |
TableInfo | tableInfo | The TableInfo used for the SELECT statement. |
Overrides
OnSave(BatchSave)
Add the object to the BatchSave list if it needs saving.
Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type | Name | Description |
---|---|---|
BatchSave | batchSave | Collection of objects to be saved within the transaction. |
Overrides
Remarks
Classes overriding this method should call it.
OnSaved(Boolean)
Method called after the save operation has been performed.
Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type | Name | Description |
---|---|---|
Boolean | bSucceeded | True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back) |
Overrides
Reset()
Reset the changes made on the object.
Declaration
protected override void Reset()
Overrides
Remarks
If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.
SetDefaults(DefaulterStrategy)
Set default values for the row.
Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type | Name | Description |
---|---|---|
DefaulterStrategy | strategy | Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle |
Overrides
SetPrimaryKey(Int32)
Set the primary key for the row.
Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type | Name | Description |
---|---|---|
Int32 | primaryKey | The new primary key for the row. |
Overrides
SetRowAsNew()
Declaration
public override void SetRowAsNew()
Overrides
ToString()
ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |
Overrides
Validate(RowValidator)
Validate this row.
Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type | Name | Description |
---|---|---|
RowValidator | rowValidator | RowValidator for inserting the result of the validation |
Overrides
Events
_onCurrencyIdChange
Change envent for property CurrencyId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onCurrencyIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onCurrencyModeChange
Change envent for property CurrencyMode; field is of .NET type short.
Declaration
protected event OnFieldChange<DashTileCurrencyMode> _onCurrencyModeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileCurrencyMode> |
_onDefaultHeightChange
Change envent for property DefaultHeight; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onDefaultHeightChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onDefaultWidthChange
Change envent for property DefaultWidth; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onDefaultWidthChange
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> |
_onEntityNameChange
Change envent for property EntityName; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onEntityNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onEntityTypeChange
Change envent for property EntityType; field is of .NET type short.
Declaration
protected event OnFieldChange<DashTileEntityType> _onEntityTypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileEntityType> |
_onLayoutConfigChange
Change envent for property LayoutConfig; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onLayoutConfigChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onMeasureByFieldChange
Change envent for property MeasureByField; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onMeasureByFieldChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onMeasureChange
Change envent for property Measure; field is of .NET type short.
Declaration
protected event OnFieldChange<DashTileMeasure> _onMeasureChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileMeasure> |
_onMeasureFieldChange
Change envent for property MeasureField; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onMeasureFieldChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onNameChange
Change envent for property Name; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onNameChange
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> |
_onSecondarySelectionIdChange
Change envent for property SecondarySelectionId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onSecondarySelectionIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onSelectionIdChange
Change envent for property SelectionId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onSelectionIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onSortByChange
Change envent for property SortBy; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onSortByChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onTileTypeChange
Change envent for property TileType; field is of .NET type short.
Declaration
protected event OnFieldChange<DashTileType> _onTileTypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileType> |
_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> |
OnCurrencyIdChange
Event raised when CurrencyId is changing.
Declaration
public event OnFieldChange<int> OnCurrencyIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnCurrencyModeChange
Event raised when CurrencyMode is changing.
Declaration
public event OnFieldChange<DashTileCurrencyMode> OnCurrencyModeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileCurrencyMode> |
OnDefaultHeightChange
Event raised when DefaultHeight is changing.
Declaration
public event OnFieldChange<int> OnDefaultHeightChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnDefaultWidthChange
Event raised when DefaultWidth is changing.
Declaration
public event OnFieldChange<int> OnDefaultWidthChange
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> |
OnEntityNameChange
Event raised when EntityName is changing.
Declaration
public event OnFieldChange<string> OnEntityNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnEntityTypeChange
Event raised when EntityType is changing.
Declaration
public event OnFieldChange<DashTileEntityType> OnEntityTypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileEntityType> |
OnLayoutConfigChange
Event raised when LayoutConfig is changing.
Declaration
public event OnFieldChange<string> OnLayoutConfigChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnMeasureByFieldChange
Event raised when MeasureByField is changing.
Declaration
public event OnFieldChange<string> OnMeasureByFieldChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnMeasureChange
Event raised when Measure is changing.
Declaration
public event OnFieldChange<DashTileMeasure> OnMeasureChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileMeasure> |
OnMeasureFieldChange
Event raised when MeasureField is changing.
Declaration
public event OnFieldChange<string> OnMeasureFieldChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnNameChange
Event raised when Name is changing.
Declaration
public event OnFieldChange<string> OnNameChange
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> |
OnSecondarySelectionIdChange
Event raised when SecondarySelectionId is changing.
Declaration
public event OnFieldChange<int> OnSecondarySelectionIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnSelectionIdChange
Event raised when SelectionId is changing.
Declaration
public event OnFieldChange<int> OnSelectionIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnSortByChange
Event raised when SortBy is changing.
Declaration
public event OnFieldChange<string> OnSortByChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnTileTypeChange
Event raised when TileType is changing.
Declaration
public event OnFieldChange<DashTileType> OnTileTypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DashTileType> |
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> |