Class UDefFieldRow

Definition table for user-defined fields; one row in this table corresponds to one generation of one field. The user defined fields that are in use, and earlier versions of user defined fields. ColumnId refers to the field type; see UDXXXSmall or UDXXXLarge for the referring ID. Preferences prefsection='System', prefkey='CurrentUdefVersioncontact' (or CurrentUdefVersionperson, project, sale), gives you the current version of user defined fields. prefkey='AdminUdefVersion<...>' gives you the current version that's being edited. If Current version = admin version, no editing has been done since the last Publish of user defined field was performed.
Row Object for table 'UDefField'. 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

UDefFieldRow

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Inherited Members

TableRowBase._saveOwner

TableRowBase._sentries

TableRowBase._relatedNestedPersistMembers

TableRowBase._isSaving

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.add_OnElementSaved(OnSaved)

TableRowBase.remove_OnElementSaved(OnSaved)

TableRowBase.add_OnElementIdUpdate(OnIdUpdate)

TableRowBase.remove_OnElementIdUpdate(OnIdUpdate)

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

TableRowBase.OnElementIdUpdate

PrivateSave.GetTableInfos()

PrivateSave.add_OnUpdateField(UpdateField)

PrivateSave.remove_OnUpdateField(UpdateField)

PrivateSave.CloneToBasicUpdatingQuery()

PrivateSave.SetTicketLogAction(TicketLogAction, String)

PrivateSave.DoNotWriteTraveltransactionLog

PrivateSave.OnUpdateField

SqlCommand.Origin

SqlCommand.AdditionalInfo

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

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

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

Unique indexes on table UDefField are:

Index fields	Nested index class name

Constructors

UDefFieldRow(UDefFieldRow.UDefFieldRowIdxBase)

Constructor for the class taking an index as argument. Definition table for user-defined fields; one row in this table corresponds to one generation of one field. The user defined fields that are in use, and earlier versions of user defined fields. ColumnId refers to the field type; see UDXXXSmall or UDXXXLarge for the referring ID. Preferences prefsection='System', prefkey='CurrentUdefVersioncontact' (or CurrentUdefVersionperson, project, sale), gives you the current version of user defined fields. prefkey='AdminUdefVersion<...>' gives you the current version that's being edited. If Current version = admin version, no editing has been done since the last Publish of user defined field was performed.

Declaration

protected UDefFieldRow(UDefFieldRow.UDefFieldRowIdxBase idx)

Parameters

Type	Name	Description
SuperOffice.CRM.Rows.UDefFieldRow.UDefFieldRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentColumnId

Current value, see property ColumnId.

Declaration

protected int _currentColumnId

Field Value

Type	Description
System.Int32

_currentFieldDefault

Current value, see property FieldDefault.

Declaration

protected string _currentFieldDefault

Field Value

Type	Description
System.String

_currentFieldHeight

Current value, see property FieldHeight.

Declaration

protected short _currentFieldHeight

Field Value

Type	Description
System.Int16

_currentFieldLabel

Current value, see property FieldLabel.

Declaration

protected string _currentFieldLabel

Field Value

Type	Description
System.String

_currentFieldLeft

Current value, see property FieldLeft.

Declaration

protected short _currentFieldLeft

Field Value

Type	Description
System.Int16

_currentFieldTop

Current value, see property FieldTop.

Declaration

protected short _currentFieldTop

Field Value

Type	Description
System.Int16

_currentFieldType

Current value, see property FieldType.

Declaration

protected short _currentFieldType

Field Value

Type	Description
System.Int16

_currentFieldWidth

Current value, see property FieldWidth.

Declaration

protected short _currentFieldWidth

Field Value

Type	Description
System.Int16

_currentFormatMask

Current value, see property FormatMask.

Declaration

protected string _currentFormatMask

Field Value

Type	Description
System.String

_currentHideLabel

Current value, see property HideLabel.

Declaration

protected short _currentHideLabel

Field Value

Type	Description
System.Int16

_currentIndexed

Current value, see property Indexed.

Declaration

protected short _currentIndexed

Field Value

Type	Description
System.Int16

_currentJustification

Current value, see property Justification.

Declaration

protected UdefJustification _currentJustification

Field Value

Type	Description
UdefJustification

_currentLabelHeight

Current value, see property LabelHeight.

Declaration

protected short _currentLabelHeight

Field Value

Type	Description
System.Int16

_currentLabelLeft

Current value, see property LabelLeft.

Declaration

protected short _currentLabelLeft

Field Value

Type	Description
System.Int16

_currentLabelTop

Current value, see property LabelTop.

Declaration

protected short _currentLabelTop

