Table of Contents

Class EntryGroup

Namespace
Sage.CRM.Controls
Assembly
SageCRMNet.dll

Class to represent a CRM Screen.

public class EntryGroup : ComplexBox, IList<Entry>, ICollection<Entry>, IEnumerable<Entry>, IEnumerable, IDisposable
Inheritance
EntryGroup
Implements
Inherited Members

Constructors

EntryGroup(string, string, bool)

Initializes a new instance of EntryGroup.

public EntryGroup(string screenName, string title, bool newLine)

Parameters

screenName string

Metadata Screen Name.

title string

Box Title.

newLine bool

New Line.

EntryGroup(string, string)

Initializes a new instance of EntryGroup.

public EntryGroup(string screenName, string title)

Parameters

screenName string

Metadata Screen Name.

title string

Box Title.

EntryGroup(string)

Initializes a new instance of EntryGroup.

public EntryGroup(string screenName)

Parameters

screenName string

Metadata Screen Name.

Properties

Cols

Number of columns this group should take up within HTML <TABLE> control. The minimal value is 1.

public int Cols { get; set; }

Property Value

int

Count

Gets the number of Entries contained in the List.

public int Count { get; }

Property Value

int

CustomContent

Sets the Custom Content on the EntryGroup. This is extra HTML or Javascript that will be included when the EntryGroup is rendered.

public string CustomContent { get; set; }

Property Value

string

EntityName

Gets the Entity Name for the current EntityGroup.

public string EntityName { get; }

Property Value

string

getRecord

Return the current record for the EntryGroup.

public Record getRecord { get; }

Property Value

Record

hasRecord

Return true if the EntryGroup has a record correctly set.

public bool hasRecord { get; }

Property Value

bool

IsReadOnly

Gets a value indicating whether the EntryGroup is read-only.

public bool IsReadOnly { get; }

Property Value

bool

this[int]

Gets or sets the Entry element at the specified index (position).

public Entry this[int index] { get; set; }

Parameters

index int

Index.

Property Value

Entry

Entry.

Mode

Gets or Sets the Current Mode to the EntryGroup.

public Mode Mode { get; set; }

Property Value

Mode

ModeUpdated

Returns true if the mode was updated externally.

public bool ModeUpdated { get; }

Property Value

bool

NewLine

Specifies whether this EntryGroup appears on a new line when the group is added to DataPage.EntryGroups.

public bool NewLine { get; set; }

Property Value

bool

Rows

Number of rows this group should take up within HTML <TABLE> control. The minimal value is 1.

public int Rows { get; set; }

Property Value

int

Methods

Add(Entry)

Adds an Entry to the List.

public void Add(Entry item)

Parameters

item Entry

Entry.

Clear()

Removes all Entry from the List.

public void Clear()

Contains(Entry)

Determines whether the List contains a specific Entry.

public bool Contains(Entry item)

Parameters

item Entry

Entry.

Returns

bool

True if the Entry is found.

CopyTo(Entry[], int)

Copies the Entrys to an Array, starting at a particular Array index.

public void CopyTo(Entry[] array, int arrayIndex)

Parameters

array Entry[]

One-dimensional Array that is the destination.

arrayIndex int

Index in array at which copying begins.

CreateEntry(string)

Creates and adds a new field to this EntryGroup.

[Obsolete("Use: New Entry(fieldName); EntryGroup.Add(Entry);")]
public Entry CreateEntry(string fieldName)

Parameters

fieldName string

Name of the field to add. If this is an existing field within CRM then the field will be created with the properties of that field, otherwise it will be a "Blank" field, and the entry type and other controlling properties must be set explicitly.

Returns

Entry

Entry object representing the field just added.

CreateEntrySelect(string)

This method is obsolete.

[Obsolete("Use: New EntrySelect(fieldName); EntryGroup.Add(EntrySelect);")]
public EntrySelect CreateEntrySelect(string fieldName)

Parameters

fieldName string

Returns

EntrySelect

Examples

Use this code instead:

EntryGroup screenCompany = new EntryGroup("CompanyBoxLong");
EntrySelect es = New EntrySelect("comp_phonenumber")
screenCompany.Add(es);

CreateEntrySelectTable(string)

This method is obsolete. See EntryGroup.CreateEntrySelect.

