Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
Formula Language
This section documents the formula language.
Formula Language @Functions A-Z
Formula Language @Functions A-Z
@DocLength (Formula Language)
Returns the approximate size of a document in bytes.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in HCL Domino Designer 12?
  The following features are new for developers in HCL Domino® Designer 12.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
  - Formula Language Rules
    Formula language provides syntax and @functions for evaluating constants and variables, and for performing simple logic. Variables can be fields in Notes® documents or temporary variables (also called temporary fields) used only for the immediate formula.
  - Formula Language Coding Guidelines
  - Formula Language @Functions A-Z
    Formula Language @Functions A-Z
    - List of @Functions
      The following is a list of all the @functions supported in Domino® Designer:
    - Where does this @function work? (Part 1 A -- D)
      The following table lists each @function (A -- D) and indicates whether or not the @function works in the following contexts:
    - Where does this @function work? (Part 1 E -- K)
      The following table lists each @function (E -- K) and indicates whether or not the @function works in the following contexts:
    - Where does this @function work? (Part 1 L -- R)
      The following table lists each @function (L -- R) and indicates whether or not the @function works in the following contexts:
    - Where does this @function work? (Part 1 S -- Z)
      The following table lists each @function (S -- Z) and indicates whether or not the @function works in the following contexts:
    - Where does this @function work? (Part 2 A -- D)
      The following table lists each @function (A -- D) and indicates whether or not the @function works in the following contexts:
    - Where does this @function work? (Part 2 E -- K)
      The following table lists each @function (E -- K) and indicates whether or not the @function works in the following contexts:
    - Where does this @function work? (Part 2 L -- R)
      The following table lists each @function (L -- R)and indicates whether or not the @function works in the following contexts:
    - Where does this @function work? (Part 2 S -- Z)
      The following table lists each @function (S -- Z)and indicates whether or not the @function works in the following contexts:
    - @Functions with ECL security
      The following table lists the @functions affected by an execute control list (ECL). Those @functions do not execute on the workstation unless the marked ECL privileges are granted to the formula's signer.
    - @Abs (Formula Language)
      Returns the absolute (unsigned) value of a number.
    - @Abstract (Formula Language)
      Abbreviates the contents of one or more fields by:
    - @AbstractSimple (Formula Language)
      Creates a short abstract of a text or rich text field. Simpler and more efficient than using @Abstract.
    - @Accessed (Formula Language)
      Indicates the time and date when the document was last accessed by a Notes® client, whether for reading or editing.
    - @ACos (Formula Language)
      Calculates the arc (inverse) cosine, using the cosine of an angle.
    - @AddToFolder (Formula Language)
      Adds current document to one folder while removing it from another. NULL string can be substituted for either argument to skip the action.
    - @AddedToThisFile (Formula Language)
      Returns a time-date value indicating when the document was created in the current file
    - @Adjust (Formula Language)
      Adjusts the specified time-date value by the number of years, months, days, hours, minutes, and/or seconds you specify. The amount of adjustment may be positive or negative.
    - @AdminECLIsLocked (Formula Language)
    - @All (Formula Language)
      Returns the value True.
    - @AllChildren (Formula Language)
      Includes all response documents at all levels for parent documents that match selection criteria.
    - @AllDescendants (Formula Language)
      Includes all response and response-to-response documents for parents that match selection criteria.
    - @Ascii (Formula Language)
      Converts an LMBCS (Lotus® Multi-Byte Character Set) string to an ASCII string.
    - @ASin (Formula Language)
      Calculates the arc (inverse) sine using the sine of an angle.
    - @ATan (Formula Language)
      Calculates the arc (inverse) tangent using the tangent of an angle.
    - @ATan2 (Formula Language)
      Calculates the arc tangent using the tangent y/x of an angle.
    - @AttachmentLengths (Formula Language)
      Returns a number or a number list containing the length of each attachment to the current document. The number(s) returned are only approximations; the actual size(s) of the attachment(s) may be slightly different.
    - @AttachmentModifiedTimes (Formula Language)
      Returns a datetime that displays the date on which the file attachment associated with the current document was last modified. If the document contains more than one file attachment, returns the modification dates in a datetime list.
    - @AttachmentNames (Formula Language)
      Returns the operating system file names of any files attached to a document. If there are multiple files attached, the names are returned as a multiple-value text list.
    - @Attachments (Formula Language)
      Returns the number of files attached to a document.
    - @Author (Formula Language)
      Returns a text list containing the names of the author(s) of the current document.
    - @Begins (Formula Language)
      Determines whether a particular substring is stored at the beginning of another string.
    - @BrowserInfo (Formula Language)
      Determines the capabilities of a Web client, that is you can determine the properties of the browser for the current request.
    - @BusinessDays (Formula Language)
      Returns the number of business days in one or more date ranges.
    - @Certificate (Formula Language)
      Extracts information from the Certified Public Key in the Domino® Directory.
    - @Char (Formula Language)
      Converts an HCL Code Page 850 code number into the corresponding single character string.
    - @CheckAlarms (Formula Language)
      Triggers the alarm daemon to check for new alarms in the mail file.
    - @CheckFormulaSyntax (Formula Language)
      Checks a block of commented out formula language code for errors.
    - @ClientType (Formula Language)
      Returns a text string to differentiate Notes® clients and World Wide Web browsers.
    - @Command (Formula Language)
      Executes a Notes/Domino command. Most of the standard menu commands can be executed using @Command. In addition, a number of specialized commands are available. In a formula, any command invoked using @Command runs in the order you specify in the formula. This means that any changes made by the command, such as inserting text into a field, affect the rest of the formula (see exceptions).
    - @Compare (Formula Language)
      Compares the alphabetic order of the elements in two lists pair-wise.
    - @ConfigFile (Formula Language)
      Returns the file path for the initialization file for Notes® (notes.ini).
    - @Contains (Formula Language)
      Determines whether a substring is stored within a string.
    - @Cos (Formula Language)
      Given an angle in radians, returns the cosine of the angle. In a right triangle, the cosine of an acute angle is the ratio of the length of its adjacent side to the length of the hypotenuse.
    - @Count (Formula Language)
      Calculates the number of text, number, or time-date values in a list. This function always returns a number to indicate the number of entries in the list.
    - @Created (Formula Language)
      Returns the time-date when the document was created.
    - @Date (Formula Language)
      Translates numbers for the various components of time and date, then returns the time-date value.
    - @Day (Formula Language)
      Extracts the day of the month from the specified date.
    - @DB2Schema (Formula Language)
      Given the name of a database as a text string, returns a text string containing the DB2® schema of that database if it is a db2nsf database or the empty string if it is not a db2nsf database.
    - @DbColumn (Domino® data source) (Formula Language)
      Returns a column of values from a view or folder in a Domino® database.
    - @DbColumn (ODBC data source) (Formula Language)
    - @DbCommand (Domino® data source) (Formula Language)
      Accesses view and folder information from a Domino® database in Web applications.
    - @DbCommand (ODBC data source) (Formula Language)
      Given data source information from the ODBC.INI file (or equivalent), uses this information to activate the appropriate ODBC driver. The driver then locates the specified DBMS, passes the specified command to it for processing, and returns the data retrieved by that command.
    - @DbExists (Formula Language)
      Given a server and file name, or replica ID, indicates whether the specified database exists.
    - @DbLookup (Domino® data source) (Formula Language)
      Given a key value, looks in the specified view (or folder) and finds all documents containing the key value in the first sorted column within the view. For each selected document, @DbLookup returns either the contents of a specified column in the view, or the contents of a specified field.
    - @DbLookup (ODBC data source) (Formula Language)
      Uses data source information from the ODBC.INI file to activate the appropriate ODBC driver. The driver then locates the specified DBMS, table, and column, and returns only the values in that column belonging to records whose value in the key column matches the specified key. You can optionally specify whether the returned list of values is sorted, whether duplicate values are deleted, and how null values are handled.
    - @DbManager (Formula Language)
      Returns a list of users, groups, and servers who currently have Manager access to the database. In a window title formula, only the name of the first manager listed in the ACL is displayed.
    - @DbName (Formula Language)
      Returns the name of the current Domino® server and database.
    - @DbTitle (Formula Language)
      Returns the title of the current database.
    - @DDEExecute (Formula Language)
      Passes the specified command string to the DDE application, which is identified by the conversation ID. @DDEExecute is always used in conjunction with @DDEInitiate and @DDETerminate.
    - @DDEInitiate (Formula Language)
      Initiates a conversation with a DDE server, and returns the conversation ID.
    - @DDEPoke (Formula Language)
      Deposits unsolicited data into the specified location within the DDE server application. If the data was successfully inserted into the target location, @DDEPoke returns an ACK (acknowledgement) with the value @True(1); if the attempt was not successful, the call returns a NACK (negative acknowledgment) with the value @False(0). If the conversation ID is invalid, an error is returned (see @IsError).
    - @DDETerminate (Formula Language)
      Terminates the conversation with a DDE application.
    - DEFAULT (Formula Language)
      A reserved word that does one of the following:
    - @DeleteDocument (Formula Language)
      Deletes the current document.
    - @DeleteField (Formula Language)
      Deletes the value of an editable field.
    - @DialogBox (Formula Language)
      Brings up a dialog box that displays the current document (either open or selected in a view). The dialog box shares fields with the underlying document. The user interacts with the dialog box as usual, clicking OK or Cancel when finished.
    - @Do (Formula Language)
      Evaluates expressions from left to right, and returns the value of the last expression in the list.
    - @DocChildren (Formula Language)
      In a column or window title formula, returns the number of child documents or categories belonging to the current document or category. Only immediate responses count as children. For example, the responses to a main document are its children, but the responses to a response document are not.
    - @DocDescendants (Formula Language)
      In a column or window title formula, returns the number of descendant documents or subcategories belonging to the current document or category. Where @DocChildren only counts direct descendants, @DocDescendants counts all descendants, regardless of level.
    - @DocFields (Formula Language)
      Returns a list of all the fields in a document.
    - @DocLength (Formula Language)
      Returns the approximate size of a document in bytes.
    - @DocLevel (Formula Language)
      Returns a text string that represents the level of the document or category.
    - @DocLock (Formula Language)
      Locks, unlocks, returns the locked status of the current document, or indicates if a database has document locking enabled.
    - @DocMark (Formula Language)
      In an agent that runs a formula, indicates whether or not you want to save the changes to a document.
    - @DocNumber (Formula Language)
      In a column or window title formula, returns a string representing the entry number of the current document or category. For example, 2.3 indicates that the document is the third entry following the second entry.
    - @DocOmittedLength (Formula Language)
      Returns the approximate number of bytes a truncated document lost during replication. The bytes are the total number of bytes per attachment, OLE object, large rich text field, or non-summary items that were too large, according to the replication settings for the database, to be replicated.
    - @DocParentNumber (Formula Language)
      In a column or window title formula, returns a string that represents the entry number of the parent view entry. Both the current view entry and the parent can be either documents or categories.
    - @DocSiblings (Formula Language)
      In a column or window title formula, returns a string that represents the total number of entries at the same level as a view entry (document or category). The returned total includes the document itself. For example, if the document is entry 8.2, and entries 8.1, 8.3, and 8.4 also exist, then there are four document siblings.
    - @DocumentUniqueID (Formula Language)
      The universal ID, which uniquely identifies a document across all replicas of a database. In text format, the universal ID is a 32-character combination of hexadecimal digits (0-9, A-F).
    - @Domain (Formula Language)
      Returns the name of the current user's Domino® mail domain listed in the current location document of the Personal Address Book.
    - @DoWhile (Formula Language)
      Executes one or more statements iteratively while a condition is true. Checks the condition after executing the statements.
    - @EditECL (Formula Language)
      Displays the administration "Workstation Security: Execution Control List" dialog box for a specified address book and name, which lets you change that administration ECL. Administrators can name Administration ECLs. The name is not usually a user name, but whatever name the administrator chooses; for example, Manager, Developer, or LimitedAccess.
    - @EditUserECL (Formula Language)
      Displays the "Workstation Security: Execution Control List" dialog box, which allows you to change your personal ECL for the current workstation.
    - @Elements (Formula Language)
      Calculates the number of text, number, or time-date values in a list. This function always returns a number to indicate the number of entries in the list.
    - @EnableAlarms (Formula Language)
      Starts or stops the alarm daemon.
    - @Ends (Formula Language)
      Determines if a substring is at the end of a string.
    - ENVIRONMENT (Formula Language)
      A reserved word that sets or gets an environment variable stored in the user's notes.ini file (Windows™and UNIX™) or Notes® Preferences file (Macintosh).
    - @Environment (Formula Language)
      Sets or returns an environment variable stored in a formula.
    - @Error (Formula Language)
      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.
    - @Eval (Formula Language)
      At run-time, compiles and runs each element in a text expression as a formula. Returns the result of the last formula expression in the list or an error if an error is generated by any of the formula expressions in the list.
    - @Exp (Formula Language)
      Calculates the number e (approximately 2.718282) raised to the specified power (this value can contain up to 14 decimal places).
    - @Explode (Formula Language)
      Returns a text list composed of the elements of a text string or date range.
    - @Failure (Formula Language)
      Indicates that input to a field does not meet validation.
    - @False (Formula Language)
      Returns the number 0.
    - FIELD (Formula Language)
      A reserved word that is necessary when you are assigning values to fields that are stored in a document (as opposed to temporary fields). You can use FIELD to change the contents of an existing field or to create new fields.
    - @FileDir (Formula Language)
      Returns the directory portion of a path name, that is, the path name minus the file name.
    - @FloatEq (Formula Language)
      Compares two numbers for equality within a confidence range.
    - @FontList (Formula Language)
      Provides a list of available fonts on the Notes® client where this @function is executed.
    - @For (Formula Language)
      Executes one or more statements iteratively while a condition remains true. Executes an initialization statement. Checks the condition before executing the statements and executes an increment statement after executing the statements.
    - @FormLanguage (Formula Language)
      Returns the language of the current form.
    - @GetAddressBooks (Formula Language)
      Returns a list of the address books associated with a client (if the current database is local) or server.
    - @GetComponentViewPreference (Formula Language)
      Returns the value of the specified component view preference.
    - @GetCurrentTimeZone (Formula Language)
      Returns the current operating system's time zone settings in canonical time zone format.
    - @GetDocField (Formula Language)
      Given the unique ID of a document, returns the contents of a specific field on that document. The document must reside in the current database.
    - @GetField (Formula Language)
      Returns the value of a specified field.
    - @GetFocusTable (Formula Language)
      Returns the name, current row, or current column of the table that is in focus.
    - @GetHTTPHeader (Formula Language)
      In a Web application, returns the value of an HTTP header from the browser client request being processed by the server.
    - @GetIMContactListGroupNames (Formula Language)
    - @GetPortsList (Formula Language)
      Returns a list of enabled or disabled ports.
    - @GetProfileField (Formula Language)
      Retrieves a field from a profile document, and caches the field value for the remainder of the session.
    - @GetViewInfo (Formula Language)
      Returns a view attribute.
    - @HardDeleteDocument (Formula Language)
      In an agent that runs a formula, @HardDeleteDocument permanently removes the document currently being processed from the database if the database has soft deletions enabled. If the database does not have soft deletions enabled, @HardDeleteDocument performs the same action as @DeleteDocument.
    - @HashPassword (Formula Language)
      Encodes a string.
    - @Hour (Formula Language)
      Returns the number of the hour in the specified time-date.
    - @If (Formula Language)
      Evaluates a condition; if the condition is True, Notes/Domino performs the action appearing immediately after that condition, and stops. If the condition is False, Notes/Domino skips to the next condition and tests it, and so on. If none of the conditions is True, Notes/Domino performs the else_action.
    - @IfError (Formula Language)
      Returns a null string ("") or the value of an alternative statement if a statement returns an error.
    - @Implode (Formula Language)
      Concatenates all members of a text list and returns a text string.
    - @InheritedDocumentUniqueID (Formula Language)
    - @Integer (Formula Language)
      Truncates the values in a number or number list at the whole number, leaving off any decimals. The values in the resulting list are separated using the multi-value separator that is selected for display in the field containing the formula.
    - @IsAgentEnabled (Formula Language)
      Indicates whether or not a scheduled agent is enabled.
    - @IsAppInstalled (Formula Language)
      Indicates whether the specified type of application is installed.
    - @IsAvailable (Formula Language)
      Checks a document for the existence of a field.
    - @IsCategory (Formula Language)
      In a column formula, returns a specified string if any item in the row of a view is defined as a category.
    - @IsDB2 (Formula Language)
      Given a server and filename or server and replica ID, indicates if the specified database is backed by DB2® or not.
    - @IsDocBeingEdited (Formula Language)
      Checks the current status of the document and returns 1 (True) if the document is being edited; otherwise returns 0 (False).
    - @IsDocBeingLoaded (Formula Language)
      Checks the current status of the document and returns 1 (True) if the document is being loaded into memory for display; otherwise returns 0 (False).
    - @IsDocBeingMailed (Formula Language)
      Checks the current status of the document and returns 1 (True) if the document is being mailed; otherwise, returns 0 (False).
    - @IsDocBeingRecalculated (Formula Language)
      Checks the current status of the document and returns 1 (True) if the document is being recalculated; otherwise, returns 0 (False).
    - @IsDocBeingSaved (Formula Language)
      Checks the current status of the document and returns 1 (True) if the document is being saved; otherwise, returns 0 (False).
    - @IsDocTruncated (Formula Language)
      Indicates whether the current document has been truncated.
    - @IsEmbeddedInsideWCT (Formula Language)
      Indicates whether any part of the current Notes® session is embedded inside of Workplace client.
    - @IsError (Formula Language)
      Returns 1 (True) if the value is an @ERROR value, returns 0 (False) if not an error.
    - @IsExpandable (Formula Language)
      In column formulas, returns a specified string if a row in a view can be expanded.
    - @IsInCompositeApp (Formula Language)
      Indicates whether the component is running within a composite application.
    - @IsMember (Formula Language)
      Indicates if a piece of text (or a text list) is contained within another text list. The function is case-sensitive.
    - @IsModalHelp (Formula Language)
      Indicates whether the current document is a modal Help document.
    - @IsNewDoc (Formula Language)
      For a document being edited, indicates if the document has been saved to disk.
    - @IsNotMember (Formula Language)
      Indicates if a text string (or a text list) is not contained within another text list. The function is case-sensitive.
    - @IsNull (Formula Language)
      Tests for a null value. Returns true only if a value is a single text value that is null, otherwise it returns false. This function also returns false if the value is an error.
    - @IsNumber (Formula Language)
      Indicates if a given value is a number (or a number list).
    - @IsResponseDoc (Formula Language)
      Indicates whether a document is a response to another document.
    - @IsText (Formula Language)
      Indicates whether a value is text (or a text list).
    - @IsTime (Formula Language)
      Indicates whether a value is a time-date (or a time-date list).
    - @IsUnavailable (Formula Language)
      Indicates whether a field name exists in a document.
    - @IsUsingJavaElement (Formula Language)
      Indicates whether a view or outline uses the Java™ user interface.
    - @IsValid (Formula Language)
      Executes all validation formulas within the current form.
    - @IsVirtualizedDirectory (Formula Language)
      Indicates whether virtualized directories are enabled for the current server.
    - @Keywords (Formula Language)
      Given two text lists, returns only those items from the second list that are found in the first list.
    - @LanguagePreference (Formula Language)
      Returns user's specified preferred language setting.
    - @LaunchApp (Formula Language)
      Launches the requested Domino® application.
    - @LDAPServer (Formula Language)
      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:
    - @Left (Formula Language)
      Searches a string from left to right and returns the leftmost characters of the string.
    - @LeftBack (Formula Language)
      Searches a string from right to left and returns a substring.
    - @Length (Formula Language)
      Returns the number of characters in a text string.
    - @Like (Formula Language)
    - @Ln (Formula Language)
      Returns the natural log of a number. Natural logs use e (approximately 2.718282) as their base.
    - @Locale (Formula Language)
      Returns information about language codes.
    - @Log (Formula Language)
      Returns the common logarithm (base 10) of any number greater than zero.
    - @LowerCase (Formula Language)
      Converts the uppercase letters in the specified string to lowercase.
    - @MailDbName (Formula Language)
      Returns the name of the Domino® server and the name of the current user's mail database.
    - @MailEncryptSavedPreference (Formula Language)
      Indicates whether the user has selected "Encrypt saved mail" in the User Preferences dialog box.
    - @MailEncryptSentPreference (Formula Language)
      Indicates whether the user has selected "Encrypt sent mail" in the User Preferences dialog box.
    - @MailSavePreference (Formula Language)
      Indicates which option the user has selected for the "Save sent mail" setting in the User Preferences dialog box.
    - @MailSend (Formula Language)
      There are two ways to use @MailSend:
    - @MailSignPreference (Formula Language)
      Indicates whether the user has selected "Sign sent mail" in the User Preferences dialog box.
    - @Matches (Formula Language)
      Tests a string for a pattern string. Because the pattern string can contain a number of "wildcard" characters and logical symbols, you can test for complex character patterns.
    - @Max (Formula Language)
      Returns the largest number in a single list, or the larger of two numbers or number lists.
    - @Member (Formula Language)
      Given a value, finds its position in a text list.
    - @Middle (Formula Language)
    - @MiddleBack (Formula Language)
    - @Min (Formula Language)
      Returns the smallest number in a single list, or the smaller of two numbers or number lists.
    - @Minute (Formula Language)
      Extracts the number of minutes from the specified time-date.
    - @Modified (Formula Language)
      Returns a time-date value indicating when the document was modified initially.
    - @ModifiedInThisFile (Formula Language)
      Returns a time-date value indicating when the document was last modified in the current file.
    - @Modulo (Formula Language)
      Returns the remainder of a division operation.
    - @Month (Formula Language)
      Extracts the number of the month from the specified time-date.
    - @Name (Formula Language)
      Allows you to manipulate hierarchical names. You can abbreviate the canonical format of a name, expand an abbreviated name to its canonical format, identify particular components within the name, and reverse the order of the components so that you can categorize a view by hierarchical names.
    - @NameLookup (Formula Language)
      Searches for each specified user name across all Domino® Directories and returns a list of single text values for each specified user name.
    - @Narrow (Formula Language)
      Converts full-pitch alphanumeric characters (double byte characters -- DBCS) in the specified string to half-pitch alphanumeric characters (single byte characters -- SBCS). This function works in Japanese, Korean, Simplified Chinese, and traditional Chinese environments. In the Japanese environment, this function can convert full-pitch Katakana as well.
    - @NewLine (Formula Language)
      Inserts a new line (carriage return) into a text string.
    - @No (Formula Language)
      Returns the number 0.
    - @NoteID (Formula Language)
      The ID number of the current document.
    - @Nothing (Formula Language)
    - @Now (Formula Language)
      Returns the current time-date.
    - @OptimizeMailAddress (Formula Language)
      Returns a mail address with all unnecessary domains removed.
    - @OrgDir (Formula Language)
      In a Service Provider (xSP) environment, returns the name of the subdirectory for the company with which the currently authenticated user is registered. Notes/Domino retrieves this information from the organization's certifier document.
    - @Password (Formula Language)
      Encodes a string.
    - @PasswordQuality (Formula Language)
      Evaluates the return value of a Password data type field with a number.
    - @Pi (Formula Language)
      Returns the constant value pi, accurate to fifteen decimal places. The value pi is the ratio of the circumference of a circle to its diameter.
    - @PickList (Formula Language)
      Displays a modal window that contains either:
    - @Platform (Formula Language)
      Returns the name of the currently running platform version of Notes, Domino, or Nomad.
    - @PolicyIsFieldLocked (Formula Language)
    - @PostedCommand (Formula Language)
      Executes a Notes/Domino command. Most of the standard menu commands can be executed using @PostedCommand. In addition, a number of specialized commands are available. In a formula, any command invoked using @PostedCommand executes after the rest of the formula has been evaluated.
    - @Power (Formula Language)
      Raises a number to the power of an exponent.
    - @Prompt (Formula Language)
      Displays a dialog box to the user and returns a text value based on the user's actions in the dialog box. @Prompt is useful for prompting a user for information and determining a course of action based on the user's input.
    - @ProperCase (Formula Language)
      Converts the words in a string to proper-name capitalization: the first letter of each word becomes uppercase, all others become lowercase.
    - @Random (Formula Language)
      Generates a random number between 0 and 1, inclusive.
    - @RefreshECL (Formula Language)
      Copies the administration execution control list from a specified Address Book and name to your personal workstation ECL.
    - @RegQueryValue (Formula Language)
      Queries the Windows™ registry for a specified value.
    - REM (Formula Language)
      The REM reserved word allows you to add explanatory remarks (comments) to a formula. Quotation marks or braces delimit the text of the remark.
    - @Repeat (Formula Language)
      Repeats a string a specified number of times.
    - @Replace (Formula Language)
      Performs a find-and-replace operation on a text list.
    - @ReplaceSubstring (Formula Language)
      Replaces specific words or phrases in a string with new words or phrases that you specify. Case sensitive.
    - @ReplicaID (Formula Language)
      Returns the replica ID of the current database.
    - @Responses (Formula Language)
      Returns the number of responses (in the current view) to the document.
    - @Return (Formula Language)
      Immediately stops the execution of a formula and returns the specified value. This is useful when you only want the remainder of the formula to be executed only if certain conditions are True.
    - @Right (Formula Language)
      Returns the rightmost characters in the string. You can specify the number of rightmost characters you want returned, or you can indicate that you want all the characters following a specific substring.
    - @RightBack (Formula Language)
      Returns the rightmost characters in a string.
    - @Round (Formula Language)
      Rounds the designated number to the nearest whole number; if an additional number is specified, it is used as the rounding factor.
    - @Second (Formula Language)
      Extracts and returns the seconds value from the specified time-date.
    - SELECT (Formula Language)
      The SELECT reserved word defines criteria for the selection of documents in an agent that runs a formula, in a view, or during replication. You use a SELECT statement before an expression to define the set of documents that you want to change, see in a view, or replicate.
    - @Select (Formula Language)
      Returns the value that appears in the number position. If the number is greater than the number of values, @Select returns the last value in the list. If the value in the number position is a list, returns the entire list contained within the value.
    - @ServerAccess (Formula Language)
      Checks if a specified user has a specified administrative access level to a server.
    - @ServerName (Formula Language)
      Returns the name of the server containing the current database. When the database is local, returns the user name.
    - @Set (Formula Language)
      Assigns a value to a temporary variable for use within a formula.
    - @SetDocField (Formula Language)
      Given the unique ID of a document, sets the value of a specific field on that document. The document must reside in the current database.
    - @SetEnvironment (Formula Language)
      Sets an environment variable stored in the user's notes.ini file (Windows™ and UNIX™) or Notes® Preferences file (Macintosh).
    - @SetField (Formula Language)
      Assigns a value to a field stored within a document (use @Set for temporary variables). This is similar to using the FIELD keyword, except that @SetField can be used within another @function. If the field does not exist, this command creates it and applies the specified value to it.
    - @SetHTTPHeader (Formula Language)
      In a Web application, sets the value of HTTP headers in the response being generated by the server for the browser client.
    - @SetProfileField (Formula Language)
      Sets the value of a field in a profile document or creates a profile document.
    - @SetTargetFrame (Formula Language)
      Allows you to specify a target frame when opening a view, page, or frameset, or when composing or editing a document.
    - @SetViewInfo (Formula Language)
      In Standard Outline views, filters a view to display only documents from a specified category. In Calendar views, filters a view to display only documents that contain a specified string in a specified column.
    - @ShowParentPreview (Formula Language)
      Displays the parent document preview pane.
    - @Sign (Formula Language)
      Indicates whether a number is positive, negative, or zero.
    - @Sin (Formula Language)
    - @Sort (Formula Language)
      Sorts a list.
    - @Soundex (Formula Language)
      Returns the Soundex (the Notes® phonetic speller) code for the specified string.
    - @Sqrt (Formula Language)
      Given a number, returns its positive square root.
    - @StatusBar (Formula Language)
      Writes a message or messages to the status bar.
    - @Subset (Formula Language)
      Searches a list from beginning to end and returns the number values you specify. If you specify a negative number, @Subset searches the list from end to beginning, but the result is ordered as from the beginning of the list.
    - @Success (Formula Language)
      Returns 1 (True). Use this function with @If in field validation formulas to indicate that the value entered satisfies the validation criteria.
    - @Sum (Formula Language)
      Adds a set of numbers or number lists.
    - @Tan (Formula Language)
      Given an angle in radians, returns the tangent of the angle. In a right triangle the tangent of an acute angle is the ratio of the length of the opposite side to the length of the adjacent side.
    - @TemplateVersion (Formula Language)
    - @Text (Formula Language)
      Converts any value to a text string.
    - @TextToNumber (Formula Language)
      Converts a text string to a number, where possible.
    - @TextToTime (Formula Language)
      Converts a text string to a time-date value, where possible.
    - @ThisName (Formula Language)
      Returns the name of the current field.
    - @ThisValue (Formula Language)
      Returns the value of the current field.
    - @Time (Formula Language)
      Translates numbers for the various components of time and date; then returns the time-date value.
    - @TimeMerge (Formula Language)
    - @TimeToTextInZone (Formula Language)
      Converts a time-date value to a text string, incorporating time zone information.
    - @TimeZoneToText (Formula Language)
      Converts a canonical time zone value to a human-readable text string.
    - @Today (Formula Language)
      Returns today's date.
    - @Tomorrow (Formula Language)
      Returns the time-date value that corresponds to tomorrow's date.
    - @ToNumber (Formula Language)
      Converts a value to a number.
    - @ToTime (Formula Language)
      Converts a value with a data type of text or time to a date-time value.
    - @Transform (Formula Language)
      Applies a formula to each element of a list and returns the results in a list.
    - @Trim (Formula Language)
      Removes leading, trailing, and redundant spaces from a text string, or from each element of a text list.
    - @True (Formula Language)
      Returns the number 1. This function is equivalent to @Yes.
    - @Unavailable (Formula Language)
      Deletes the value of an editable field.
    - @UndeleteDocument (Formula Language)
    - @Unique (Formula Language)
      Without a parameter, returns a random, unique text value. With a parameter, removes duplicate values from a text list by returning only the first occurrence of each member of the list.
    - @UpdateFormulaContext (Formula Language)
      Updates the context of a formula to the Notes® client window currently being accessed by the code. For example, if the code accesses a new form called "Response" by using @Command([Compose]:"Response", @UpdateFormulaContext switches the context of the formula to this new form. Any subsequent functions in the code execute in the context of the Response document, not the current document.
    - @UpperCase (Formula Language)
      Converts the lowercase letters in the specified string to uppercase.
    - @URLDecode (Formula Language)
      Decodes a URL string into regular text.
    - @URLEncode (Formula Language)
      Encodes a string into a URL-safe format.
    - @URLGetHeader (Formula Language)
      Returns specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for identifying and addressing a Web page.
    - @URLHistory (Formula Language)
      Used for navigating, saving, and reloading a Uniform Resource Locator (URL) history list. The URL history list keeps track of all the Web pages you have visited. The history list is used for the Next and Previous buttons and for the Web Tours.
    - @URLOpen (Formula Language)
      Retrieves a World Wide Web page specified by its URL.
    - @UrlQueryString (Formula Language)
      In a Web application, returns the current URL command and parameters, or the value of one of the parameters.
    - @UserAccess (Formula Language)
      Given a server and file name, indicates the current user's level of access to the database.
    - @UserName (Formula Language)
      Returns the current user name.
    - @UserNameLanguage (Formula Language)
      Returns language tags associated with the user ID.
    - @UserNamesList (Formula Language)
      For a database on a server or a local database with "Enforce a consistent Access Control List across all replicas" in effect, @UserNamesList returns a text list containing the following information for the current user:
    - @UserPrivileges (Formula Language)
      Returns a text list of the current user's privileges. This function returns only the position of the privilege in the privilege list, not the name of the privilege.
    - @UserRoles (Formula Language)
      For a database on a server or a local replicated database, returns a list of roles that the current user has. Roles are defined in a database's access control list.
    - @V2If (Formula Language)
      This function performs an @If operation; the syntax is the same as for @If.
    - @V3UserName (Formula Language)
      Returns the current user name or server name. Using @V3UserName on a local database or in a private view in a server-based database returns the user's name.
    - @V4UserAccess (Formula Language)
      Given a server and file name, indicates the current user's level of access to the database.
    - @ValidateInternetAddress (Formula Language)
    - @VerifyPassword (Formula Language)
      Compares two passwords.
    - @Version (Formula Language)
      Returns the release number of the Notes/Domino software you're running.
    - @ViewShowThisUnread (Formula Language)
    - @ViewTitle (Formula Language)
      Returns the current view's name. If there are aliases and synonyms, they are returned in a text list.
    - @WebDbName (Formula Language)
      Returns the name of the current database encoded for URL inclusion.
    - @Weekday (Formula Language)
      Computes the day of the week and returns a number that identifies the day.
    - @WhichFolders (Formula Language)
      Returns the names of the folders containing the current document.
    - @While (Formula Language)
      Executes one or more statements iteratively while a condition is true. Checks the condition before executing the statements.
    - @Wide (Formula Language)
      Converts half-pitch alphanumeric characters (single-byte characters -- SBCS) in the specified string to full-pitch alphanumeric characters (double-byte characters -- DBCS). This function works in Japanese, Korean, Simplified Chinese, and traditional Chinese environments. In the Japanese environment, this function can convert half-pitch Katakana as well.
    - @Word (Formula Language)
      Returns the specified word from a text string. A "word" is defined as the part of a string that is delimited by the defined separator character. For example, if you specify a space (" ") as the separator, then a word is any series of characters preceded by and followed by a space (or the beginning or end of the string).
    - @Year (Formula Language)
      Extracts and returns the year from the specified time-date value.
    - @Yes (Formula Language)
      Returns the value 1.
    - @Yesterday (Formula Language)
      Returns the time-date value which corresponds to yesterday's date.
    - @Zone (Formula Language)
      Returns the time zone setting of the current computer or of a time-date value, and indicates if daylight-saving time is observed.
  - Formula Language @Commands A-Z
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

@DocLength (Formula Language)

Returns the approximate size of a document in bytes.

Syntax

@DocLength

Return value

length

Number. The size of the document.

Usage

This function works in any formula that runs in the context of one or more documents.

The number returned is only an approximation. The actual size of the document may differ for the following reasons:

The number accounts for user data only; it does not take into account per document or per field constants such as static text or formulas.
The database allocates storage in 64-byte increments; a document may not use all of the 64 bytes allotted to it.

Documents that are open typically use more storage than documents that are closed. The value returned for @DocLength may vary depending on whether it is running in an open document or a closed document; for example, a document selected at the view level.

Examples

This example returns 1808 if that is the approximate number of bytes in the document (one-page document, no enhanced text).

@DocLength