Show / Hide Table of Contents

Class ScreenDefinitionTableInfo

Table 'screen_definition': A configurable screen

Inheritance
Object
TableInfo
ScreenDefinitionTableInfo
Implements
ICloneable
Inherited Members
TableInfo.ToString()
TableInfo.RegisterFields(FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(String)
TableInfo.ProtAll
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.Item[String]
TableInfo.PrimaryKeyField
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("screen_definition")]
public class ScreenDefinitionTableInfo : TableInfo, ICloneable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table ScreenDefinition in the database dictionary: screen_definition

Declaration
public const string DictionaryTableName = "screen_definition"
Field Value
Type Description
String

Properties

Autosave

Field 'autosave' in table 'screen_definition': Dictionary type Bool, .NET type: Int16

Whether this screen uses autosave or not

Declaration
public UInt16FieldInfo Autosave { get; }
Property Value
Type Description
UInt16FieldInfo

CreationScript

Field 'creation_script' in table 'screen_definition': Dictionary type Clob, .NET type: String

The script used at the top of all other creation scripts on this page

Declaration
public StringFieldInfo CreationScript { get; }
Property Value
Type Description
StringFieldInfo

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides
TableInfo.Definition

Description

Field 'description' in table 'screen_definition': Dictionary type String[2048], .NET type: String

Optional description of what this screen is used for

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

DictionaryTableNumber

Table number for table ScreenDefinition in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

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

HierarchyId

Field 'hierarchy_id' in table 'screen_definition': Dictionary type FK, .NET type: Int32

The screen definition is inside this hierarchy folder

Declaration
public Int32FieldInfo HierarchyId { get; }
Property Value
Type Description
Int32FieldInfo

HierarchyId_InnerJoin_Hierarchy

Generated join from the foreign key HierarchyId in this table, to its target table HierarchyTableInfo.

Declaration
public TargetedInnerJoin<HierarchyTableInfo> HierarchyId_InnerJoin_Hierarchy { get; }
Property Value
Type Description
TargetedInnerJoin<HierarchyTableInfo>

IdString

Field 'id_string' in table 'screen_definition': Dictionary type String[256], .NET type: String

A field for an id_string which may be used to access the screen

Declaration
public StringFieldInfo IdString { get; }
Property Value
Type Description
StringFieldInfo

LayoutModel

Field 'layout_model' in table 'screen_definition': Dictionary type Enum, .NET type: Int16

An enum for which layout model this screen is using.

Declaration
public UInt16FieldInfo LayoutModel { get; }
Property Value
Type Description
UInt16FieldInfo

LeftOuterJoin_ScreenDefinitionAction_ScreenDefinition

Generated left outer join from the primary key ScreenDefinitionId on this table, to ScreenDefinitionAction.ScreenDefinition.

Declaration
public TargetedLeftOuterJoin<ScreenDefinitionActionTableInfo> LeftOuterJoin_ScreenDefinitionAction_ScreenDefinition { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ScreenDefinitionActionTableInfo>

LeftOuterJoin_ScreenDefinitionElement_ScreenDefinition

Generated left outer join from the primary key ScreenDefinitionId on this table, to ScreenDefinitionElement.ScreenDefinition.

Declaration
public TargetedLeftOuterJoin<ScreenDefinitionElementTableInfo> LeftOuterJoin_ScreenDefinitionElement_ScreenDefinition { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ScreenDefinitionElementTableInfo>

LeftOuterJoin_ScreenDefinitionHidden_ScreenDefinition

Generated left outer join from the primary key ScreenDefinitionId on this table, to ScreenDefinitionHidden.ScreenDefinition.

Declaration
public TargetedLeftOuterJoin<ScreenDefinitionHiddenTableInfo> LeftOuterJoin_ScreenDefinitionHidden_ScreenDefinition { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ScreenDefinitionHiddenTableInfo>

LeftOuterJoin_ScreenDefinitionLanguage_ScreenDefinition

Generated left outer join from the primary key ScreenDefinitionId on this table, to ScreenDefinitionLanguage.ScreenDefinition.

Declaration
public TargetedLeftOuterJoin<ScreenDefinitionLanguageTableInfo> LeftOuterJoin_ScreenDefinitionLanguage_ScreenDefinition { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ScreenDefinitionLanguageTableInfo>

LoadFinalScriptBody

Field 'load_final_script_body' in table 'screen_definition': Dictionary type Clob, .NET type: String

The ejscript to execute just before the page is printed, after button/action scripts have been run

Declaration
public StringFieldInfo LoadFinalScriptBody { get; }
Property Value
Type Description
StringFieldInfo

LoadPostCgiScriptBody

Field 'load_post_cgi_script_body' in table 'screen_definition': Dictionary type Clob, .NET type: String

The ejscript to execute after setFromCgi, e.g. when the page is submitted

Declaration
public StringFieldInfo LoadPostCgiScriptBody { get; }
Property Value
Type Description
StringFieldInfo

LoadScriptBody

Field 'load_script_body' in table 'screen_definition': Dictionary type Clob, .NET type: String

The ejscript to execute the first time this screen is loaded, e.g. for form loading

Declaration
public StringFieldInfo LoadScriptBody { get; }
Property Value
Type Description
StringFieldInfo

Name

Field 'name' in table 'screen_definition': Dictionary type String[256], .NET type: String

A field for entering the name of this entry

Declaration
public StringFieldInfo Name { get; }
Property Value
Type Description
StringFieldInfo

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable

ScreenDefinitionId

Field 'id' in table 'screen_definition': Dictionary type PK, .NET type: Int32

Primary key

Declaration
public Int32FieldInfo ScreenDefinitionId { get; }
Property Value
Type Description
Int32FieldInfo

ScreenKey

Field 'screen_key' in table 'screen_definition': Dictionary type String[256], .NET type: String

This field holds the authentication key if used

Declaration
public StringFieldInfo ScreenKey { get; }
Property Value
Type Description
StringFieldInfo

WarnOnNavigate

Field 'warn_on_navigate' in table 'screen_definition': Dictionary type Bool, .NET type: Int16

Decides if user will get a warning if he accidentally navigates away from unsaved changes for this screen

Declaration
public UInt16FieldInfo WarnOnNavigate { get; }
Property Value
Type Description
UInt16FieldInfo

Implements

System.ICloneable

Extension Methods

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