[Obsolete("Use: New EntrySelectTable(fieldName); EntryGroup.Add(EntrySelectTable);")]
public EntrySelectTable CreateEntrySelectTable(string fieldName)

Parameters

fieldName string

Returns

EntrySelectTable

Dispose() 

public void Dispose()

Fill(Entity)

Fills the EntryGroup with a value from Entity.

public void Fill(Entity entityObject)

Parameters

entityObject Entity

Entity

Fill(Record)

Fills the EntryGroup with a value from Record.

public void Fill(Record recordObject)

Parameters

recordObject Record

Record

Fill(DataSource)

Fills the EntryGroup with a value from FromContent or FromDefault.

public void Fill(DataSource source)

Parameters

source DataSource

DataSource

FillEntityFromContent(Record)

Enters values from a screen into an Entity object.

[Obsolete("Use the method FILL")]
public void FillEntityFromContent(Record recordObject)

Parameters

recordObject Record

~EntryGroup()

Destructor class for the EntryGroup.

protected ~EntryGroup()

GetEntry(string)

Returns an entry object, representing one of the fields within the screen.

public Entry GetEntry(string fieldName)

Parameters

fieldName string

Field name of one of the fields within the screen.

Returns

Entry

Entry object.

GetEnumerator()

Returns an enumerator that iterates through a collection.

public IEnumerator<Entry> GetEnumerator()

Returns

IEnumerator<Entry>

GetHtmlInEditMode()

Returns HTML to show the screen in edit mode.

public string GetHtmlInEditMode()

Returns

string

HTML string.

GetHtmlInEditMode(Entity)

Returns HTML to show the screen in edit mode, getting values from the Entity Object.

public string GetHtmlInEditMode(Entity entityObject)

Parameters

entityObject Entity

Entity object pointing at a row.

Returns

string

HTML string.

GetHtmlInEditMode(Record)

Returns HTML to show the screen in edit mode, getting values from the Record Object.

public string GetHtmlInEditMode(Record recordObject)

Parameters

recordObject Record

Record object to render the HTML for.

Returns

string

HTML string.

GetHtmlInEditMode(DataSource)

Returns HTML to show the screen in edit mode.

public string GetHtmlInEditMode(DataSource source)

Parameters

source DataSource

DataSource source.

Returns

string

HTML string.

GetHtmlInViewMode(Entity)

Returns HTML to show screen in View mode, getting values from the Entity object.

public string GetHtmlInViewMode(Entity entityObject)

Parameters

entityObject Entity

Entity Object pointing at a record.

Returns

string

HTML string.

GetHtmlInViewMode(Record)

Returns HTML to show screen in View mode, getting values from entity object.

public string GetHtmlInViewMode(Record recordObject)

Parameters

recordObject Record

Entity Object pointing at a record.

Returns

string

HTML string.

GetHtmlInViewMode(DataSource)

Returns HTML to show screen in View mode.

public string GetHtmlInViewMode(DataSource source)

Parameters

source DataSource

DataSource source.

Returns

string

HTML string.

GetSqlForSearch()

Generates SQL for searching, based on values filled in on screen.

public string GetSqlForSearch()

Returns

string

SQL where clause.

HtmlBody()

Returns HTML to show a screen.

protected override string HtmlBody()

Returns

string

HTML String.

IndexOf(Entry)

Determines the index (position) of a specific Entry in the List.

public int IndexOf(Entry item)

Parameters

item Entry

Entry.

Returns

int

Index of Entry.

Insert(int, Entry)

Inserts an Entry to the List at the specified index (position).

public void Insert(int index, Entry item)

Parameters

index int

Index of Entry.

item Entry

Entry.

Remove(Entry)

Removes the first occurrence of a Entry from the List.

public bool Remove(Entry item)

Parameters

item Entry

Entry.

Returns

bool

True if successful.

RemoveAt(int)

Removes the Entry item at the specified index (position).

public void RemoveAt(int index)

Parameters

index int

Index

RemoveEntry(string)

Obsolete. Use Sage.CRM.Controls.EntryGroup.RemoveAt or Sage.CRM.Controls.EntryGroup.Remove instead.

[Obsolete("Use the method Remove or RemoveAt")]
public bool RemoveEntry(string fieldName)

Parameters

fieldName string

Returns

bool

Validate()

Validates the values on screen for each of the entrys in the screen.

public bool Validate()

Returns

bool

True if successfull.