Class PrefDescCache

Cache for Preference Descriptions, stored in the prefdesc table. Since this table is only updated during upgrades, which imply a recycle anyway, it has a lifetime limited only by the database connection. There are about 700 prefdesc rows

Inheritance
object
PrefDescCache
Inherited Members
Namespace: SuperOffice.Data
Assembly: SoDataBase.dll
Syntax
[SoInject("Database")]
public class PrefDescCache

Properties

Descriptions

Cache for Preference Descriptions, stored in the prefdesc table. Since this table is only updated during upgrades, which imply a recycle anyway, it has a lifetime limited only by the database connection. There are about 700 prefdesc rows

Declaration
public IEnumerable<PrefDescRecordData> Descriptions { get; }
Property Value
Type Description
IEnumerable<PrefDescRecordData>

Methods

GetAllDescriptions()

Cache for Preference Descriptions, stored in the prefdesc table. Since this table is only updated during upgrades, which imply a recycle anyway, it has a lifetime limited only by the database connection. There are about 700 prefdesc rows

Declaration
public PrefDescRecordData[] GetAllDescriptions()
Returns
Type Description
PrefDescRecordData[]

GetDescription(int)

Get the description that corresponds to a given ID

Declaration
public PrefDescRecordData GetDescription(int id)
Parameters
Type Name Description
int id
Returns
Type Description
PrefDescRecordData

GetDescription(string, string)

Get the description that corresponds to a given section/key; case-insensitive search

Declaration
public PrefDescRecordData GetDescription(string section, string key)
Parameters
Type Name Description
string section
string key
Returns
Type Description
PrefDescRecordData

GetKeysInSection(string)

Cache for Preference Descriptions, stored in the prefdesc table. Since this table is only updated during upgrades, which imply a recycle anyway, it has a lifetime limited only by the database connection. There are about 700 prefdesc rows

Declaration
public string[] GetKeysInSection(string section)
Parameters
Type Name Description
string section
Returns
Type Description
string[]

GetLine(int)

Get the line description and showvalue that correspond to a given ID

Declaration
public PrefDescLineRecordData GetLine(int id)
Parameters
Type Name Description
int id
Returns
Type Description
PrefDescLineRecordData

GetLine(int, string)

Get the line description and showvalue that correspond to a a preference that comes from a prefdescline list item

Declaration
public PrefDescLineRecordData GetLine(int prefDescId, string prefValue)
Parameters
Type Name Description
int prefDescId
string prefValue
Returns
Type Description
PrefDescLineRecordData

GetLines(int)

Cache for Preference Descriptions, stored in the prefdesc table. Since this table is only updated during upgrades, which imply a recycle anyway, it has a lifetime limited only by the database connection. There are about 700 prefdesc rows

Declaration
public IEnumerable<PrefDescLineRecordData> GetLines(int prefDescId)
Parameters
Type Name Description
int prefDescId
Returns
Type Description
IEnumerable<PrefDescLineRecordData>

GetLines(string, string)

Cache for Preference Descriptions, stored in the prefdesc table. Since this table is only updated during upgrades, which imply a recycle anyway, it has a lifetime limited only by the database connection. There are about 700 prefdesc rows

Declaration
public IEnumerable<PrefDescLineRecordData> GetLines(string section, string prefkey)
Parameters
Type Name Description
string section
string prefkey
Returns
Type Description
IEnumerable<PrefDescLineRecordData>

GetSection(string)

Get the description that corresponds to a given section/key; case-insensitive search

Declaration
public PrefDescRecordData GetSection(string section)
Parameters
Type Name Description
string section
Returns
Type Description
PrefDescRecordData

Extension Methods