Field Value

Type	Description
System.Int16

_currentLabelWidth

Current value, see property LabelWidth.

Declaration

protected short _currentLabelWidth

Field Value

Type	Description
System.Int16

_currentLastVersionId

Current value, see property LastVersionId.

Declaration

protected int _currentLastVersionId

Field Value

Type	Description
System.Int32

_currentListTableId

Current value, see property ListTableId.

Declaration

protected short _currentListTableId

Field Value

Type	Description
System.Int16

_currentMandatory

Current value, see property Mandatory.

Declaration

protected short _currentMandatory

Field Value

Type	Description
System.Int16

_currentOwnerTableId

Current value, see property OwnerTableId.

Declaration

protected short _currentOwnerTableId

Field Value

Type	Description
System.Int16

_currentPage1LineNo

Current value, see property Page1LineNo.

Declaration

protected short _currentPage1LineNo

Field Value

Type	Description
System.Int16

_currentProgId

Current value, see property ProgId.

Declaration

protected string _currentProgId

Field Value

Type	Description
System.String

_currentReadOnly

Current value, see property ReadOnly.

Declaration

protected short _currentReadOnly

Field Value

Type	Description
System.Int16

_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

_currentShortLabel

Current value, see property ShortLabel.

Declaration

protected string _currentShortLabel

Field Value

Type	Description
System.String

_currentTabOrder

Current value, see property TabOrder.

Declaration

protected short _currentTabOrder

Field Value

Type	Description
System.Int16

_currentTextLength

Current value, see property TextLength.

Declaration

protected short _currentTextLength

Field Value

Type	Description
System.Int16

_currentTooltip

Current value, see property Tooltip.

Declaration

protected string _currentTooltip

Field Value

Type	Description
System.String

_currentUDefFieldId

Current value, see property UDefFieldId.

Declaration

protected int _currentUDefFieldId

Field Value

Type	Description
System.Int32

_currentUdefIdentity

Current value, see property UdefIdentity.

Declaration

protected int _currentUdefIdentity

Field Value

Type	Description
System.Int32

_currentUDListDefinitionId

Current value, see property UDListDefinitionId.

Declaration

protected int _currentUDListDefinitionId

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

_currentVersion

Current value, see property Version.

Declaration

protected short _currentVersion

Field Value

Type	Description
System.Int16

_persistedColumnId

Persisted value, see property ColumnId.

Declaration

protected int _persistedColumnId

Field Value

Type	Description
System.Int32

_persistedFieldDefault

Persisted value, see property FieldDefault.

Declaration

protected string _persistedFieldDefault

Field Value

Type	Description
System.String

_persistedFieldHeight

Persisted value, see property FieldHeight.

Declaration

protected short _persistedFieldHeight

Field Value

Type	Description
System.Int16

_persistedFieldLabel

Persisted value, see property FieldLabel.

Declaration

protected string _persistedFieldLabel

Field Value

Type	Description
System.String

_persistedFieldLeft

Persisted value, see property FieldLeft.

Declaration

protected short _persistedFieldLeft

Field Value

Type	Description
System.Int16

_persistedFieldTop

Persisted value, see property FieldTop.

Declaration

protected short _persistedFieldTop

Field Value

Type	Description
System.Int16

_persistedFieldType

Persisted value, see property FieldType.

Declaration

protected short _persistedFieldType

Field Value

Type	Description
System.Int16

_persistedFieldWidth

Persisted value, see property FieldWidth.

Declaration

protected short _persistedFieldWidth

Field Value

Type	Description
System.Int16

_persistedFormatMask

Persisted value, see property FormatMask.

Declaration

protected string _persistedFormatMask

Field Value

Type	Description
System.String

_persistedHideLabel

Persisted value, see property HideLabel.

Declaration

protected short _persistedHideLabel

Field Value

Type	Description
System.Int16

_persistedIndexed

Persisted value, see property Indexed.

Declaration

protected short _persistedIndexed

Field Value

Type	Description
System.Int16

_persistedJustification

Persisted value, see property Justification.

Declaration

protected UdefJustification _persistedJustification

Field Value

Type	Description
UdefJustification

_persistedLabelHeight

Persisted value, see property LabelHeight.

Declaration

protected short _persistedLabelHeight

Field Value

Type	Description
System.Int16

_persistedLabelLeft

Persisted value, see property LabelLeft.

Declaration

protected short _persistedLabelLeft

Field Value

Type	Description
System.Int16

_persistedLabelTop

Persisted value, see property LabelTop.

Declaration

protected short _persistedLabelTop

Field Value

Type	Description
System.Int16

