Show / Hide Table of Contents

Class HelpTableInfo

Table 'help': This table contains the help pages.

Inheritance
Object
TableInfo
HelpTableInfo
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("help")]
public class HelpTableInfo : 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 Help in the database dictionary: help

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

Properties

ApplicationAreaId

Field 'application_area_id' in table 'help': Dictionary type Int, .NET type: Int32

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

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

Body

Field 'body' in table 'help': Dictionary type Clob, .NET type: String

The actual body for the helppage. HTML format.

Declaration
public StringFieldInfo Body { 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

DictionaryTableNumber

Table number for table Help 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

HelpId

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

The primary key (auto-incremented)

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

Language

Field 'language' in table 'help': Dictionary type String[6], .NET type: String

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

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

ModuleId

Field 'module_id' in table 'help': Dictionary type Int, .NET type: Int32

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

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

Name

Field 'name' in table 'help': Dictionary type String[65], .NET type: String

The name for this help page.

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

ParentId

Field 'parent_id' in table 'help': Dictionary type FK, .NET type: Int32

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

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

ParentId_InnerJoin_Help

Generated join from the foreign key ParentId in this table, to its target table HelpTableInfo.

Declaration
public TargetedInnerJoin<HelpTableInfo> ParentId_InnerJoin_Help { get; }
Property Value
Type Description
TargetedInnerJoin<HelpTableInfo>

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

ScreenId

Field 'screen_id' in table 'help': Dictionary type Int, .NET type: Int32

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

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

SortOrder

Field 'sort_order' in table 'help': Dictionary type Int, .NET type: Int32

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

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

Title

Field 'title' in table 'help': Dictionary type String[256], .NET type: String

The title for this help page.

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

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