Working With All MS CRM DataTypes In Javascript


Boolean

Specifies a field  that displays one check box or two radio buttons. The Boolean field type is one display option for bit type attributes. The other option is list. The list option uses the Picklist field type.

Note   Changing the formatting options of a bit attribute is done on the form, not in the attribute definition like other attributes. Changing the formatting option from a check box or two radio buttons to a list will change the way that you access the values in the form, potentially breaking your code.

The following properties are available:

Boolean properties Type Description
{Field}.DataValue Boolean or Null Get/set property.

The original value is left unchanged if the new value cannot be parsed.

{Field}.DefaultValue Boolean Get property.

Returns the default value for the field.


Example

The following code example shows how to set a field of type Boolean.

crmForm.all.SOME_BOOLEAN_FIELD_ID.DataValue = true;
 
crmForm.all.SOME_BOOLEAN_FIELD_ID.DataValue = false; 

 

Customer

A Customer field represents a type of Lookup where either an account or contact is a valid type of record.

The following properties are available:

Customer or Regarding properties Type Description
{Field}.DataValue   Specifies an array of lookup objects. For the Customer field this array always has a length of one. DataValue is Null when no value is selected. Set DataValue to Null to make the lookup field blank.

Example

The following code example shows how to use a Customer field type.

var customer = new Array();
customer = null;

// This gets the lookup for the attribute customerid on the Opportunity form.
customer = crmForm.all.customerid.DataValue;

// If there is data in the field, show it in a series of alerts.
if (customer[0] != null)
{
   // The name of the customer.
   alert(customer[0].name);

   // The GUID of the customer.
   alert(customer [0].id);

   // The entity type name of the customer.
   alert(customer[0].typename);
}

DateTime

A DateTime field can be formatted to show both the date and time, or the date only. The following properties are available:

DateTime properties Type Description
{Field}.DataValue Date or Null Get/set property.

The original value is left unchanged if the new value cannot be parsed.

{Field}.TimeVisible Boolean Get property.

This property specifies if the time is to be shown.


Example

The following code example shows how to use a field of type DateTime.

var oDate;
var oToday;

oDate =  crmForm.all.scheduledend.DataValue;
if (oDate == null) {
    oDate = new Date();
}

oToday = new Date();
oDate = oToday;
oDate = oDate.setHours(17,0,0);

if (oDate.TimeVisible)
{
   alert("The time is visible.");
}
else
{
   alert("Only the date is visible; the time is hidden.");
}

crmForm.all.scheduledend.DataValue = oDate;

Duration

Duration fields are presented as a picklist giving the user a selection of time options from 1 minute to 3 days. But the actual value of a duration field is an integer. If a user types an integer into the field or your code sets the value of the integer representing minutes, the field will convert that value into a more user-friendly unit of measurement. For example, 420 will be displayed as 7 hours.

The following properties are available:

Duration properties Type Description
{Field}.DataValue integer or Null Get/set property.

The duration can be set to Null. The original value is left unchanged if the new value cannot be parsed.


Example

The following code example shows how to use a field of type Duration.

var iMinutes = 60; crmForm.all.SOME_DURATION_FIELD_ID.DataValue = iMinutes;
 
 
 

E-mail Body

This field type appears in the E-mail activity form. The following properties are available:

E-mail body field methods Type Description
{Field}.DataValue String Used to get the HTML stream for the e-mail body.

Remarks

The HTML stream that defines the DataValue for an e-mail body field is read-only. The DataValue is not available to be read in the OnLoad event.

Example

The following code example shows how to use a field of type E-mail body.

var oField = crmForm.all.SOME_EMAILBODY_FIELD_ID;

