Show / Hide Table of Contents

Class ExtAppRow

ExtApp list table. Applications startable from SuperOffice
Row Object for table 'ExtApp'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.
This table is an Editable MDO list; fields are writeable if you have list- or general admin rights (or superoffice code signature)

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
ExtAppRow
Implements
INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem
IMDOListElement
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 ExtAppRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem, IMDOListElement
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) ExtAppRow ExtAppRow.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(ExtAppRow.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 ExtAppTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ExtAppTableInfo) 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 ExtAppRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ExtAppTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table ExtApp are:

Index fieldsNested index class name

Constructors

ExtAppRow(ExtAppRow.ExtAppRowIdxBase)

Constructor for the class taking an index as argument. ExtApp list table. Applications startable from SuperOffice

Declaration
protected ExtAppRow(ExtAppRow.ExtAppRowIdxBase idx)
Parameters
Type Name Description
ExtAppRow.ExtAppRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAppType

Current value, see property AppType.

Declaration
protected short _currentAppType
Field Value
Type Description
Int16

_currentAvailableInState

Current value, see property AvailableInState.

Declaration
protected AppAvailState _currentAvailableInState
Field Value
Type Description
AppAvailState

_currentConfigInfo

Current value, see property ConfigInfo.

Declaration
protected string _currentConfigInfo
Field Value
Type Description
String

_currentDeleted

Current value, see property Deleted.

Declaration
protected short _currentDeleted
Field Value
Type Description
Int16

_currentExecuteOnEvent

Current value, see property ExecuteOnEvent.

Declaration
protected ExecuteOnEvent _currentExecuteOnEvent
Field Value
Type Description
ExecuteOnEvent

_currentExtAppId

Current value, see property ExtAppId.

Declaration
protected int _currentExtAppId
Field Value
Type Description
Int32

_currentFilename

Current value, see property Filename.

Declaration
protected string _currentFilename
Field Value
Type Description
String

_currentIcon

Current value, see property Icon.

Declaration
protected short _currentIcon
Field Value
Type Description
Int16

_currentName

Current value, see property Name.

Declaration
protected string _currentName
Field Value
Type Description
String

_currentNavigation

Current value, see property Navigation.

Declaration
protected Navigation _currentNavigation
Field Value
Type Description
Navigation

_currentParameters

Current value, see property Parameters.

Declaration
protected string _currentParameters
Field Value
Type Description
String

_currentPath

Current value, see property Path.

Declaration
protected string _currentPath
Field Value
Type Description
String

_currentRank

Current value, see property Rank.

Declaration
protected short _currentRank
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

_currentShowState

Current value, see property ShowState.

Declaration
protected ShowState _currentShowState
Field Value
Type Description
ShowState

_currentTooltip

Current value, see property Tooltip.

Declaration
protected string _currentTooltip
Field Value
Type Description
String

_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

_currentUrl1

Current value, see property Url1.

Declaration
protected string _currentUrl1
Field Value
Type Description
String

_currentUrl2

Current value, see property Url2.

Declaration
protected string _currentUrl2
Field Value
Type Description
String

_currentWaitToFinish

Current value, see property WaitToFinish.

Declaration
protected short _currentWaitToFinish
Field Value
Type Description
Int16

_currentWindowName

Current value, see property WindowName.

Declaration
protected string _currentWindowName
Field Value
Type Description
String

_currentWorkdir

Current value, see property Workdir.

Declaration
protected string _currentWorkdir
Field Value
Type Description
String

_nodeType

Explains what kind the current object is. MDOListElementType

Declaration
protected MDOListElementType _nodeType
Field Value
Type Description
MDOListElementType

_persistedAppType

Persisted value, see property AppType.

Declaration
protected short _persistedAppType
Field Value
Type Description
Int16

_persistedAvailableInState

Persisted value, see property AvailableInState.

Declaration
protected AppAvailState _persistedAvailableInState
Field Value
Type Description
AppAvailState

_persistedConfigInfo

Persisted value, see property ConfigInfo.

Declaration
protected string _persistedConfigInfo
Field Value
Type Description
String

_persistedDeleted

Persisted value, see property Deleted.

Declaration
protected short _persistedDeleted
Field Value
Type Description
Int16

_persistedExecuteOnEvent

Persisted value, see property ExecuteOnEvent.

Declaration
protected ExecuteOnEvent _persistedExecuteOnEvent
Field Value
Type Description
ExecuteOnEvent

_persistedExtAppId

Persisted value, see property ExtAppId.

Declaration
protected int _persistedExtAppId
Field Value
Type Description
Int32

_persistedFilename

Persisted value, see property Filename.