_persistedLabelWidth

Persisted value, see property LabelWidth.

Declaration

protected short _persistedLabelWidth

Field Value

Type	Description
System.Int16

_persistedLastVersionId

Persisted value, see property LastVersionId.

Declaration

protected int _persistedLastVersionId

Field Value

Type	Description
System.Int32

_persistedListTableId

Persisted value, see property ListTableId.

Declaration

protected short _persistedListTableId

Field Value

Type	Description
System.Int16

_persistedMandatory

Persisted value, see property Mandatory.

Declaration

protected short _persistedMandatory

Field Value

Type	Description
System.Int16

_persistedOwnerTableId

Persisted value, see property OwnerTableId.

Declaration

protected short _persistedOwnerTableId

Field Value

Type	Description
System.Int16

_persistedPage1LineNo

Persisted value, see property Page1LineNo.

Declaration

protected short _persistedPage1LineNo

Field Value

Type	Description
System.Int16

_persistedProgId

Persisted value, see property ProgId.

Declaration

protected string _persistedProgId

Field Value

Type	Description
System.String

_persistedReadOnly

Persisted value, see property ReadOnly.

Declaration

protected short _persistedReadOnly

Field Value

Type	Description
System.Int16

_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

_persistedShortLabel

Persisted value, see property ShortLabel.

Declaration

protected string _persistedShortLabel

Field Value

Type	Description
System.String

_persistedTabOrder

Persisted value, see property TabOrder.

Declaration

protected short _persistedTabOrder

Field Value

Type	Description
System.Int16

_persistedTextLength

Persisted value, see property TextLength.

Declaration

protected short _persistedTextLength

Field Value

Type	Description
System.Int16

_persistedTooltip

Persisted value, see property Tooltip.

Declaration

protected string _persistedTooltip

Field Value

Type	Description
System.String

_persistedUDefFieldId

Persisted value, see property UDefFieldId.

Declaration

protected int _persistedUDefFieldId

Field Value

Type	Description
System.Int32

_persistedUdefIdentity

Persisted value, see property UdefIdentity.

Declaration

protected int _persistedUdefIdentity

Field Value

Type	Description
System.Int32

_persistedUDListDefinitionId

Persisted value, see property UDListDefinitionId.

Declaration

protected int _persistedUDListDefinitionId

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

_persistedVersion

Persisted value, see property Version.

Declaration

protected short _persistedVersion

Field Value

Type	Description
System.Int16

Properties

ColumnId

.NET type: int. The ID of the database column this field corresponds to

Declaration

public virtual int ColumnId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FieldId.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FieldDefault

.NET type: string. Optional default value for String fields

Declaration

