getItemValueInteger (NotesDocument - JavaScript)

Returns the integer value of an item with a single numeric value.

Defined in

NotesDocument

Syntax

getItemValueInteger(name:string) : int
Parameter Description
name The name of the item.
Return value Description
int The value of the item, rounded to the nearest integer.

Usage

If multiple items have the same name, this method returns the value of the first item.

If the item has no value or the value is text, date, or empty, this method returns 0.

If no item with the specified name exists, this method returns 0. It does not throw an exception. Use hasItem to verify the existence of an item.

If the item has multiple values, this method returns the first value.

A decimal number is rounded down if the fraction is less than 0.5 and up if the fraction is 0.5 or greater.

Examples

This button gets the value of a numeric item in the current document as an integer.
var itemname:string = "quantity";
var doc:NotesDocument = currentDocument.getDocument();
if (doc.hasItem(itemname)) {
	var itemvalue:int = doc.getItemValueInteger(itemname);
	requestScope.status = itemvalue.toFixed();
}