Class UdefHelper

This class contains helper functions for handling user-defined fields.

Inheritance

Object

UdefHelper

Namespace: SuperOffice.Data

Assembly: SoDataBase.dll

Syntax

public class UdefHelper : Object

Fields

AdminPage1LineNo

This class contains helper functions for handling user-defined fields.

Declaration

public const int AdminPage1LineNo = 10000

Field Value

Type	Description
Int32

Methods

CheckRevision()

This class contains helper functions for handling user-defined fields.

Declaration

public static void CheckRevision()

CompareUdefRows(UDefFieldRow, UDefFieldRow)

This class contains helper functions for handling user-defined fields.

Declaration

public static bool CompareUdefRows(UDefFieldRow leftRow, UDefFieldRow rightRow)

Parameters

Type	Name	Description
UDefFieldRow	leftRow
UDefFieldRow	rightRow

Returns

Type	Description
Boolean

ConvertFromAdminLineNo(Int32)

This class contains helper functions for handling user-defined fields.

Declaration

public static short ConvertFromAdminLineNo(int lineNo)

Parameters

Type	Name	Description
Int32	lineNo

Returns

Type	Description
Int16

ConvertToAdminLineNo(Int32)

This class contains helper functions for handling user-defined fields.

Declaration

public static short ConvertToAdminLineNo(int lineNo)

Parameters

Type	Name	Description
Int32	lineNo

Returns

Type	Description
Int16

FindAvailableField(UDefType, UDefFieldType)

This class contains helper functions for handling user-defined fields.

Declaration

public static FieldInfo FindAvailableField(UDefType type, UDefFieldType fieldType)

Parameters

Type	Name	Description
UDefType	type
UDefFieldType	fieldType

Returns

Type	Description
FieldInfo

FindAvailableField(UDefType, UDefFieldType, Boolean)

Find available field of given type

Declaration

public static FieldInfo FindAvailableField(UDefType type, UDefFieldType fieldType, bool isIndexed)

Parameters

Type	Name	Description
UDefType	type
UDefFieldType	fieldType
Boolean	isIndexed	Dummy parameter for backwards compatibility. Indexin no longer influences field allocation

Returns

Type	Description
FieldInfo

GetAdminVersion(UDefType)

Get the current version number for the given udef type

Declaration

public static int GetAdminVersion(UDefType type)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones

Returns

Type	Description
Int32	Current version number for the given udef type

GetAdminVersions()

Return an array of pairs indicating the UDefTypes present in the system, and the current version for each of them

Declaration

public static Dictionary<UDefType, int> GetAdminVersions()

Returns

Type	Description
Dictionary<UDefType, Int32>

GetAdminVersions(UDefType[])

This class contains helper functions for handling user-defined fields.

Declaration

public static Dictionary<UDefType, int> GetAdminVersions(params UDefType[] types)

Parameters

Type	Name	Description
UDefType[]	types

Returns

Type	Description
Dictionary<UDefType, Int32>

GetAllFields(UDefType, UDefFieldType)

This class contains helper functions for handling user-defined fields.

Declaration

public static IEnumerable<FieldInfo> GetAllFields(UDefType type, UDefFieldType fieldType)

Parameters

Type	Name	Description
UDefType	type
UDefFieldType	fieldType

Returns

Type	Description
IEnumerable<FieldInfo>

GetCurrentVersion(UDefType)

Get the current version number for the given udef type

Declaration

public static int GetCurrentVersion(UDefType type)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones

Returns

Type	Description
Int32	Current version number for the given udef type

GetCurrentVersions()

Return an array of pairs indicating the UDefTypes present in the system, and the current version for each of them

Declaration

public static Dictionary<UDefType, int> GetCurrentVersions()

Returns

Type	Description
Dictionary<UDefType, Int32>

GetCurrentVersions(UDefType[])

This class contains helper functions for handling user-defined fields.

Declaration

public static Dictionary<UDefType, int> GetCurrentVersions(params UDefType[] types)

Parameters

Type	Name	Description
UDefType[]	types

Returns

Type	Description
Dictionary<UDefType, Int32>

GetTableInfo(UDefType)

This class contains helper functions for handling user-defined fields.

Declaration

