Class SORLabelLayoutRow

SuperOffice reporter data
Row Object for table 'SORLabelLayout'. 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

SORLabelLayoutRow

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

Unique indexes on table SORLabelLayout are:

Index fields	Nested index class name

Constructors

SORLabelLayoutRow(SORLabelLayoutRow.SORLabelLayoutRowIdxBase)

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

Declaration

protected SORLabelLayoutRow(SORLabelLayoutRow.SORLabelLayoutRowIdxBase idx)

Parameters

Type	Name	Description
SORLabelLayoutRow.SORLabelLayoutRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentBottomMargin

Current value, see property BottomMargin.

Declaration

protected uint _currentBottomMargin

Field Value

Type	Description
UInt32

_currentCountColumns

Current value, see property CountColumns.

Declaration

protected short _currentCountColumns

Field Value

Type	Description
Int16

_currentCountRows

Current value, see property CountRows.

Declaration

protected short _currentCountRows

Field Value

Type	Description
Int16

_currentDescription

Current value, see property Description.

Declaration

protected string _currentDescription

Field Value

Type	Description
String

_currentLabelHeight

Current value, see property LabelHeight.

Declaration

protected uint _currentLabelHeight

Field Value

Type	Description
UInt32

_currentLeftMargin

Current value, see property LeftMargin.

Declaration

protected uint _currentLeftMargin

Field Value

Type	Description
UInt32

_currentName

Current value, see property Name.

Declaration

protected string _currentName

Field Value

Type	Description
String

_currentOrientation

Current value, see property Orientation.

Declaration

protected short _currentOrientation

Field Value

Type	Description
Int16

_currentPaperHeight

Current value, see property PaperHeight.

Declaration

protected uint _currentPaperHeight

Field Value

Type	Description
UInt32

_currentPaperWidth

Current value, see property PaperWidth.

Declaration

protected uint _currentPaperWidth

Field Value

Type	Description
UInt32

_currentPrintWidth

Current value, see property PrintWidth.

Declaration

protected uint _currentPrintWidth

Field Value

Type	Description
UInt32

_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

_currentRightMargin

Current value, see property RightMargin.

Declaration

protected uint _currentRightMargin

Field Value

Type	Description
UInt32

_currentSORLabelLayoutId

Current value, see property SORLabelLayoutId.

Declaration

protected int _currentSORLabelLayoutId

Field Value

Type	Description
Int32

_currentTopMargin

Current value, see property TopMargin.

Declaration

protected uint _currentTopMargin

Field Value

Type	Description
UInt32

_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

_persistedBottomMargin

Persisted value, see property BottomMargin.

Declaration

protected uint _persistedBottomMargin

Field Value

Type	Description
UInt32

_persistedCountColumns

Persisted value, see property CountColumns.

Declaration

protected short _persistedCountColumns

Field Value

Type	Description
Int16

_persistedCountRows

Persisted value, see property CountRows.

Declaration

protected short _persistedCountRows

Field Value

Type	Description
Int16

_persistedDescription

Persisted value, see property Description.

Declaration

protected string _persistedDescription

Field Value

Type	Description
String

_persistedLabelHeight

Persisted value, see property LabelHeight.

Declaration

protected uint _persistedLabelHeight

Field Value

Type	Description
UInt32

_persistedLeftMargin

Persisted value, see property LeftMargin.

Declaration

protected uint _persistedLeftMargin

Field Value

Type	Description
UInt32

_persistedName

Persisted value, see property Name.

Declaration

protected string _persistedName

Field Value

Type	Description
String

_persistedOrientation

Persisted value, see property Orientation.

Declaration

protected short _persistedOrientation

Field Value

Type	Description
Int16

_persistedPaperHeight

Persisted value, see property PaperHeight.

Declaration

protected uint _persistedPaperHeight

Field Value

Type	Description
UInt32

_persistedPaperWidth

Persisted value, see property PaperWidth.

Declaration

protected uint _persistedPaperWidth

Field Value

Type	Description
UInt32

_persistedPrintWidth

Persisted value, see property PrintWidth.

Declaration

protected uint _persistedPrintWidth

Field Value

Type	Description
UInt32

_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

_persistedRightMargin

Persisted value, see property RightMargin.

Declaration

protected uint _persistedRightMargin

Field Value

Type	Description
UInt32

_persistedSORLabelLayoutId

Persisted value, see property SORLabelLayoutId.

Declaration

protected int _persistedSORLabelLayoutId

Field Value

Type	Description
Int32

_persistedTopMargin

Persisted value, see property TopMargin.

Declaration

protected uint _persistedTopMargin

Field Value

Type	Description
UInt32

_persistedUpdated

Persisted value, see property Updated.

Declaration

protected DateTime _persistedUpdated

Field Value

Type	Description
DateTime

_persistedUpdatedAssociateId

Persisted value, see property UpdatedAssociateId.

Declaration

protected int _persistedUpdatedAssociateId

Field Value

Type	Description
Int32

_persistedUpdatedCount

Persisted value, see property UpdatedCount.

Declaration

protected short _persistedUpdatedCount

Field Value

Type	Description
Int16

Properties

BottomMargin

.NET type: uint. Bottom margin in twips

Declaration

