DatStat Illume 4.5 SDK Class Reference

HookContext Members

HookContext overview

Public Instance Properties

AlertErrorMessage Gets or sets an error message or warning to be displayed in a JavaScript alert when the next survey page is loaded. ErrorMessage
ErrorMessage Gets or sets an error message or warning to be displayed at the top of the next survey page. AlertErrorMessage
HookData Gets or sets the custom data for this hook call.
HttpContext Gets the HttpContext for the current web request.
IpAddress Gets the IP Address for the current survey participant.
LCID Gets the integer identifier of the current language being used by the participant.
PageItemNames Gets an array of strings giving the names of all Question, Text/Html, and Runtime Content items which appeared on the page FROM WHICH the last post-back operation occurred.
ParticipantId Gets the unique internal identifier for the current survey participant.
PostBackAction Gets a value indicating the action taken by the survey participant (i.e. the button which was pressed) causing the current postback.
PostBackErrors Gets a value indicating whether or not errors were generated by the last postback operation.
Preview Gets a value that specifies whether the survey is currently being previewed in the survey designer.
PriorSubmission Gets a value that specifies whether a submission has already been made for the current survey session.
SurveyGuid Gets the Globally Unique ID (or GUID) for the current survey.
SurveyId Gets the ID for the current survey.
SurveyName Gets the name for the current survey.
TestData Gets or sets a value that specifies whether the survey participant data will be saved as test data.
TestSurvey
TimePeriod Gets the time period ID for the current survey.

Public Instance Methods

CreateLoginId Returns a properly formatted concatenation of values suitable for a login ID.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExecSQLCommand Executes the given SQL command statement sqlStatement.
ExecSQLWithResults Returns a SqlDataReader resulting from the execution of the given SQL query statement sqlStatement.
GetCheckAllVariableNames Returns an array of names specifying each individual checkbox variable name for a check-all question.
GetCheckboxLabel Returns the label for an individual checkbox item in a check-all question.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetParameter Returns the value of the named survey parameter.
GetResponse Returns the current response to a survey variable.
GetResponseDataType Returns the data type of a survey variable.
GetResponseDescription Returns the data-dictionary description for a survey variable.
GetResponseInstructions Returns the instructions to the corresponding question-table containing a given survey variable.
GetResponseLabel Returns the scale label for the value of a survey variable.
GetResponsePrompt Return the data-dictionary prompt for a survey variable.
GetScaleValues Retrieves the scale values for the desired variable.
GetSurveyId Returns the ID of a named survey.
GetSurveyResponseViewNameOverloaded. Returns the database view name for a survey.
GetTextHtmlContent Returns the html content of a named survey Text/HTML object.
GetType (inherited from Object)Gets the Type of the current instance.
GetUserData Returns the value of the named User Data.
GetVariableIdByName Returns the internal ID of a survey variable.
GetVariableNameById Returns a friendly survey variable name given an internal variable ID.
GetVariableNames Returns all of the variable names in the data dictionary for the survey being accessed.
LogException Log an exception to the DatStat Illume Collector log file.
LogMessage Log a message to the DatStat Illume Collector log file.
MakeSubmission Makes a submission in the survey named surveyName using the variable/response pairs given in dataHash.
ResponseReplacement Returns a string with all DatStat Illume pipe directives replaced.
SetResponseData Sets the value of a survey variable identified by variableName to the responseValue provided.
SetUserData Sets the value of the named User Data.
ToString (inherited from Object)Returns a String that represents the current Object.
WebServiceContextOverloaded. Retrieves a web service context that is connected to the Designer Service using user/password credentials specified in the survey. An exception will be thrown if a user and password are not specified in the survey.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

HookContext Class | DatStat.Collector Namespace