Class SoDictionary
Implementation of the SuperOffice Deployed Dictionary
Namespace: SuperOffice.Data.Dictionary
Assembly: SoDataBase.dll
Syntax
public class SoDictionary : ObjectProperties
IsDatabaseUnicode
Is the database unicode, i.e., strings stored in unicode (usually UTF16)? If not, then ANSI with the current code page is used
Declaration
public bool IsDatabaseUnicode { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
IsLoaded
Implementation of the SuperOffice Deployed Dictionary
Declaration
public bool IsLoaded { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Item[FieldInfo]
Return an SoField object based on a FieldInfo (name/name lookup)
Declaration
public SoField this[FieldInfo fieldInfo] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| FieldInfo | fieldInfo | FieldInfo used for the lookup; its name and its table name are used |
Property Value
| Type | Description |
|---|---|
| SoField | Field definition object |
Item[TableInfo]
Return an SoTable object based on a TableInfo object
Declaration
public SoTable this[TableInfo tableInfo] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| TableInfo | tableInfo |
Property Value
| Type | Description |
|---|---|
| SoTable | Table definition object |
Item[Int32]
Return an SoTable object based on the table number
Declaration
public SoTable this[int key] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | key | Table number (please do not hardcode as they may change!) |
Property Value
| Type | Description |
|---|---|
| SoTable | Table definition object |
Item[String]
Return an SoTable object based on the table name
Declaration
public SoTable this[string tableName] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName |
Property Value
| Type | Description |
|---|---|
| SoTable | Table definition object |
ListInfoIsLoaded
Implementation of the SuperOffice Deployed Dictionary
Declaration
public bool ListInfoIsLoaded { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Tables
Get a list of all the Tables in the deployed dictionary
Declaration
public SoTable[] Tables { get; }Property Value
| Type | Description |
|---|---|
| SoTable[] |
Methods
GetColumnIndex(Int32)
Get the column index from a composite field id
Declaration
public static int GetColumnIndex(int fieldId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fieldId | Dictionary field id |
Returns
| Type | Description |
|---|---|
| Int32 | Column index, first column of a table has index 0 |
GetFromFieldNumber(Int32)
Get the SoField object, based on the field number (C++ style table + field number combination)
Declaration
public SoField GetFromFieldNumber(int fieldNumber)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fieldNumber | Field number, consists of table number << 8 + zero-based field number |
Returns
| Type | Description |
|---|---|
| SoField | Field definition, null if the field number does not correspond to a field |
GetFromTableName(String)
Get the SoTable object based on the table name. Same as the string indexer.
Declaration
public SoTable GetFromTableName(string tableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName |
Returns
| Type | Description |
|---|---|
| SoTable | Table definition; null if the table name does not correspond to a table |
GetFromTableNumber(Int32)
Get the SoTable object based on the SODBIF table number
Declaration
public SoTable GetFromTableNumber(int tableNumber)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | tableNumber | Table number, sequence = 0 |
Returns
| Type | Description |
|---|---|
| SoTable | Table definition; null if the table number does not correspond to a table |
GetStepsFromNetServerCode()
Get information about what steps have contributed with generated code in this installation. All loaded assemblies (including partner code) are included in the scan.
Declaration
public static DictionaryStepInfo[] GetStepsFromNetServerCode()Returns
| Type | Description |
|---|---|
| DictionaryStepInfo[] |
GetStepsInDatabase()
Get information about what steps have been applied to the database
Declaration
public DictionaryStepInfo[] GetStepsInDatabase()Returns
| Type | Description |
|---|---|
| DictionaryStepInfo[] |
GetTableNumber(Int32)
Get the table number from a composite field id
Declaration
public static int GetTableNumber(int fieldId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | fieldId | Dictionary field id |
Returns
| Type | Description |
|---|---|
| Int32 | Table number the field resides in |
HasTable(String)
Check if the given table (by name) exists in the dictionary
Declaration
public bool HasTable(string tableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | Table name to check, case insensitive |
Returns
| Type | Description |
|---|---|
| Boolean | true if the table exists in the dictionary |
IsSpecialDbPatchInstalled(String)
Check if a certain special database patch has been installed on this database, by patch name
Declaration
public bool IsSpecialDbPatchInstalled(string patchName)Parameters
| Type | Name | Description |
|---|---|---|
| String | patchName | Patch name, case insensitive |
Returns
| Type | Description |
|---|---|
| Boolean | true if patch has been enabled |