public virtual uint BottomMargin { 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.

CountColumns

.NET type: short. Number og columns

Declaration

public virtual short CountColumns { 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.

CountRows

.NET type: short. Number of rows

Declaration

public virtual short CountRows { 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.

Description

.NET type: string. Description

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[2048].

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.

LabelHeight

.NET type: uint. Calculated: (paperHeight - topMargin - bottomMargin) / countRows

Declaration

public virtual uint LabelHeight { 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.

LeftMargin

.NET type: uint. Left margin in twips

Declaration

public virtual uint LeftMargin { 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.

Name

.NET type: string. Name of the label layout

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[240].

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.

Orientation

.NET type: short. Paper orientation: 1=portrait, 2=landscape

Declaration

public virtual short Orientation { 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.

PaperHeight

.NET type: uint. Paper height in twips

Declaration

public virtual uint PaperHeight { 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.

PaperWidth

.NET type: uint. Paper width in twips

Declaration

public virtual uint PaperWidth { 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.

PrintWidth

.NET type: uint. Calculated: (paperWidth - leftMargin - rightMargin) / countColumns

Declaration

public virtual uint PrintWidth { 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.

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.

RightMargin

.NET type: uint. Right margin in twips

Declaration

public virtual uint RightMargin { 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.

SORLabelLayoutId

.NET type: int. Primary key

Declaration

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

SORLabelLayoutTableInfo

Get the SORLabelLayoutTableInfo object associated with the row.

Declaration

public SORLabelLayoutTableInfo SORLabelLayoutTableInfo { get; }

Property Value

Type	Description
SORLabelLayoutTableInfo

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

TopMargin

.NET type: uint. Top margin in twips

Declaration

public virtual uint TopMargin { 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.

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.

Methods

CreateNew()

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

Declaration

public static SORLabelLayoutRow CreateNew()

Returns

Type	Description
SORLabelLayoutRow	A new instance of the SORLabelLayoutRow object.

GetFromCustomSearch(SORLabelLayoutRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxSORLabelLayoutId(Int32)

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

Declaration

public static SORLabelLayoutRow GetFromIdxSORLabelLayoutId(int sORLabelLayoutId)

Parameters

Type	Name	Description
Int32	sORLabelLayoutId

Returns

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

GetFromReader(SoDataReader, SORLabelLayoutTableInfo)

Create a new instance of the SORLabelLayoutRow 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 SORLabelLayoutRow GetFromReader(SoDataReader reader, SORLabelLayoutTableInfo tableInfo)

Parameters

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

_onBottomMarginChange

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

Declaration

protected event OnFieldChange<uint> _onBottomMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onCountColumnsChange

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

Declaration

protected event OnFieldChange<short> _onCountColumnsChange

Event Type

Type	Description
OnFieldChange<Int16>

_onCountRowsChange

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

Declaration

protected event OnFieldChange<short> _onCountRowsChange

Event Type

Type	Description
OnFieldChange<Int16>

_onDescriptionChange

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

Declaration

protected event OnFieldChange<string> _onDescriptionChange

Event Type

Type	Description
OnFieldChange<String>

_onLabelHeightChange

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

Declaration

protected event OnFieldChange<uint> _onLabelHeightChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onLeftMarginChange

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

Declaration

protected event OnFieldChange<uint> _onLeftMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onNameChange

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

Declaration

protected event OnFieldChange<string> _onNameChange

Event Type

Type	Description
OnFieldChange<String>

_onOrientationChange

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

Declaration

protected event OnFieldChange<short> _onOrientationChange

Event Type

Type	Description
OnFieldChange<Int16>

_onPaperHeightChange

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

Declaration

protected event OnFieldChange<uint> _onPaperHeightChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onPaperWidthChange

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

Declaration

protected event OnFieldChange<uint> _onPaperWidthChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onPrintWidthChange

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

Declaration

protected event OnFieldChange<uint> _onPrintWidthChange

Event Type

Type	Description
OnFieldChange<UInt32>

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

_onRightMarginChange

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

Declaration

protected event OnFieldChange<uint> _onRightMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onTopMarginChange

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

Declaration

protected event OnFieldChange<uint> _onTopMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

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

OnBottomMarginChange

Event raised when BottomMargin is changing.

Declaration

public event OnFieldChange<uint> OnBottomMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnCountColumnsChange

Event raised when CountColumns is changing.

Declaration

public event OnFieldChange<short> OnCountColumnsChange

Event Type

Type	Description
OnFieldChange<Int16>

OnCountRowsChange

Event raised when CountRows is changing.

Declaration

public event OnFieldChange<short> OnCountRowsChange

Event Type

Type	Description
OnFieldChange<Int16>

OnDescriptionChange

Event raised when Description is changing.

Declaration

public event OnFieldChange<string> OnDescriptionChange

Event Type

Type	Description
OnFieldChange<String>

OnLabelHeightChange

Event raised when LabelHeight is changing.

Declaration

public event OnFieldChange<uint> OnLabelHeightChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnLeftMarginChange

Event raised when LeftMargin is changing.

Declaration

public event OnFieldChange<uint> OnLeftMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnNameChange

Event raised when Name is changing.

Declaration

public event OnFieldChange<string> OnNameChange

Event Type

Type	Description
OnFieldChange<String>

OnOrientationChange

Event raised when Orientation is changing.

Declaration

public event OnFieldChange<short> OnOrientationChange

Event Type

Type	Description
OnFieldChange<Int16>

OnPaperHeightChange

Event raised when PaperHeight is changing.

Declaration

public event OnFieldChange<uint> OnPaperHeightChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnPaperWidthChange

Event raised when PaperWidth is changing.

Declaration

public event OnFieldChange<uint> OnPaperWidthChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnPrintWidthChange

Event raised when PrintWidth is changing.

Declaration

public event OnFieldChange<uint> OnPrintWidthChange

Event Type

Type	Description
OnFieldChange<UInt32>

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>

OnRightMarginChange

Event raised when RightMargin is changing.

Declaration

public event OnFieldChange<uint> OnRightMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnTopMarginChange

Event raised when TopMargin is changing.

Declaration

public event OnFieldChange<uint> OnTopMarginChange

Event Type

Type	Description
OnFieldChange<UInt32>

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>

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)