public virtual string FieldDefault { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[255].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FieldHeight

.NET type: short. field height in pixels, 0 = 'enough' (from font)

Declaration

public virtual short FieldHeight { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FieldLabel

.NET type: string. The label (lead text)

Declaration

public virtual string FieldLabel { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[255].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FieldLeft

.NET type: short. X pixel coordinate of field

Declaration

public virtual short FieldLeft { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FieldTop

.NET type: short. Y pixel coordinate of field

Declaration

public virtual short FieldTop { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FieldType

.NET type: short. Field type: 0 = leadtext only, 1 = Edit, 2 = CheckBox, 3 = dropdown, 4 = listbox

Declaration

public virtual short FieldType { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FieldWidth

.NET type: short. field width in pixels, 0 = 'enough' (from font)

Declaration

public virtual short FieldWidth { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

FormatMask

.NET type: string. Formatting mask, can be whatever the controls understand (currently nothing :-))

Declaration

public virtual string FormatMask { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[255].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

HideLabel

.NET type: short. Hide the label if 1

Declaration

public virtual short HideLabel { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: Bool.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Indexed

.NET type: short. Is this field indexed? 0 if no, index no. if yes

Declaration

public virtual short Indexed { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: Bool.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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

Justification

.NET type: UdefJustification. Justification - 0 = default, left, right, center

Declaration

public virtual UdefJustification Justification { get; set; }

Property Value

Type	Description
UdefJustification

Remarks

Original type in dictionary: Enum.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((short)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

LabelHeight

.NET type: short. label height in pixels, 0 = 'enough' (from font)

Declaration

public virtual short LabelHeight { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

LabelLeft

.NET type: short. X pixel coordinate of label

Declaration

public virtual short LabelLeft { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

LabelTop

.NET type: short. Y pixel coordinate of label

Declaration

public virtual short LabelTop { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

LabelWidth

.NET type: short. label width in pixels, 0 = 'enough' (from font)

Declaration

public virtual short LabelWidth { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

LastVersionId

.NET type: int. UDefFieldId this field had in the previous version, 0 = field is new in this version

Declaration

public virtual int LastVersionId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ListTableId

.NET type: short. The table ID of the source table for lists: kTableAssoc, kTableContInt or whatever

Declaration

public virtual short ListTableId { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: TableNumber.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Mandatory

.NET type: short. 0 = no, 1 = yes (field must be filled out)

Declaration

public virtual short Mandatory { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: Bool.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

OwnerTableId

.NET type: short. ID of owning table (contact, person, project) - this is not the actual tableNumber, rather it's an enum

Declaration

public virtual short OwnerTableId { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Page1LineNo

.NET type: short. Line no on View Page 1, used if MDO flags are OFF. 0 = this field is not visible on page 1

Declaration

public virtual short Page1LineNo { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ProgId

.NET type: string. Programmatic ID, for use by software that needs to find a particular field. Carried over like udefIdentity across generations. Use a Company.Product.Field format to avoid naming conflicts; the Company name SuperOffice is reserved.

Declaration

public virtual string ProgId { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[255].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ReadOnly

.NET type: short. 0 = read/write, 1 = readonly (don't combine with mandatory 8-) )

Declaration

public virtual short ReadOnly { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ShortLabel

.NET type: string. Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere.

Declaration

public virtual string ShortLabel { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[255].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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

TabOrder

.NET type: short. Tab order value, sets the field processing sequence

Declaration

public virtual short TabOrder { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

TextLength

.NET type: short. Length (in characters) of a text field, 0 for other types

Declaration

public virtual short TextLength { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Tooltip

.NET type: string. Optional tooltip text for this field

Declaration

public virtual string Tooltip { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[255].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

UDefFieldId

.NET type: int. Primary key

Declaration

public virtual int UDefFieldId { 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.

Read only for code not signed by SuperOffice.

This field is not protected by the Sentry system, and can always be read

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.

UDefFieldTableInfo

Get the UDefFieldTableInfo object associated with the row.

Declaration

public UDefFieldTableInfo UDefFieldTableInfo { get; }

Property Value

Type	Description
UDefFieldTableInfo

UdefIdentity

.NET type: int. Unique number used to track field identity across layout changes

Declaration

public virtual int UdefIdentity { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: Id.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

UDListDefinitionId

.NET type: int. List to use for populating dropdown or listbox

Declaration

public virtual int UDListDefinitionId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Version

.NET type: short. Definition version number; ALL fields get new version whenever layout is updated.

Declaration

public virtual short Version { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
System.Security.SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Methods

CreateNew()

Create a new instance of the UDefFieldRow object. Definition table for user-defined fields; one row in this table corresponds to one generation of one field. The user defined fields that are in use, and earlier versions of user defined fields. ColumnId refers to the field type; see UDXXXSmall or UDXXXLarge for the referring ID. Preferences prefsection='System', prefkey='CurrentUdefVersioncontact' (or CurrentUdefVersionperson, project, sale), gives you the current version of user defined fields. prefkey='AdminUdefVersion<...>' gives you the current version that's being edited. If Current version = admin version, no editing has been done since the last Publish of user defined field was performed.

Declaration

public static UDefFieldRow CreateNew()

Returns

Type	Description
UDefFieldRow	A new instance of the UDefFieldRow object.

GetFromCustomSearch(UDefFieldRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxUDefFieldId(Int32)

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

Declaration

public static UDefFieldRow GetFromIdxUDefFieldId(int uDefFieldId)

Parameters

Type	Name	Description
System.Int32	uDefFieldId

Returns

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

GetFromReader(SoDataReader, UDefFieldTableInfo)

Create a new instance of the UDefFieldRow 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. Definition table for user-defined fields; one row in this table corresponds to one generation of one field. The user defined fields that are in use, and earlier versions of user defined fields. ColumnId refers to the field type; see UDXXXSmall or UDXXXLarge for the referring ID. Preferences prefsection='System', prefkey='CurrentUdefVersioncontact' (or CurrentUdefVersionperson, project, sale), gives you the current version of user defined fields. prefkey='AdminUdefVersion<...>' gives you the current version that's being edited. If Current version = admin version, no editing has been done since the last Publish of user defined field was performed.

Declaration

public static UDefFieldRow GetFromReader(SoDataReader reader, UDefFieldTableInfo tableInfo)

Parameters

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

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)

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)

QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)

QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)

QueryExectionExtensions.ExecuteNonQuery(SqlCommand)

UDefFieldRecordDataExtensions.ToRecordData(UDefFieldRow)

Converters.MapEnums<From, To>(From)