Class Entry

Namespace

Sage.CRM.Controls

Assembly

SageCRMNet.dll

Represents a single field within an EntryGroup. EntryGroup.GetEntry, EntryGroup.AddEntry.

public class Entry

Inheritance

object

Entry

Derived

EntryCustom

EntrySelect

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

Entry(string, EntryTypes)

Initializes a new instance of Entry.

protected Entry(string fieldName, EntryTypes type)

Parameters

fieldName string

Field Name.

type EntryTypes

Used to override the Entry Type on unmanaged code.

Entry(string)

Initializes a new instance of Entry.

public Entry(string fieldName)

Parameters

fieldName string

Field Name.

Fields

iBaseEntry

Interface to represent the Entry on Unmanaged Code. This should be used only for inherited classes.

protected ICrmEntry iBaseEntry

Field Value

ICrmEntry

Properties

Caption

Enables you to change the caption on a Entry. You use this property only if the caption is required to be different on this particular screen only. If the caption is to be permanently changed, it should be done in Administration | Customization | <Entity> | Fields. The change is automatically reflected throughout the system.

public string Caption { get; set; }

Property Value

string

CaptionFamily

Enables the family of the Entry to be set. This controls what captions appear on each entry. If no CaptionFamily is set, the default "ColNames" will be used. The caption shown is the translation for the caption family (ColNames) plus the caption code (field name). You can change the caption by changing the CaptionFamily value and adding a translation for that CaptionFamily and the field name. For more information refer to the System Administrator Guide. Note that you can view a list of column names in Administration | Customization | Translations.

public string CaptionFamily { get; set; }

Property Value

string

CaptionPos

Enables you to re-position the captions on fields to reflect the value in the field. CaptionPositions

public CaptionPositions CaptionPos { get; set; }

Property Value

CaptionPositions

CreateScript

Enables you to enter server-side JavaScript that is executed when the entry is created. This is limited to this instance of entry.

public string CreateScript { get; set; }

Property Value

string

DefaultType

You use this property to set the default type of the entry. This is used in conjunction with the EntryType and DefaultValue properties. DefaultTypes

public int DefaultType { get; set; }

Property Value

int

DefaultValue

Specifies the default value given to the field when a new record is created. This property will only be used if the DefaultType property is set to Sage.DefaultTypes.DefaultValue (1)

public string DefaultValue { get; set; }

Property Value

string

EntryType

Gets the Entry Type.

public EntryTypes EntryType { get; }

Property Value

EntryTypes

Height

The number of rows that this Entry will span when the EntryGroup is displayed.

public int Height { get; set; }

Property Value

int

Hidden

A Hidden entry is not displayed when the EntryGroup it is in is executed. This is useful if you want to tag an entry to an EntryGroup but do not want customers to view it.

public bool Hidden { get; set; }

Property Value

bool

JumpAction

Action to be invoked when the entry is in view mode.

public int JumpAction { get; set; }

Property Value

int

JumpCustomPage

ASP file to jump when the entry is in view mode.

public string JumpCustomPage { get; set; }

Property Value

string

JumpEntity

Allows the field (in view mode) to be hyperlinked to an entity summary screen. Note that the entity must be relevant to the field, that is, the identity field of the entity selected must exist within the table or view on which the screen is based. In practice, this is only useful when the screen is based on a view that contains fields from multiple tables.

[Obsolete("Property not used on CRM anymore")]
public string JumpEntity { get; set; }

Property Value

string

JumpKey

The key that is used by this action e.g. (int)KeyList.CompanyId.

public int JumpKey { get; set; }

Property Value

int

MaxLength

Controls the maximum amount of characters that can be entered into an Entry when editing this entry. This does not change the size of the entry box, only the number of characters that can be entered. (Use the Size property to control the appearance of the field.)

public int MaxLength { get; set; }

Property Value

int

Name

Gets the name by which the field is referenced.

public string Name { get; }

Property Value

string

NewLine

Set if this Entry is to start a new line within the EntryGroup.

public bool NewLine { get; set; }

Property Value

bool

OnChangeScript

Specifies the JavaScript to be executed when the value in the field is edited. This property is only applicable when the ReadOnly property is set to false.

public virtual string OnChangeScript { get; set; }

Property Value

string

ReadOnly

Specifies that a field is read-only. If this is set to true, the value in the field is not editable.

public bool ReadOnly { get; set; }

Property Value

bool

Required

Specifies that a value must be entered in this field. If no value is entered a validation error is displayed.

public bool Required { get; set; }

Property Value

bool

Size

Specifies the size of the field displayed onscreen. This is the length of the field in pixels.

public int Size { get; set; }

Property Value

int

ValidateScript

Enables you to set a validation script on a Entry object. You use this to enter server-side JavaScript that is executed when the entry is executed in save mode.

public string ValidateScript { get; set; }

Property Value

string

Width

The number of columns that this Entry will span when the EntryGroup is displayed.

public int Width { get; set; }

Property Value

int

Methods

~Entry()

Destructor for the Entry class.

protected ~Entry()