Declaration
protected string _persistedFilename
Field Value
Type Description
String

_persistedIcon

Persisted value, see property Icon.

Declaration
protected short _persistedIcon
Field Value
Type Description
Int16

_persistedName

Persisted value, see property Name.

Declaration
protected string _persistedName
Field Value
Type Description
String

_persistedNavigation

Persisted value, see property Navigation.

Declaration
protected Navigation _persistedNavigation
Field Value
Type Description
Navigation

_persistedParameters

Persisted value, see property Parameters.

Declaration
protected string _persistedParameters
Field Value
Type Description
String

_persistedPath

Persisted value, see property Path.

Declaration
protected string _persistedPath
Field Value
Type Description
String

_persistedRank

Persisted value, see property Rank.

Declaration
protected short _persistedRank
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

_persistedShowState

Persisted value, see property ShowState.

Declaration
protected ShowState _persistedShowState
Field Value
Type Description
ShowState

_persistedTooltip

Persisted value, see property Tooltip.

Declaration
protected string _persistedTooltip
Field Value
Type Description
String

_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

_persistedUrl1

Persisted value, see property Url1.

Declaration
protected string _persistedUrl1
Field Value
Type Description
String

_persistedUrl2

Persisted value, see property Url2.

Declaration
protected string _persistedUrl2
Field Value
Type Description
String

_persistedWaitToFinish

Persisted value, see property WaitToFinish.

Declaration
protected short _persistedWaitToFinish
Field Value
Type Description
Int16

_persistedWindowName

Persisted value, see property WindowName.

Declaration
protected string _persistedWindowName
Field Value
Type Description
String

_persistedWorkdir

Persisted value, see property Workdir.

Declaration
protected string _persistedWorkdir
Field Value
Type Description
String

Properties

AppType

.NET type: short. Application type: 1 = exe, 2 = integrated html, 3 = integrated url, 4 = browser url, 5 = external url

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

Original type in dictionary: Enum.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

AvailableInState

.NET type: AppAvailState. When should this application be available from SO: 0=always, 1=on central db, 2=on travel db,4 on satellite. The value 5 (1+4) indicates that this application is available when logged in to a central or satellite db

Declaration
public virtual AppAvailState AvailableInState { get; set; }
Property Value
Type Description
AppAvailState
Remarks

Original type in dictionary: Enum.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

ConfigInfo

.NET type: string. Extra configuration information

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

Original type in dictionary: String[2048].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Deleted

.NET type: short. 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

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

Original type in dictionary: UShort.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

ElementType

The type of MDO List Element

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

ExecuteOnEvent

.NET type: ExecuteOnEvent. Events that cause automatic execution of this app

Declaration
public virtual ExecuteOnEvent ExecuteOnEvent { get; set; }
Property Value
Type Description
ExecuteOnEvent
Remarks

Original type in dictionary: Enum.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

ExtAppId

.NET type: int. Primary key

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

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

ExtAppTableInfo

Get the ExtAppTableInfo object associated with the row.

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

Filename

.NET type: string. Filename of the programfile

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

Original type in dictionary: String[240].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Icon

.NET type: short. 0 indicates default Icon (from app exe file), otherwise reference to a predefined icon resource in SO

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

Original type in dictionary: UShort.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Key

Key to the MDO List Element

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

Name

.NET type: string. The list item

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

Original type in dictionary: String[240].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Navigation

.NET type: Navigation. 0=from menu, 1 = from Navigator(integration), 2 = From navigator

Declaration
public virtual Navigation Navigation { get; set; }
Property Value
Type Description
Navigation
Remarks

Original type in dictionary: Enum.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Parameters

.NET type: string. <template variable> <other template variable>

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

Original type in dictionary: String[240].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Path

.NET type: string. Path where the programfile is located; if empty, PATH is used

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

Original type in dictionary: String[240].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Rank

.NET type: short. Rank order

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

Original type in dictionary: UShort.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

ShowState

.NET type: ShowState. Maximized / minimized / restored

Declaration
public virtual ShowState ShowState { get; set; }
Property Value
Type Description
ShowState
Remarks

Original type in dictionary: Enum.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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

Tooltip

.NET type: string. Tooltip or other description

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

Original type in dictionary: String[255].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Url1

.NET type: string. URL, supports long strings up to 1k

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

Original type in dictionary: String[1024].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Url2

.NET type: string. Obsolete - do not use this field

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

Original type in dictionary: String[255].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Value

Returns the current MDO List Element.

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

WaitToFinish

.NET type: short. If 1, we wait synchronously for the pplication to finish before we go on

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

Original type in dictionary: Bool.

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

WindowName

.NET type: string. The window which the URL address is to open in (webpanel only)

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

