Class ListTableRow

HDB Object for table 'Category'.

List of valid category types

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
ListTableRow
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
public class ListTableRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem, IMDOListElement

Constructors

ListTableRow(ListTableRow.TableRowIdx)

Constructor for the class taking an index as argument.

List of valid category types

Declaration
protected ListTableRow(ListTableRow.TableRowIdx idx)
Parameters
Type Name Description
ListTableRow.TableRowIdx idx

The index representing a SELECT command to the database.

Fields

_nodeType

Explains what kind the current object is. MDOListElementType

Declaration
protected MDOListElementType _nodeType
Field Value
Type Description
MDOListElementType

Properties

Deleted

0 = record is active

1 = record is "deleted" and should not be shown in lists

Read only for code not signed by SuperOffice.

Declaration
public virtual short Deleted { get; }
Property Value
Type Description
Int16
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

ElementType

The type of MDO List Element

Declaration
public MDOListElementType ElementType { get; set; }
Property Value
Type Description
MDOListElementType

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

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]

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

Key

Key to the MDO List Element

Declaration
public int Key { get; }
Property Value
Type Description
Int32

ListItemId

Primary key

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

Name

The list item

Read only for code not signed by SuperOffice.

Declaration
public virtual string Name { get; }
Property Value
Type Description
String
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

Rank

Rank order

Read only for code not signed by SuperOffice.

Declaration
public virtual short Rank { get; }
Property Value
Type Description
Int16
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

Registered

Registered on

Read only for code not signed by SuperOffice.

Declaration
public virtual DateTime Registered { get; }
Property Value
Type Description
DateTime
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

RegisteredAssociateId

Registered by

Read only for code not signed by SuperOffice.

Declaration
public virtual int RegisteredAssociateId { get; }
Property Value
Type Description
Int32
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

TableInfo

Get the TableInfo for the table.

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

The TableInfo for the table.
Overrides

Tooltip

Tooltip or other description

Read only for code not signed by SuperOffice.

Declaration
public virtual string Tooltip { get; }
Property Value
Type Description
String
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

Updated

Last updated on

Read only for code not signed by SuperOffice.

Declaration
public virtual DateTime Updated { get; }
Property Value
Type Description
DateTime
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

UpdatedAssociateId

Last updated by

Read only for code not signed by SuperOffice.

Declaration
public virtual int UpdatedAssociateId { get; }
Property Value
Type Description
Int32
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

UpdatedCount

Reserved for future use. Should be zero.

Read only for code not signed by SuperOffice.

Declaration
public virtual short UpdatedCount { get; }
Property Value
Type Description
Int16
Exceptions
Type Condition
SecurityException

Thrown if the set method is accessed by code not signed by SuperOffice.

Value

Returns the current MDO List Element.

Declaration
public object Value { get; }
Property Value
Type Description
Object

Methods

CreateNew()

Create a new instance of the TableRow object.

List of valid category types

Declaration
public static ListTableRow CreateNew()
Returns
Type Description
ListTableRow

A new instance of the TableRow object.

GetValue(String)

Get a value from the valuecollection.

Declaration
public object GetValue(string field)
Parameters
Type Name Description
String field

Name of field to get the value for
Returns
Type Description
Object

InternalSetValue(String, Object)

Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type Name Description
String fieldName
Object value
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.

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

ToString()

Get the Name-field as default string representation.

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)