Show / Hide Table of Contents

Class SORFieldRow

SuperOffice reporter data
Row Object for table 'SORField'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
SORFieldRow
Implements
INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem
Inherited Members
TableRowBase._saveOwner
TableRowBase._sentries
TableRowBase._onValueChange
TableRowBase._relatedNestedPersistMembers
TableRowBase._sqlType
TableRowBase.InternalSetValue(Int32, Object)
TableRowBase.InternalSetValue(SoField, Object)
TableRowBase.GetFieldValue(FieldInfo)
TableRowBase.GetKnownFields()
TableRowBase.ISoDataLookup.GetPersistedFieldValue(FieldInfo)
TableRowBase.ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo)
TableRowBase.IsGhostField(FieldInfo)
TableRowBase.RowLoad()
TableRowBase.RowLoad(ITableRowLoadHandler)
TableRowBase.OnLoaded(IdxBase)
TableRowBase.Load(IdxBase, SoDataReader)
TableRowBase.Load(SoDataReader, TableInfo)
TableRowBase.SetDefaults()
TableRowBase.SetDefaults(DashboardTileDefinitionRow, String)
TableRowBase.SetSaveOwner(INestedPersist)
TableRowBase.Save()
TableRowBase.Delete()
TableRowBase.Validate()
TableRowBase.SetDirty(Int32, Object, Object)
TableRowBase.INestedPersist.OnPreIdUpdate()
TableRowBase.INestedPersist.OnPrimaryKeyRequest(PKContainer)
TableRowBase.INestedPersist.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.INestedPersist.OnIdUpdate()
TableRowBase.INestedPersist.OnSave(BatchSave)
TableRowBase.INestedPersist.OnSaved(Boolean)
TableRowBase.OnPreIdUpdate()
TableRowBase.OnPrimaryKeyRequest(PKContainer)
TableRowBase.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.OnIdUpdate()
TableRowBase.BeginIgnoreSentryCheck()
TableRowBase.EndIgnoreSentryCheck()
TableRowBase.GetRelatedNestedPersist()
TableRowBase.Item[Int32]
TableRowBase.Item[SoField]
TableRowBase.Sentries
TableRowBase.ForeignKeyHelper
TableRowBase.IsDeleted
TableRowBase.IsSaving
TableRowBase.SqlType
TableRowBase.IsSentryIgnored
TableRowBase.IsMarkedForDelete
TableRowBase.OnValueChanged
TableRowBase.OnElementSaved
TableRowBase.OnElementIdUpdate
PrivateSave.GetTableInfos()
PrivateSave.CloneToBasicUpdatingQuery()
PrivateSave.OnUpdateField
SqlCommand.Origin
SqlCommand.AddIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.AddIgnoreAutoSentryTableInfo(IEnumerable<TableInfo>)
SqlCommand.RemoveIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.ClearIgnoreAutoSentryTableInfos()
SqlCommand.IsAutoSentryIgnoredOnTableInfo(TableInfo)
SqlCommand.GetPrivateSaves()
SqlCommand.GetInserts()
SqlCommand.GetUpdates()
SqlCommand.GetDeletes()
SqlCommand.GetSelect()
SqlCommand.AutoSentryIgnoredTables
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SORFieldRow : 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) SORFieldRow SORFieldRow.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(SORFieldRow.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 SORFieldTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, SORFieldTableInfo) 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 SORFieldRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, SORFieldTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table SORField are:

Index fieldsNested index class name

Constructors

SORFieldRow(SORFieldRow.SORFieldRowIdxBase)

Constructor for the class taking an index as argument. SuperOffice reporter data

Declaration
protected SORFieldRow(SORFieldRow.SORFieldRowIdxBase idx)
Parameters
Type Name Description
SORFieldRow.SORFieldRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAlignment

Current value, see property Alignment.

Declaration
protected short _currentAlignment
Field Value
Type Description
Int16

_currentContent

Current value, see property Content.

Declaration
protected string _currentContent
Field Value
Type Description
String

_currentContentResId

Current value, see property ContentResId.

