Detailed Usage Instructions for Functions in "clc_status_main.js"

List of Functions

string CLC_GetStatus(DOM-Obj_Targ)

Input parameters:

DOM-Obj_Targ - DOM-Object to retrieve the status from. This should be an atomic DOM-Object.

Return parameter:

String - The status information that should be generated from DOM-Obj_Targ. If there is no appropriate status information, a null string will be returned.

Error messages:

Additional notes:

Status information includes things such as whether a radio button is selected or not, what the current text in the input blank is, etc.

string CLC_Status_RadioButton(DOM-Obj_RadioTypeInput)

Input parameters:

DOM-Obj_RadioTypeInput - Radio button type Input element to retrieve the status information for.

Return parameter:

String - In English mode, "Checked" or "Not Checked" depending on whether the DOM-Obj_RadioTypeInput is selected or not.

Error messages:

Additional notes:

string CLC_Status_TextBlank(DOM-Obj_TextTypeInput)

Input parameters:

DOM-Obj_TextTypeInput - Text type Input element to retrieve the status information for.

Return parameter:

String - Returns whatever is currently in the text blank. In English mode, if there is nothing, "The text area is empty." will be returned.

Error messages:

Additional notes:

string CLC_Status_PasswordBlank(DOM-Obj_PasswordTypeInput)

Input parameters:

DOM-Obj_PasswordTypeInput - Password Input element to retrieve the status information for.

Return parameter:

String - Returns the number of characters that have been typed. In English mode, "X characters have been typed." where X is the number of characters entered in the password blank.

Error messages:

Additional notes:

string CLC_Status_CheckBox(DOM-Obj_CheckTypeInput)

Input parameters:

DOM-Obj_CheckTypeInput - Check Box type Input element to retrieve the status information for.

Return parameter:

String - In English mode, "Checked" or "Not Checked" depending on whether the DOM-Obj_CheckTypeInput is selected or not.

Error messages:

Additional notes: