Module: information

Information

Source: information.js, line 9

Methods

(inner) browserInfo()

Determines the capabilities of a Web client, that is you can determine the properties of the browser for the current request.

Source: information.js, line 266
See: For further information, see www.hcltechsw.com
To Do: this needs to be implemented

Throws:

method not implemented
Type Error

(inner) cell()

Returns information about the formatting, location, or contents of a value. Category: Information

Source: information.js, line 205

Throws:

No plans to implement

(inner) clientType()

Returns a text string to differentiate Notes® clients and World Wide Web browsers.

Source: information.js, line 275
See: For further information, see www.hcltechsw.com
To Do: this needs to be implemented

Throws:

method not implemented
Type Error

(inner) configFile()

Returns the file path for the initialization file for Notes® (notes.ini).

Source: information.js, line 360

Throws:

no plans to implement
Type Error

(inner) fontList()

Provides a list of available fonts on the Notes® client where this @function is executed.

Source: information.js, line 369

Throws:

no plans to implement
Type Error

(inner) getAddressBooks()

Returns a list of the address books associated with a client (if the current database is local) or server.

Source: information.js, line 378

Throws:

no plans to implement
Type Error

(inner) info()

Returns information about the current operating environment. Category: Information

Source: information.js, line 214

Throws:

No plans to implement

(inner) isAppInstalled()

Indicates whether the specified type of application is installed.

Source: information.js, line 386

Throws:

no plans to implement
Type Error

(inner) isBlank(value) → {boolean}

Returns TRUE if the value is blank.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 42
See: For further information, see docs.oasis-open.org

Returns:

if the value is null.

Type:: boolean

Examples

rosettajs.Information.isBlank(null) // returns true

rosettajs.Information.isBlank("") // returns false

(inner) isEmbeddedInsideWCT()

Indicates whether any part of the current Notes® session is embedded inside of Workplace client.

Source: information.js, line 395

Throws:

no plans to implement
Type Error

(inner) isErr(value) → {boolean}

Returns TRUE if the value is any error value except #N/A.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 54
See: For further information, see docs.oasis-open.org

Returns:

True if the value is an error other than #N/A

Type:: boolean

Examples

rosettajs.Information.isErr(1/0); // Returns true

rosettajs.Information.isErr(1); // Returns false

(inner) isError(value) → {boolean}

Returns TRUE if the value is any error value.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 66
See: For further information, see www.hcltechsw.com and docs.oasis-open.org

Returns:

Type:: boolean

Examples

rosettajs.Information.isError(1/0); // Returns true

rosettajs.Information.isError(1); // Returns false

(inner) isEven(number) → {number}

Returns TRUE if the number is even.

Parameters:

Name	Type	Description
`number`	number	The value to test. If number is not an integer, it is truncated.

Source: information.js, line 78
See: For further information, see docs.oasis-open.org

Returns:

true if a number is even and false if it is not

Type:: number

Examples

rosettajs.Information.isEven(-3); // returns false

rosettajs.Information.isEven(2); // returns true

(inner) isFormula(reference)

Returns TRUE if there is a reference to a value that contains a formula. Category: Information

Parameters:

Name	Type	Description
`reference`	*	Reference is a reference to the value you want to test. Reference can be a value reference, a formula, or a name that refers to a value.

Source: information.js, line 224

Throws:

No plans to implement

(inner) isInCompositeApp()

Indicates whether the component is running within a composite application.

Source: information.js, line 403

Throws:

no plans to implement
Type Error

(inner) isLogical(value) → {boolean}

Returns TRUE if the value is a logical value.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 90
See: For further information, see docs.oasis-open.org

Returns:

true if the value is true, and false if the value is false or 0.

Type:: boolean

Examples

rosettajs.Information.isLogical(true); // returns true

rosettajs.Information.isLogical(0); // returns false

(inner) isModalHelp()

Indicates whether the current document is a modal Help document.

Source: information.js, line 411

Throws:

no plans to implement
Type Error

(inner) isNA(value) → {boolean}

Returns TRUE if the value is the #N/A error value.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 102
See: For further information, see docs.oasis-open.org

Returns:

returns true if the value being evaluated is equal to error.na, false if not;

Type:: boolean

Examples

rosettajs.Information.isNA(error.na); // returns true.

rosettajs.Information.isNA(1); // returns false.

(inner) isNonText(value) → {boolean}

Returns TRUE if the value is not text.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 114
See: For further information, see docs.oasis-open.org

Returns:

true if value is not a string, false if it is.

Type:: boolean

Examples

rosettajs.Information.isNonText(1); // returns true.

rosettajs.Information.isNonText('string'); // returns false.

(inner) isNumber(value) → {boolean}

Returns TRUE if the value is a number.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these. When using the Notes formula implementation the value can be a list.

Source: information.js, line 133
See: For further information, see www.hcltechsw.com and docs.oasis-open.org

Returns:

true if value is a number, false if not. or the Open Formula implementation see www.oasis-open.org

Type:: boolean

Examples

rosettajs.Information.isNumber(1); // Returns true

rosettajs.Information.isNumber("1"); // Returns false

rosettajs.API.setDefaultAPIAsNotes();
rosettajs.Text.isNumber([-345, 2.78. 997, .7]); // Returns true

(inner) isOdd(value) → {boolean}

Returns TRUE if the number is odd.

Parameters:

Name	Type	Description
`value`	number	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 146

Returns:

true if the value is an odd number, false if not.

Type:: boolean

Examples

rosettajs.Information.isOdd(1); // returns true.

rosettajs.Information.isOdd('string'); // returns false.

rosettajs.Information.isOdd(2.5); // returns false.

(inner) isRef(value)

Returns TRUE if the value is a reference. Category: Information

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.