Declaration
protected uint _currentContentResId
Field Value
Type Description
UInt32

_currentDataFormat

Current value, see property DataFormat.

Declaration
protected string _currentDataFormat
Field Value
Type Description
String

_currentFieldType

Current value, see property FieldType.

Declaration
protected string _currentFieldType
Field Value
Type Description
String

_currentFontBold

Current value, see property FontBold.

Declaration
protected short _currentFontBold
Field Value
Type Description
Int16

_currentFontColor

Current value, see property FontColor.

Declaration
protected int _currentFontColor
Field Value
Type Description
Int32

_currentFontItalic

Current value, see property FontItalic.

Declaration
protected short _currentFontItalic
Field Value
Type Description
Int16

_currentFontName

Current value, see property FontName.

Declaration
protected string _currentFontName
Field Value
Type Description
String

_currentFontSize

Current value, see property FontSize.

Declaration
protected short _currentFontSize
Field Value
Type Description
Int16

_currentFontStrikethrough

Current value, see property FontStrikethrough.

Declaration
protected short _currentFontStrikethrough
Field Value
Type Description
Int16

_currentFontUnderline

Current value, see property FontUnderline.

Declaration
protected short _currentFontUnderline
Field Value
Type Description
Int16

_currentFunc

Current value, see property Func.

Declaration
protected short _currentFunc
Field Value
Type Description
Int16

_currentGroupType

Current value, see property GroupType.

Declaration
protected short _currentGroupType
Field Value
Type Description
Int16

_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

_currentRunning

Current value, see property Running.

Declaration
protected short _currentRunning
Field Value
Type Description
Int16

_currentSetHeight

Current value, see property SetHeight.

Declaration
protected uint _currentSetHeight
Field Value
Type Description
UInt32

_currentSetLeft

Current value, see property SetLeft.

Declaration
protected uint _currentSetLeft
Field Value
Type Description
UInt32

_currentSetTop

Current value, see property SetTop.

Declaration
protected uint _currentSetTop
Field Value
Type Description
UInt32

_currentSetWidth

Current value, see property SetWidth.

Declaration
protected uint _currentSetWidth
Field Value
Type Description
UInt32

_currentSgroup

Current value, see property Sgroup.

Declaration
protected string _currentSgroup
Field Value
Type Description
String

_currentSORFieldId

Current value, see property SORFieldId.

Declaration
protected int _currentSORFieldId
Field Value
Type Description
Int32

_currentSORSectionId

Current value, see property SORSectionId.

Declaration
protected int _currentSORSectionId
Field Value
Type Description
Int32

_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

_currentVisible

Current value, see property Visible.

Declaration
protected short _currentVisible
Field Value
Type Description
Int16

_persistedAlignment

Persisted value, see property Alignment.

Declaration
protected short _persistedAlignment
Field Value
Type Description
Int16

_persistedContent

Persisted value, see property Content.

Declaration
protected string _persistedContent
Field Value
Type Description
String

_persistedContentResId

Persisted value, see property ContentResId.

Declaration
protected uint _persistedContentResId
Field Value
Type Description
UInt32

_persistedDataFormat

Persisted value, see property DataFormat.

Declaration
protected string _persistedDataFormat
Field Value
Type Description
String

_persistedFieldType

Persisted value, see property FieldType.

Declaration
protected string _persistedFieldType
Field Value
Type Description
String

_persistedFontBold

Persisted value, see property FontBold.

Declaration
protected short _persistedFontBold
Field Value
Type Description
Int16

_persistedFontColor

Persisted value, see property FontColor.

Declaration
protected int _persistedFontColor
Field Value
Type Description
Int32

_persistedFontItalic

Persisted value, see property FontItalic.

Declaration
protected short _persistedFontItalic
Field Value
Type Description
Int16

_persistedFontName

Persisted value, see property FontName.

Declaration
protected string _persistedFontName
Field Value
Type Description
String

_persistedFontSize

Persisted value, see property FontSize.

Declaration
protected short _persistedFontSize
Field Value
Type Description
Int16

_persistedFontStrikethrough