Original type in dictionary: String[255].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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.

Workdir

.NET type: string. Directory set to current when loading the application, if different from application's own

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

Original type in dictionary: String[240].

Writeable if you have list- or general admin functional rights, or a superoffice code signature

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 ExtAppRow object. ExtApp list table. Applications startable from SuperOffice

Declaration
public static ExtAppRow CreateNew()
Returns
Type Description
ExtAppRow

A new instance of the ExtAppRow object.

GetFromCustomSearch(ExtAppRow.CustomSearch)

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

The custom search to execute against the database

Returns
Type Description
ExtAppRow

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

GetFromIdxExtAppId(Int32)

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

Declaration
public static ExtAppRow GetFromIdxExtAppId(int extAppId)
Parameters
Type Name Description
Int32 extAppId
Returns
Type Description
ExtAppRow

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

GetFromIdxName(String)

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

Declaration
public static ExtAppRow GetFromIdxName(string name)
Parameters
Type Name Description
String name
Returns
Type Description
ExtAppRow

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

GetFromReader(SoDataReader, ExtAppTableInfo)

Create a new instance of the ExtAppRow 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. ExtApp list table. Applications startable from SuperOffice

Declaration
public static ExtAppRow GetFromReader(SoDataReader reader, ExtAppTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

ExtAppTableInfo tableInfo

ExtAppTableInfo 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
ExtAppRow

A new instance of the ExtAppRow 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

_onAppTypeChange

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

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

_onAvailableInStateChange

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

Declaration
protected event OnFieldChange<AppAvailState> _onAvailableInStateChange
Event Type
Type Description
OnFieldChange<AppAvailState>

_onConfigInfoChange

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

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

_onDeletedChange

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

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

_onExecuteOnEventChange

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

Declaration
protected event OnFieldChange<ExecuteOnEvent> _onExecuteOnEventChange
Event Type
Type Description
OnFieldChange<ExecuteOnEvent>

_onFilenameChange

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

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

_onIconChange

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

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

_onNameChange

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

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

_onNavigationChange

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

Declaration
protected event OnFieldChange<Navigation> _onNavigationChange
Event Type
Type Description
OnFieldChange<Navigation>

_onParametersChange

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

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

_onPathChange

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

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

_onRankChange

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

Declaration
protected event OnFieldChange<short> _onRankChange
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>

_onShowStateChange

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

Declaration
protected event OnFieldChange<ShowState> _onShowStateChange
Event Type
Type Description
OnFieldChange<ShowState>

_onTooltipChange

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

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

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

_onUrl1Change

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

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

_onUrl2Change

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

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

_onWaitToFinishChange

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

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

_onWindowNameChange

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

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

_onWorkdirChange

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

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

OnAppTypeChange

Event raised when AppType is changing.

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

OnAvailableInStateChange

Event raised when AvailableInState is changing.

Declaration
public event OnFieldChange<AppAvailState> OnAvailableInStateChange
Event Type
Type Description
OnFieldChange<AppAvailState>

OnConfigInfoChange

Event raised when ConfigInfo is changing.

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

OnDeletedChange

Event raised when Deleted is changing.

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

OnExecuteOnEventChange

Event raised when ExecuteOnEvent is changing.

Declaration
public event OnFieldChange<ExecuteOnEvent> OnExecuteOnEventChange
Event Type
Type Description
OnFieldChange<ExecuteOnEvent>

OnFilenameChange

Event raised when Filename is changing.

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

OnIconChange

Event raised when Icon is changing.

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

OnNameChange

Event raised when Name is changing.

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

OnNavigationChange

Event raised when Navigation is changing.

Declaration
public event OnFieldChange<Navigation> OnNavigationChange
Event Type
Type Description
OnFieldChange<Navigation>

OnParametersChange

Event raised when Parameters is changing.

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

OnPathChange

Event raised when Path is changing.

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

OnRankChange

Event raised when Rank is changing.

Declaration
public event OnFieldChange<short> OnRankChange
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>

OnShowStateChange

Event raised when ShowState is changing.

Declaration
public event OnFieldChange<ShowState> OnShowStateChange
Event Type
Type Description
OnFieldChange<ShowState>

OnTooltipChange

Event raised when Tooltip is changing.

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

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>

OnUrl1Change

Event raised when Url1 is changing.

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

OnUrl2Change

Event raised when Url2 is changing.

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

OnWaitToFinishChange

Event raised when WaitToFinish is changing.

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

OnWindowNameChange

Event raised when WindowName is changing.

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

OnWorkdirChange

Event raised when Workdir is changing.

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

Implements

INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem
IMDOListElement

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