Show / Hide Table of Contents

Class DashboardTableInfo

Table 'dashboard': Describes a dashboard

Inheritance
Object
TableInfo
DashboardTableInfo
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("dashboard")]
public class DashboardTableInfo : 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 Dashboard in the database dictionary: dashboard

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

Properties

AssociateId

Field 'associate_id' in table 'dashboard': Dictionary type FK, .NET type: Int32

Associate who owns this dashboard

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

AssociateId_InnerJoin_Associate

Generated join from the foreign key AssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> AssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

Columns

Field 'columns' in table 'dashboard': Dictionary type Int, .NET type: Int32

How many columns there will be in the dashboard.

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

DashboardId

Field 'dashboard_id' in table 'dashboard': Dictionary type PK, .NET type: Int32

Primary key

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

DashboardThemeId

Field 'dashboard_theme_id' in table 'dashboard': Dictionary type FK, .NET type: Int32

The theme belongs to set of slyle rules for the dashboard

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

DashboardThemeId_InnerJoin_DashboardTheme

Generated join from the foreign key DashboardThemeId in this table, to its target table DashboardThemeTableInfo.

Declaration
public TargetedInnerJoin<DashboardThemeTableInfo> DashboardThemeId_InnerJoin_DashboardTheme { get; }
Property Value
Type Description
TargetedInnerJoin<DashboardThemeTableInfo>

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 'dashboard': Dictionary type String[4001], .NET type: String

Detailed description

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

DictionaryTableNumber

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

Guid

Field 'guid' in table 'dashboard': Dictionary type String[37], .NET type: String

GUID identifying a default dashboard from SuperOffice

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

LeftOuterJoin_DashboardTile_DashboardId

Generated left outer join from the primary key DashboardId on this table, to DashboardTile.DashboardId.

Declaration
public TargetedLeftOuterJoin<DashboardTileTableInfo> LeftOuterJoin_DashboardTile_DashboardId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<DashboardTileTableInfo>

Name

Field 'name' in table 'dashboard': Dictionary type String[4001], .NET type: String

The name of this dashboard

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

PinForAll

Field 'pin_for_all' in table 'dashboard': Dictionary type Bool, .NET type: Int16

True if pinned for all

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

PinForAssociates

Field 'pin_for_associates' in table 'dashboard': Dictionary type FKArray, .NET type: Int32

Array of references to the pinned associates

Declaration
public Int32ArrayFieldInfo PinForAssociates { get; }
Property Value
Type Description
Int32ArrayFieldInfo

PinForGroups

Field 'pin_for_groups' in table 'dashboard': Dictionary type FKArray, .NET type: Int32

Array of references to the pinned groups

Declaration
public Int32ArrayFieldInfo PinForGroups { get; }
Property Value
Type Description
Int32ArrayFieldInfo

Registered

Field 'registered' in table 'dashboard': Dictionary type UtcDateTime, .NET type: DateTime

Registered when

Declaration
public DateTimeFieldInfo Registered { get; }
Property Value
Type Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'dashboard': Dictionary type FK, .NET type: Int32

Registered by whom

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

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

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

Updated

Field 'updated' in table 'dashboard': Dictionary type UtcDateTime, .NET type: DateTime

Last updated when

Declaration
public DateTimeFieldInfo Updated { get; }
Property Value
Type Description
DateTimeFieldInfo

UpdatedAssociateId

Field 'updated_associate_id' in table 'dashboard': Dictionary type FK, .NET type: Int32

Last updated by whom

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

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

Field 'updatedCount' in table 'dashboard': Dictionary type UShort, .NET type: Int16

Number of updates made to this record

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

VisibleForAll

Field 'visible_for_all' in table 'dashboard': Dictionary type Bool, .NET type: Int16

True if visible for all

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

VisibleForAssociates

Field 'visible_for_associates' in table 'dashboard': Dictionary type FKArray, .NET type: Int32

Array of references to the visible for associates

Declaration
public Int32ArrayFieldInfo VisibleForAssociates { get; }
Property Value
Type Description
Int32ArrayFieldInfo

VisibleForGroups

Field 'visible_for_groups' in table 'dashboard': Dictionary type FKArray, .NET type: Int32

Array of references to the visible for groups

Declaration
public Int32ArrayFieldInfo VisibleForGroups { get; }
Property Value
Type Description
Int32ArrayFieldInfo

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