Source: information.js, line 234

Throws:

No plans to implement

(inner) isText(value) → {boolean}

Returns TRUE if the value is text.

Parameters:

Name	Type	Description
`value`	*	The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these. When using the Notes formula implementation the value can be a list.

Source: information.js, line 165
See: For further information, see www.hcltechsw.com and docs.oasis-open.org

Returns:

returns true if value has type string, false if not. or the Open Formula implementation see www.oasis-open.org

Type:: boolean

Examples

rosettajs.Information.isText(1); // Returns false

rosettajs.Information.isText("1"); // Returns true

rosettajs.API.setDefaultAPIAsNotes();
rosettajs.Text.isText('xyz', 'abc', 7.7); // returns false

(inner) isUsingJavaElement()

Indicates whether a view or outline uses the Java™ user interface.

Source: information.js, line 419

Throws:

no plans to implement
Type Error

(inner) isVirtualizedDirectory()

Indicates whether virtualized directories are enabled for the current server.

Source: information.js, line 427

Throws:

no plans to implement
Type Error

(inner) languagePreference(keyword) → {TextOrTextList}

Returns user's specified preferred language setting.

Parameters:

Name	Type	Description
`keyword`	Text	Specify a category for which you would like to get the preferred language. The following categories are available: [REGION] [CONTENT] [ALTERNATENAME]

Source: information.js, line 302
See: For further information, see www.hcltechsw.com

Returns:

Text or Text list that represents the language and country code for user's preferred setting. [REGION] language is set as the default. If @LanguagePreference cannot find the language setting for the specified category, it returns the language for [REGION].

Type:: TextOrTextList

Examples

@LanguagePreference([REGION]); // returns 'fr-CA'

@LanguagePreference([ALTERNATENAME]); // returns 'fr'

(inner) ldapServer()

Returns the URL and port number of the LDAP listener in the current domain. Notes® looks for this information in several places, following this search sequence:

Searches on the current server.
Searches for the notes.ini variable labeled LDAPSERVER=.
Queries the administration server, which runs the LDAP service automatically, by default.

Source: information.js, line 316
See: For further information, see www.hcltechsw.com
To Do: this needs to be implemented

Throws:

method not implemented
Type Error

(inner) n(value) → {number|Error}

Returns a value converted to a number.

Parameters:

Name	Type	Description
`value`	*	The value you want converted. N converts values listed in the following table.

Source: information.js, line 176
See: For further information, see docs.oasis-open.org

Returns:

value if it is a number, value.getTime if it is an instance of Date, 1 if true, 0 if false, otherwise it returns an error.

Type:: number | Error

Example

rosettajs.Information.n(rosettajs.Logical.true()); // Returns 1

(inner) na() → {error}

Returns the error value #N/A.

Source: information.js, line 186
See: For further information, see docs.oasis-open.org

Returns:

error.na

Type:: error

Example

rosettajs.Information.isNA(rosettajs.Information.na()); // Returns true

(inner) notesError()

Allows you to generate an error condition within an expression. This is useful if you want to evaluate the current values in several fields and need to know if an error has occurred in the entry of any of them.

Source: information.js, line 456
See: For further information, see www.hcltechsw.com

Throws:

Notes Error
Type Error

(inner) regQueryValue()

Copies the administration execution control list from a specified Address Book and name to your personal workstation ECL.

Source: information.js, line 325

Throws:

no plans to implement
Type Error

(inner) serverAccess()

Checks if a specified user has a specified administrative access level to a server.

Source: information.js, line 436

Throws:

no plans to implement
Type Error

(inner) sheet(value)

Returns the sheet number of the referenced sheet. Category: Information

Parameters:

Name	Type	Description
`value`	*	Optional. Value is the name of a sheet or a reference for which you want the sheet number. If value is omitted, SHEET returns the number of the sheet that contains the function.

Source: information.js, line 244

Throws:

No plans to implement

(inner) sheets(reference)

Returns the number of sheets in a reference. Category: Information

Parameters:

Name	Type	Description
`reference`	*	Optional. Reference is a reference for which you want to know the number of sheets it contains. If Reference is omitted, SHEETS returns the number of sheets in the workbook that contains the function.

Source: information.js, line 254

Throws:

No plans to implement

(inner) soundex()

Returns the Soundex (the Notes® phonetic speller) code for the specified string.

Source: information.js, line 334
See: For further information, see www.hcltechsw.com
To Do: this needs to be implemented

Throws:

method not implemented
Type Error

(inner) templateVersion()

Returns the version number of the master template upon which the database design is based.

Source: information.js, line 446

Throws:

no plans to implement
Type Error

(inner) thisName(eventobject) → {string}

Returns the name of the current field. Only works within the context of a text/field widget.

Parameters:

Name	Type	Description
`eventobject`	*	Optional. If the eventobject is not specified, the eventobject set by setActionEventObject is used.

Source: information.js, line 343
See: For further information, see www.hcltechsw.com

Returns:

The name of the current field.

Type:: string

(inner) thisValue(eventobject) → {string}

Returns the value of the current field. Only works within the context of a text/field widget.

Parameters:

Name	Type	Description
`eventobject`	*	Optional. If the eventobject is not specified, the eventobject set by setActionEventObject is used.

Source: information.js, line 352
See: For further information, see www.hcltechsw.com

Returns:

The value of the current field.

Type:: string

(inner) type(value) → {number|undefined}

Returns a number indicating the data type of a value.

Parameters:

Name	Type	Description
`value`	*	Can be any Microsoft Excel value, such as a number, text, logical value, and so on.

Source: information.js, line 196

Returns:

1 if value is a number, 2 if value is text, 4 if value isLogical, 16 if value is an array, 64 if value is an error/

Type:: number | undefined