public static TableInfo GetTableInfo(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
TableInfo

GetTableInfoLarge(UDefType)

This class contains helper functions for handling user-defined fields.

Declaration

public static TableInfo GetTableInfoLarge(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
TableInfo

GetTableInfoLargeOrSmall(UDefType, UDefFieldType)

This class contains helper functions for handling user-defined fields.

Declaration

public static TableInfo GetTableInfoLargeOrSmall(UDefType type, UDefFieldType fieldType)

Parameters

Type	Name	Description
UDefType	type
UDefFieldType	fieldType

Returns

Type	Description
TableInfo

GetTableInfoSmall(UDefType)

This class contains helper functions for handling user-defined fields.

Declaration

public static TableInfo GetTableInfoSmall(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
TableInfo

GetTemplateVariableName(UDefType, UDefFieldType, Int32)

This class contains helper functions for handling user-defined fields.

Declaration

public static string GetTemplateVariableName(UDefType udefType, UDefFieldType udefFieldType, int columnId)

Parameters

Type	Name	Description
UDefType	udefType
UDefFieldType	udefFieldType
Int32	columnId

Returns

Type	Description
String

GetUdefType(TableInfo)

Get the udef type of the given table

Declaration

public static UDefType GetUdefType(TableInfo tableInfo)

Parameters

Type	Name	Description
TableInfo	tableInfo	Table info object

Returns

Type	Description
UDefType	udef type of table

GetUdefType(Int32)

Get the udef type of the given table

Declaration

public static UDefType GetUdefType(int tableNumber)

Parameters

Type	Name	Description
Int32	tableNumber	0-based table index

Returns

Type	Description
UDefType	udef type of table

GetUserPreferenceMDOListString(UDefType)

This class contains helper functions for handling user-defined fields.

Declaration

public static string GetUserPreferenceMDOListString(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
String

GetUserPreferenceMDOListStringAdmin(UDefType)

This class contains helper functions for handling user-defined fields.

Declaration

public static string GetUserPreferenceMDOListStringAdmin(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
String

GetVersionPreferenceAdmin(UDefType)

Get the version preference string for the given udef type

Declaration

public static string GetVersionPreferenceAdmin(UDefType type)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones

Returns

Type	Description
String	Preference key for the current version

GetVersionPreferenceCurrent(UDefType)

Get the version preference string for the given udef type

Declaration

public static string GetVersionPreferenceCurrent(UDefType type)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones

Returns

Type	Description
String	Preference key for the current version

IncrementAdminVersion(UDefType)

Set the admin version number for the given udef type

Declaration

public static int IncrementAdminVersion(UDefType type)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones

Returns

Type	Description
Int32	Current version number for the given udef type

IncrementCurrentVersion(UDefType)

Set the current version number for the given udef type to the adminversion.

Declaration

public static int IncrementCurrentVersion(UDefType type)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones

Returns

Type	Description
Int32	Current version number for the given udef type

IsLargeTableColumn(Int32)

This class contains helper functions for handling user-defined fields.

Declaration

public static bool IsLargeTableColumn(int columnId)

Parameters

Type	Name	Description
Int32	columnId

Returns

Type	Description
Boolean

IsPageOneMDO(UDefType)

This class contains helper functions for handling user-defined fields.

Declaration

public static bool IsPageOneMDO(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
Boolean

IsSmallTableColumn(Int32)

This class contains helper functions for handling user-defined fields.

Declaration

public static bool IsSmallTableColumn(int columnId)

Parameters

Type	Name	Description
Int32	columnId

Returns

Type	Description
Boolean

IsUnpublishedPageOneMDO(UDefType)

This class contains helper functions for handling user-defined fields.

Declaration

public static bool IsUnpublishedPageOneMDO(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
Boolean

SetAdminVersion(UDefType, Int32)

Set the admin version number for the given udef type

Declaration

public static void SetAdminVersion(UDefType type, int version)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones
Int32	version

SetCurrentVersion(UDefType, Int32)

Set the current version number for the given udef type

Declaration

public static void SetCurrentVersion(UDefType type, int version)

Parameters

Type	Name	Description
UDefType	type	Udef type, should be one of the "valid" ones
Int32	version

SetRankOnFields(UDefType, Int32[])

This class contains helper functions for handling user-defined fields.

Declaration

public static void SetRankOnFields(UDefType ownerType, int[] rankedFieldsIds)

Parameters

Type	Name	Description
UDefType	ownerType
Int32[]	rankedFieldsIds

SuggestLocation(UDefType, out Int32, out Int32, Int32, Int32, out Int32, out Int32)

This class contains helper functions for handling user-defined fields.

Declaration

public static void SuggestLocation(UDefType type, out int labelLeft, out int labelTop, int labelWidth, int labelHeight, out int fieldLeft, out int fieldTop)

Parameters

Type	Name	Description
UDefType	type
Int32	labelLeft
Int32	labelTop
Int32	labelWidth
Int32	labelHeight
Int32	fieldLeft
Int32	fieldTop

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)