Persisted value, see property FontStrikethrough.

Declaration
protected short _persistedFontStrikethrough
Field Value
Type Description
Int16

_persistedFontUnderline

Persisted value, see property FontUnderline.

Declaration
protected short _persistedFontUnderline
Field Value
Type Description
Int16

_persistedFunc

Persisted value, see property Func.

Declaration
protected short _persistedFunc
Field Value
Type Description
Int16

_persistedGroupType

Persisted value, see property GroupType.

Declaration
protected short _persistedGroupType
Field Value
Type Description
Int16

_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

_persistedRunning

Persisted value, see property Running.

Declaration
protected short _persistedRunning
Field Value
Type Description
Int16

_persistedSetHeight

Persisted value, see property SetHeight.

Declaration
protected uint _persistedSetHeight
Field Value
Type Description
UInt32

_persistedSetLeft

Persisted value, see property SetLeft.

Declaration
protected uint _persistedSetLeft
Field Value
Type Description
UInt32

_persistedSetTop

Persisted value, see property SetTop.

Declaration
protected uint _persistedSetTop
Field Value
Type Description
UInt32

_persistedSetWidth

Persisted value, see property SetWidth.

Declaration
protected uint _persistedSetWidth
Field Value
Type Description
UInt32

_persistedSgroup

Persisted value, see property Sgroup.

Declaration
protected string _persistedSgroup
Field Value
Type Description
String

_persistedSORFieldId

Persisted value, see property SORFieldId.

Declaration
protected int _persistedSORFieldId
Field Value
Type Description
Int32

_persistedSORSectionId

Persisted value, see property SORSectionId.

Declaration
protected int _persistedSORSectionId
Field Value
Type Description
Int32

_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

_persistedVisible

Persisted value, see property Visible.

Declaration
protected short _persistedVisible
Field Value
Type Description
Int16

Properties

Alignment

.NET type: short. 0=left, 1=right, 2=center

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

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

Content

.NET type: string. Field: db field name; Label: caption; image: file name; otherwise - empty

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

Original type in dictionary: String[255].

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

ContentResId

.NET type: uint. resource id if translatable resource