alert(The field's HTML is: " + oField.DataValue);

 

Float

The following properties are available:

Float properties Type Description
{Field}.DataValue float or Null Get/set property.

The original value is left unchanged if the new value cannot be parsed.

{Field}.Min Integer Get property.

Returns the minimum allowed value.

{Field}.Max Integer Get property.

Returns the maximum allowed value.

{Field}.Precision Integer Get property.

Returns the number of digits allowed. This is a value between 0 and 5.


Example

The following code example shows how to use a field of type Float.

var oField = crmForm.all.SOME_FLOAT_FIELD_ID;

var iValue = 1976.1102;

// Set the precision of the value.
var oNumber = new Number(iValue);
iValue = oNumber.toPrecision(oField.Precision);

if (iValue < oField.Min)
{
   iValue = oField.Min;
}
else if (iResponse > oField.Max)
{
   iValue = oField.Max;
}

oField.DataValue = iValue;

 

Integer

The following properties are available:

Integer properties Type Description
{Field}.DataValue Integer or Null Get/set property.

The original value is left unchanged if the new value cannot be parsed.

{Field}.Min Integer Get property.

The minimum allowed value.

{Field}.Max Integer Get property.

The maximum allowed value.


Example

The following code example shows how to use a field of type Integer.

var oField = crmForm.all.SOME_INTEGER_FIELD_ID;

var iValue = 1000;

if (iValue < oField.Min)
{
   iValue = oField.Min;
}
else if (iValue > oField.Max)
{
   iValue = oField.Max;
}

oField.DataValue = iValue;
 
 

Lookup

A Lookup field type represents the relationship attribute on the related entity. The valid type for the lookup is established in the relationship. Although Lookup is frequently used as a generic term, there are different types of lookups and technically Lookup is the most restrictive kind of field type. Unlike Customer or Regarding, only one entity type is valid in a lookup. Unlike PartyList, only one reference is stored in the field. A lookup field is defined by using the following attributes:

Attribute Type Description
id String The GUID of the item. Required for set.
type Integer Deprecated. The object type code.
typename String The entity name of the item. Required for set.
name String The name of the item to be displayed. Required for set.
data   Any other data. Optional for set.

The following properties are available:

Lookup properties Type Description
{Field}.DataValue An array of lookup objects Get/set property.

For lookups this must be an array with the length of one. DataValue is Null when no value is selected. Set DataValue to Null to make the lookup field blank.


Example

The following code example shows how to read values from a field of type Lookup.

var lookupItem = new Array;

// This gets the lookup for the attribute primarycontactid on the Account form.
lookupItem = crmForm.all.primarycontactid.DataValue;

// If there is data in the field, show it in a series of alerts.
if (lookupItem[0] != null)
{
   // The text value of the lookup.
   alert(lookupItem[0].name);

   // The GUID of the lookup.
   alert(lookupItem[0].id);

   // The entity type name.
   alert(lookupItem[0].typename);

}

Example

The following code example shows how to set values in a field of type Lookup. This example shows how to set the parent account lookup field on the account form.

//Create an array to set as the DataValue for the lookup control.
var lookupData = new Array();
//Create an Object add to the array.
   var lookupItem= new Object();
//Set the id, typename, and name properties to the object.
   lookupItem.id = '{1AAC1363-01A1-DB11-8432-0003FF9CE217}';
   lookupItem.typename = 'account';
   lookupItem.name = 'A Bike Store';
// Add the object to the array.
   lookupData[0] = lookupItem;
// Set the value of the lookup field to the value of the array.
   crmForm.all.parentaccountid.DataValue = lookupData;


Memo

Memo represents a multiline text box using the ntext attribute type. The following properties are available:

Memo properties Type Description
{Field}.DataValue A reference to a string object Get/set property.
{Field}.MaxLength Integer Get property.

The maximum length of the string.


Example

This field is used in the same manner as a String Type.

 
 

Owner

A Owner field represents a Lookup where the linked record can be any record type that can be presented in the field.

The following properties are available:

Regarding properties Type Description
{Field}.DataValue   For the regarding field type this is an array with a length of one. DataValue is Null when no value is selected. Set DataValue to Null to make the lookup field blank.

Example

The following code example shows how to use a field of type Owner.

var lookupItem = new Array;
lookupItem = null;

// This gets the lookup for the attribute regardingobjectid on the Task form.
lookupItem = crmForm.all.ownerid.DataValue;

// If there is data in the field, show it in a series of alerts.
if (lookupItem[0] != null)
{
   // The text value of the lookup.
   alert(lookupItem[0].name);

   // The GUID of the lookup.
   alert(lookupItem[0].id);

   // The entity type name.
   alert(lookupItem[0].typename);
}

PartyList

A type of Lookup that allows for multiple references to records of multiple types of entities to be set in a single field. A PartyList is typically found on e-mail activities to represent the To, Bcc and cc fields. A PartyList is defined by using the following attributes:

Attribute Type Description
id String The GUID of the item. Required for set.
type Integer Deprecated. The object type code.
typename String The entity name of the item. Required for set.
name String The name of the item to be displayed. Required for set.
data   Any other data. Optional for set.

The following properties are available:

PartyList properties Type Description
{Field}.DataValue An array of lookup objects Get/set property.

For PartyLists this must be an array with the length of at least one. DataValue is Null when no value is selected. Set DataValue to Null to make the lookup field blank.

 
 

Picklist

A picklist contains several options. Each option has the following attributes:

Attribute Description
DataValue The index value of the selected option.
Text The text of the picklist option.

The following properties and methods are available:

Picklist properties and methods Type Description
{Field}.DataValue string Get/set property

Get returns a string representation of the value of the selected option. You can use the method parseInt() to safely convert this to an integer value.

Set changes the selection to the value specified.

{Field}.SelectedText string Get property

Returns the string value of the selected option.

{Field}.GetSelectedOption option Picklist option

Returns a Picklist option.

{Field}.Options array of picklist options Get/set property

Get returns an array of Picklist option objects.

Set defines a new set of options, specified by an array of Picklist option objects.

{Field}.AddOption(Text, DataValue) option Used to add an option to the end of the current control's collection.

Text - a string value to be displayed in the option.

DataValue – an integer value that represents the index of the option.

Text and DataValue cannot be Null.

Data is used for storing arbitrary data on the picklist object.

To define valid options, you must modify the Attribute definition by using the Customization tools or the metadata APIs. You should not create new picklist options programmatically in form event code. Manipulating the Options array is the most common solution to ensure valid picklist data.

{Field}.DeleteOption(value) integer Used to delete the option specified by value from the control's option collection. Does nothing if the option does not exist.
{Field}.DefaultValue integer Get/set property.

Get returns the default value for the picklist.

Set specifies the default value for the picklist.


Remarks

All the valid picklist options are defined in the Microsoft Dynamics CRM Metadata. When a record is saved with an invalid picklist option selected the field will be set to the default value and the invalid data will be lost.

There are two supported methods for retrieving the current selection for a picklist field as shown here.

The following returns the text value of the selected picklist item.

crmForm.all.(picklistitem).SelectedText

The following returns the index of the selected picklist item.

crmForm.all.(picklistitem).DataValue

Example

The following code example shows how to use a field of type Picklist. Note that when you add an option to a Picklist, the option must already exist in the set of possible options.

var oField = crmForm.all.SOME_PICKLIST_FIELD_ID;

// Capture the fourth option
var oOption = oField.Options[4];

// Show how many options are available
alert("Original length :"+ oField.Options.length);

// Set the field to the first option by value
oField.DataValue = 1;

// Show the text for the first option
alert(oField.SelectedText);

// Remove the fourth option
oField.DeleteOption(4);

// show the new length
alert("New length :"+ oField.Options.length);

// Restore the fourth option
oField.AddOption(oOption.Text, oOption.DataValue);

// Show the restored length
alert("Restored length :"+ oField.Options.length); 
 

Regarding

A Regarding field represents a Lookup where the linked record can be any record type that can be presented in the field.

The following properties are available:

Regarding properties Type Description
{Field}.DataValue   For the regarding field type this is an array with a length of one. DataValue is Null when no value is selected. Set DataValue to Null to make the lookup field blank.

Example

The following code example shows how to use a field of type Regarding.

var lookupItem = new Array;
lookupItem = null;

// This gets the lookup for the attribute regardingobjectid on the Task form.
lookupItem = crmForm.all.regardingobjectid.DataValue;

// If there is data in the field, show it in a series of alerts.
if (lookupItem[0] != null)
{
   // The text value of the lookup.
   alert(lookupItem[0].name);

   // The GUID of the lookup.
   alert(lookupItem[0].id);

   // The entity type name.
   alert(lookupItem[0].typename);
} 

String

The following properties are available:

String properties Type Description
{Field}.DataValue A reference to a string object Get/set property.
{Field}.MaxLength Integer Get property.

The maximum length of the string.


Example

The following code example shows how to use a field of type String.

var oField = crmForm.all.SOME_STRING_FIELD_ID;

var sValue = "String that might be too long.";

if (sValue.length > oField.MaxLength)
{
   sValue = sValue.substr(0, oField.MaxLength); 
}

oField.DataValue = sValue;
Comments