Class Metadata

Namespace

Sage.CRM.Utils

Assembly

SageCRMNet.dll

Class to get access to all metadata within the system including screens and lists. Metadata

public class Metadata

Inheritance

object

Metadata

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

GetBlock(string)

Creates a SageCrmBlock object of the type specified.

[Obsolete("Use: new SageCrmBlock(blockName)")]
public SageCrmBlock GetBlock(string blockName)

Parameters

blockName string

This can be one of the fixed available block types, or the name of an actual block that has been set up in Admin in CRM. The fixed block types available are: Marquee, Message, File, Graphic, Chart, Pipeline, OrgChart.

Returns

SageCrmBlock

A SageCrmBlock object

GetList(string)

Creates a list object from the metadata that can be used to display rows from a CRM table. This should be a list that has been configured within CRM Admin customization.

[Obsolete("Use: new List(listName)")]
public List GetList(string listName)

Parameters

listName string

The name of the list to return.

Returns

List

A List objectList

GetParam(ParamNames)

Check the value of a system parameter.

public string GetParam(ParamNames paramName)

Parameters

paramName ParamNames

The name of the parameter.ParamNames

Returns

string

String with the value of parameter.

GetParam(string)

Check the value of a system parameter.

public string GetParam(string paramName)

Parameters

paramName string

The name of the parameter.ParamNames

Returns

string

String with the value of parameter.

GetScreen()

Creates an empty EntryGroup object with no fields in it. Fields can then be added as required with the EntryGroup.AddEntry() method.

[Obsolete("Use: new EntryGroup(screenName)")]
public EntryGroup GetScreen()

Returns

EntryGroup

An EntryGroup object

GetScreen(string)

Creates a EntryGroup object from the metadata that can be used to view/edit data from a CRM table.

[Obsolete("Use: new EntryGroup(screenName)")]
public EntryGroup GetScreen(string screenName)

Parameters

screenName string

Name of EntryGroup (screen). This should be an EntryGroup that has been configured within CRM Admin customization.

Returns

EntryGroup

An EntryGroup object.

GetTableInfo(string)

Creates a TableInfo object which holds configuration information about a table in the CRM database.

public TableInfo GetTableInfo(string tableName)

Parameters

tableName string

Name or caption of the table to return.

Returns

TableInfo

A TableInfo object.TableInfo

GetTableInfoFromKey(int)

Creates a TableInfo object which holds configuration info about a table in the CRM database.

public TableInfo GetTableInfoFromKey(int KeyIndex)

Parameters

KeyIndex int

Key index of the table to return.

Returns

TableInfo

A TableInfo object.TableInfo

GetTranslation(string, string, bool)

Gets the translation of a caption in the current user language with option to switch off inline translation.

public string GetTranslation(string family, string code, bool nohottranslate)

Parameters

family string

Translation family.

code string

Translation code.

nohottranslate bool

Do not use inline translation.

Returns

string

Translated value.

GetTranslation(string, string)

Gets the translation of a caption in the current user's language.

public string GetTranslation(string family, string code)

Parameters

family string

Translation family.

code string

Translation code.

Returns

string

Translated value.

TableAllowed(string)

Returns true if table is allowed to use in the system.

public bool TableAllowed(string ATableName)

Parameters

ATableName string

Table name to check.

Returns

bool

True if table is allowed. False if table is not allowed.