Declaration
public virtual uint ContentResId { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

DataFormat

.NET type: string. Field format mask

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

Original type in dictionary: String[20].

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FieldType

.NET type: string. field, label, line, image, pagenr, pages, date, associatename

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

Original type in dictionary: String[15].

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FontBold

.NET type: short. 1=bold

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

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FontColor

.NET type: int. colour index

Declaration
public virtual int FontColor { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FontItalic

.NET type: short. 1=iatlic

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

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FontName

.NET type: string. Name of font

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

Original type in dictionary: String[150].

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FontSize

.NET type: short. In points

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

Original type in dictionary: Short.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FontStrikethrough

.NET type: short. 1=strikethrough

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

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

FontUnderline

.NET type: short. 1=underline

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

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

Func

.NET type: short. -1=NULL, 0=ddSFSum, 1=ddSFAvg, 2=ddSFCount, 3=dSFMin, 4=ddSFMax

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

Original type in dictionary: Short.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

GroupType

.NET type: short. -1=NULL, 0=ddSMNone, 1=ddSMGrandTotal, 2=ddSMPageTotal, 3=ddSMSubTotal, 4=ddSMPageCount

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

Original type in dictionary: Short.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

InnerFieldValuePairs

The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name of the field returned from the Fields property.

Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type Description
ArgumentParameterCollection
Overrides
PrivateSave.InnerFieldValuePairs

InnerPrimaryKey

The primary key needed to decide which specific row to alter with the current sql-command.

Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type Description
FieldInfo
Overrides
PrivateSave.InnerPrimaryKey

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides
PrivateSave.InnerPrimaryKeyValue

IsDirty

Is the row dirty, e.g. been modified since the last time it was saved to the database.

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
Boolean
Overrides
TableRowBase.IsDirty

IsNew

Is this object new, meaning that it does not exist in the database.

Declaration
public override bool IsNew { get; }
Property Value
Type Description
Boolean
Overrides
TableRowBase.IsNew

Item[String]

Get or set a value based on the name of the field.

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

Name of the field in the database

Property Value
Type Description
Object

Value of the field.

Overrides
TableRowBase.Item[String]
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

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.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

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.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

Running

.NET type: short. -1=NULL, 0=ddSRNone, 1=ddSRGroup, 2=ddSRAll

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

Original type in dictionary: Short.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

SetHeight

.NET type: uint. height in twips

Declaration
public virtual uint SetHeight { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

SetLeft

.NET type: uint. left position in twips

Declaration
public virtual uint SetLeft { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

SetTop

.NET type: uint. top position in twips

Declaration
public virtual uint SetTop { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

SetWidth

.NET type: uint. width in twips

Declaration
public virtual uint SetWidth { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

Sgroup

.NET type: string. Which group to use for heading: GroupHeader1-3 or empty string

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

Original type in dictionary: String[15].

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

SORFieldId

.NET type: int. Primary key

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

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
SecurityException

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

SORFieldTableInfo

Get the SORFieldTableInfo object associated with the row.

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

SORSectionId

.NET type: int. Foreign key to Section

Declaration
public virtual int SORSectionId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

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

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
TableRowBase.TableInfo

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.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

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.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

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.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

Visible

.NET type: short. Is field visible, 1=true

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

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

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

Exceptions
Type Condition
SecurityException

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

Methods

CreateNew()

Create a new instance of the SORFieldRow object. SuperOffice reporter data

Declaration
public static SORFieldRow CreateNew()
Returns
Type Description
SORFieldRow

A new instance of the SORFieldRow object.

GetFromCustomSearch(SORFieldRow.CustomSearch)

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

The custom search to execute against the database

Returns
Type Description
SORFieldRow

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

GetFromIdxSORFieldId(Int32)

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

Declaration
public static SORFieldRow GetFromIdxSORFieldId(int sORFieldId)
Parameters
Type Name Description
Int32 sORFieldId
Returns
Type Description
SORFieldRow

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

GetFromReader(SoDataReader, SORFieldTableInfo)

Create a new instance of the SORFieldRow 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. SuperOffice reporter data

Declaration
public static SORFieldRow GetFromReader(SoDataReader reader, SORFieldTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

SORFieldTableInfo tableInfo

SORFieldTableInfo 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
SORFieldRow

A new instance of the SORFieldRow object.

GetPersistedFieldValue(FieldInfo)

Get the persisted value of a field.

Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field

Returns
Type Description
Object

Field value, such as an int, DateTime, string ... Null can be returned if the value is not known.

Overrides
PrivateSave.GetPersistedFieldValue(FieldInfo)
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

InternalSetValue(String, Object)

Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type Name Description
String fieldName
Object value
Overrides
TableRowBase.InternalSetValue(String, Object)

IsPersistedFieldValueKnown(FieldInfo)

Check if the persisted value for a field is known.

Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field

Returns
Type Description
Boolean

True if the value is known and sentry permits read.

Overrides
PrivateSave.IsPersistedFieldValueKnown(FieldInfo)

OnLoad(SoDataReader, TableInfo)

Fill the object with data returned from the database.

Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

Object holding the data returned from the database.

TableInfo tableInfo

The TableInfo used for the SELECT statement.

Overrides
TableRowBase.OnLoad(SoDataReader, TableInfo)

OnSave(BatchSave)

Add the object to the BatchSave list if it needs saving.

Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type Name Description
BatchSave batchSave

Collection of objects to be saved within the transaction.

Overrides
TableRowBase.OnSave(BatchSave)
Remarks

Classes overriding this method should call it.

OnSaved(Boolean)

Method called after the save operation has been performed.

Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type Name Description
Boolean bSucceeded

True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back)

Overrides
TableRowBase.OnSaved(Boolean)

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
TableRowBase.Reset()
Remarks

If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.

SetDefaults(DefaulterStrategy)

Set default values for the row.

Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type Name Description
DefaulterStrategy strategy

Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle

Overrides
TableRowBase.SetDefaults(DefaulterStrategy)

SetPrimaryKey(Int32)

Set the primary key for the row.

Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type Name Description
Int32 primaryKey

The new primary key for the row.

Overrides
TableRowBase.SetPrimaryKey(Int32)

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides
TableRowBase.SetRowAsNew()

ToString()

ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
Object.ToString()

Validate(RowValidator)

Validate this row.

Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type Name Description
RowValidator rowValidator

RowValidator for inserting the result of the validation

Overrides
TableRowBase.Validate(RowValidator)

Events

_onAlignmentChange

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

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

_onContentChange

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

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

_onContentResIdChange

Change envent for property ContentResId; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onContentResIdChange
Event Type
Type Description
OnFieldChange<UInt32>

_onDataFormatChange

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

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

_onFieldTypeChange

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

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

_onFontBoldChange

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

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

_onFontColorChange

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

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

_onFontItalicChange

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

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

_onFontNameChange

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

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

_onFontSizeChange

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

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

_onFontStrikethroughChange

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

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

_onFontUnderlineChange

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

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

_onFuncChange

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

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

_onGroupTypeChange

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

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

_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>

_onRunningChange

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

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

_onSetHeightChange

Change envent for property SetHeight; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onSetHeightChange
Event Type
Type Description
OnFieldChange<UInt32>

_onSetLeftChange

Change envent for property SetLeft; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onSetLeftChange
Event Type
Type Description
OnFieldChange<UInt32>

_onSetTopChange

Change envent for property SetTop; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onSetTopChange
Event Type
Type Description
OnFieldChange<UInt32>

_onSetWidthChange

Change envent for property SetWidth; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onSetWidthChange
Event Type
Type Description
OnFieldChange<UInt32>

_onSgroupChange

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

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

_onSORSectionIdChange

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

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

_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>

_onVisibleChange

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

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

OnAlignmentChange

Event raised when Alignment is changing.

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

OnContentChange

Event raised when Content is changing.

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

OnContentResIdChange

Event raised when ContentResId is changing.

Declaration
public event OnFieldChange<uint> OnContentResIdChange
Event Type
Type Description
OnFieldChange<UInt32>

OnDataFormatChange

Event raised when DataFormat is changing.

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

OnFieldTypeChange

Event raised when FieldType is changing.

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

OnFontBoldChange

Event raised when FontBold is changing.

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

OnFontColorChange

Event raised when FontColor is changing.

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

OnFontItalicChange

Event raised when FontItalic is changing.

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

OnFontNameChange

Event raised when FontName is changing.

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

OnFontSizeChange

Event raised when FontSize is changing.

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

OnFontStrikethroughChange

Event raised when FontStrikethrough is changing.

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

OnFontUnderlineChange

Event raised when FontUnderline is changing.

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

OnFuncChange

Event raised when Func is changing.

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

OnGroupTypeChange

Event raised when GroupType is changing.

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

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>

OnRunningChange

Event raised when Running is changing.

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

OnSetHeightChange

Event raised when SetHeight is changing.

Declaration
public event OnFieldChange<uint> OnSetHeightChange
Event Type
Type Description
OnFieldChange<UInt32>

OnSetLeftChange

Event raised when SetLeft is changing.

Declaration
public event OnFieldChange<uint> OnSetLeftChange
Event Type
Type Description
OnFieldChange<UInt32>

OnSetTopChange

Event raised when SetTop is changing.

Declaration
public event OnFieldChange<uint> OnSetTopChange
Event Type
Type Description
OnFieldChange<UInt32>

OnSetWidthChange

Event raised when SetWidth is changing.

Declaration
public event OnFieldChange<uint> OnSetWidthChange
Event Type
Type Description
OnFieldChange<UInt32>

OnSgroupChange

Event raised when Sgroup is changing.

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

OnSORSectionIdChange

Event raised when SORSectionId is changing.

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

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>

OnVisibleChange

Event raised when Visible is changing.

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

Implements

INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)
QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)
QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)
QueryExectionExtensions.ExecuteNonQuery(SqlCommand)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top