Class HelpRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the help table.

Inheritance
Object
HelpRecordData
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class HelpRecordData : Object
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

HelpRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the help table.

Declaration
public HelpRecordData()
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

ApplicationAreaId

The id of the application_area, if this page is the description for a application_area..

Declaration
public int ApplicationAreaId
Field Value
Type Description
Int32
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Body

The actual body for the helppage. HTML format.

Declaration
public string Body
Field Value
Type Description
String
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

HelpId

The primary key (auto-incremented)

Declaration
public int HelpId
Field Value
Type Description
Int32
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Language

A string indicating the language for this helppage ('no' or 'en').

Declaration
public string Language
Field Value
Type Description
String
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ModuleId

The id of the module, if this page is the description for a module..

Declaration
public int ModuleId
Field Value
Type Description
Int32
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Name

The name for this help page.

Declaration
public string Name
Field Value
Type Description
String
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ParentId

The id of the parent help page. NULL or -1 if this is a toplevel helppage.

Declaration
public int ParentId
Field Value
Type Description
Int32
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ScreenId

The id of the screen, if this page is the description for a screen..

Declaration
public int ScreenId
Field Value
Type Description
Int32
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SortOrder

The sort-order for this helppage when listed among its siblings.

Declaration
public int SortOrder
Field Value
Type Description
Int32
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Title

The title for this help page.

Declaration
public string Title
Field Value
Type Description
String
Remarks

Please use this class instead of a full HelpRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding HelpTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods

EnumUtil.MapEnums<From, To>(From)