IUserAccessiable Interface |
Namespace: SurveyToGo.UserLogic.Interfaces
public interface IUserAccessiable
The IUserAccessiable type exposes the following members.
Name | Description | |
---|---|---|
ChildMgr | ||
ConnectionMgr | ||
CurrChapter | ||
CurrPageQuestions | ||
CurrQues | ||
DeviceID | ||
DeviceIndex | ||
DeviceVersion |
This function returns the STG data collection app version installed on the device.
| |
DisableAutomaticGPSUpdates | ||
DisplayDeviceIndex | ||
DisplayInfo | ||
DisplaySurveyIndex | ||
DownloadMgr | ||
ExecutionMgr | ||
ExtRefNum |
Set’s or returns the External Reference Number.
ExtRefNum is an additional place to store a reference number about a particular interview.
| |
FileMonitors | ||
FreeScenarioName | ||
GlobalVars | ||
GPSOpen |
Checks if the GPS is open.
| |
HasLocationID | ||
HasTask | ||
IsAutoResolve | ||
IsEmulator | ||
IsGoingBack | ||
IsManualResolve | ||
IsReviewer | ||
IterationIndex |
Relevant mainly when used within an iteration.
Returns the index of the current iteration
| |
IterationName |
Relevant mainly when used within an iteration.
Returns the name of the current iteration when iterating on Answer Scales otherwise contains the iteration number
| |
LanguageMgr |
/
| |
LastError | ||
Now | ||
Parent |
Parent provides you a way to 'communicate' between child and parent surveys. you call it from within the Child survey.
| |
QAScore |
Will return the Quality Control score of the particular interview.
| |
QuotaMgr | ||
RootDir | ||
SDCardDir | ||
ShowAddUserAttachment | ||
SID | ||
SoundRec | ||
SubjectData |
Set’s or returns the SubjectData column.
this column is an additional place to store information about a particular interview
| |
SubjectGPSLocation |
Used in order to set your currently captured Latitude and longitude that will be associated to the current Interview.
Can be used for example when a surveyor will use a manual used GPS and will manually enter the coordinates.
| |
SubjectMode | ||
SubmitTime |
Will return the submit time of the particular interview.
| |
SurveyClientData | ||
SurveyDescription |
Holds the survey description as was set int the Survey Properties tab of the survey
| |
SurveyGlobalVars | ||
SurveyID | ||
SurveyIndex | ||
SurveyName |
Holds the name of the current survey
| |
SurveyorComment |
Will Set or return the surveyor comment of the particular interview.
| |
SurveyorExtRefID | ||
SurveyorName |
Hold the name of the surveyore that is currently performing the interview
| |
SurveyUserGlobalVars | ||
SurveyVersion |
This function returns the survey version that is updated on the device.
| |
Task | ||
Ticket | ||
Timers | ||
TimeStamp |
Will return the current time stamp.
| |
Today | ||
TopBanner | ||
UIMgr | ||
ULValues | ||
UploadTime |
Will return the upload time of the particular interview.
| |
UserAttachmentCount | ||
UserGlobalVars | ||
Vars | ||
VisitDay |
Will return the day of the particular survey.
| |
VisitEnd |
Will return the ending time of the particular survey.
| |
VisitEndDay |
Will return the ending day of the particular interview.
| |
VisitStart |
Will return the starting time of the particular survey.
| |
VisitStartDay |
Will return the starting day of the particular interview.
|
Name | Description | |
---|---|---|
AddAlarmEntry | ||
AddCalendarEntry | ||
AddExternalListAnswer |
This function adds an answer to a pre-loaded external list question.
| |
AddExternalListAnswerIter(Int32, String, String, Int32) |
This function adds an answer to a pre-loaded external list question within a loop with a given iteration.
| |
AddExternalListAnswerIter(Int32, String, String, String) |
This function adds an answer to a pre-loaded external list question within a nested loop
| |
AddExternalListAnswerOtherSpecify |
This function adds an Other Specify type of answer to a pre-loaded external list question.
| |
AddExternalListAnswerOtherSpecifyIter(Int32, String, String, Int32) |
This function adds an Other Specify type of answer to a pre-loaded external list question in a loop with a given iteration.
| |
AddExternalListAnswerOtherSpecifyIter(Int32, String, String, String) |
This function adds an Other Specify type of answer to a pre-loaded external list question within a nested loop.
| |
AdditionalAnswerText |
Returns the Other-Specify text entered for the specified answer ID.
| |
AdditionalAnswerTextIter(Int32, String, Int32) | ||
AdditionalAnswerTextIter(Int32, String, String) |
Returns the Other-Specify text entered for the specified answer ID in the given iteration.
| |
AdditionalText | Obsolete.
Relevent mainly for single choice and multiple selection questions.
Returns the additional text of the "Other specify" answer that was coded in inQuesIdx.
| |
AdditionalTextIter(Int32, Int32) | Obsolete.
Relevent mainly for single choice and multiple selection questions, included inside a loop chapter.
Returns the additional text of the "Other specify" answer that was coded in inQuesIdx, during iteration inIter.
| |
AdditionalTextIter(Int32, String) | Obsolete.
Relevent mainly for single choice and multiple selection questions, included inside a loop chapter. Returns the additional text of the "Other specify" answer that was coded in inQuesIdx, during a specific nested loops iterations state.
| |
AdditionalValue | Obsolete.
Relevent mainly for single choice and multiple selection questions.
Returns DVar type value, of the additional text of the "Other specify" answer that was coded in inQuesIdx.
| |
AdditionalValueIter(Int32, Int32) | Obsolete.
Relevent mainly for single choice and multiple selection questions within an iteration.
Returns DVar type value, of the additional text of the "Other specify" answer that was coded in inQuesIdx in iteration inIter.
| |
AdditionalValueIter(Int32, String) | Obsolete.
Relevent mainly for single choice and multiple selection questions within a nested iteration.
Returns DVar type value, of the additional text of the "Other specify" answer that was coded in inQuesIdx in iteration inIter (nested iteration string created using CreateMultiIterationsString).
| |
Answer |
Returns the answer of a question. Valid for questions that have one answer like open ended, single choice, numeric etc.
Should not be used for questions of type Multiple Selection, Grids etc. for these questions use AnswerChoice
| |
AnswerChoice |
Relevent mainly for single choice grid and numeric choice grid questions.
Returnes a DVar value type, of the index (in a single choice grid) or the text (in a numeric grid) of the answer coded for inChoiceIdx in inQuesIdx.
| |
AnswerChoiceIdx | Obsolete. | |
AnswerChoiceIdxByCode | Obsolete. | |
AnswerChoiceIter(Int32, Int32, Int32) |
Relevent mainly for single choice grid and numeric choice grid questions, that were included inside a loop chapter.
Returns a DVar value type, of the index (in a single choice grid) or the text (in a numeric grid) of the answer coded for inChoiceIdx in inQuesIdx, during iteration inIter.
| |
AnswerChoiceIter(Int32, Int32, String) |
Relevent mainly for single choice grid and numeric choice grid questions, that were included inside a loop chapter.
Returns a DVar value type, of the index (in a single choice grid) or the text (in a numeric grid) of the answer coded for inChoiceIdx in inQuesIdx, during a specific nested loops iterations state.
| |
AnswerChoiceSelection |
Relevant for multiple selection grid questions. Returns the index of the answer that was chosen in a specific choice in the specific topic
| |
AnswerChoiceSelectionIter(Int32, Int32, Int32, Int32) |
Relevant for multiple selection grid questions. Returns the index of the answer that was chosen in a specific choice in the specific topic and iteration
| |
AnswerChoiceSelectionIter(Int32, Int32, Int32, String) |
Relevant for multiple selection grid questions. Returns the index of the answer that was chosen in a specific choice in the specific topic, during a specific nested loops iterations state.
| |
AnswerCode |
Returns the answer code of an answer in a non-grid questions
| |
Answered(Int32) |
Relevant for all Questions
Returns true if question inQuesIdx was answered and not skipped
| |
Answered(Int32, Boolean) | ||
AnsweredChoice |
Returns whether a given chice was answered.
| |
AnsweredChoiceIter |
Returns whether a given chice was answered.
| |
AnsweredIter(Int32, Int32) |
Relevant mainly for Questions that are part of an iteration
Returns true if question inQuesIdx was answered and not skipped in the iteration inIteration
| |
AnsweredIter(Int32, String) |
Returns true if question inQuesIdx was answered and not skipped in a specific nested loops iterations state.
| |
AnsweredIter(Int32, Int32, Boolean) | ||
AnsweredIter(Int32, String, Boolean) |
Returns true if question inQuesIdx was answered in a specific nested loops iterations state.
| |
AnswerIter(Int32, Int32) | ||
AnswerIter(Int32, String) |
Returns the DVar value of the answer that was coded in inQuesIdx, during a specific nested loops iterations state.
| |
AnswerIter(Int32, Boolean, String) | ||
AnswerText |
Relevent mainly for multiple selection questions.
Returns the text of inAnswerIdx in inQuesIdx.
| |
AppendAnswerText |
Relevant only for multi\single mention question types.
Gets a question index, an answer index, and a text to append to the relevant answertext.
| |
AppendFileText |
This function appends the given text inText into a file created and saved on the device / PC (add inText to the end of the text that exits in the given file).
As the function is Asynchronous, when the file is actually written the callback function void OnWriteFileTextResult(String inFileName, bool inSuccess, bool inAppended)) is called
and it includes the filename, success (read or not) and in this case the inAppended will be returned as true.
You need to override it in your Advanced Scripts to perform what you need in case of failure.
| |
AppendOpenEndedText |
Relevant mostly for open ended questions. This function append the text inText to an existing text in question inQuesIdx, and set the new text in the question.
| |
AppendOpenEndedTextChoice |
Relevant mostly for open ended grid questions. This function append the text inText to an existing text in topic inTopic in question inQuesIdx, and set the new text in this topic.
| |
AppendOpenEndedTextChoiceIter(Int32, Int32, Int32, String) |
Relevant mostly for open ended grid questions. This function append the text inText to an existing text in topic inTopic in question inQuesIdx, in a specific loop iteration, and set the new text in this topic for this iteration.
| |
AppendOpenEndedTextChoiceIter(Int32, Int32, String, String) |
Relevant mostly for open ended grid questions. This function append the text inText to an existing text in topic inTopic in question inQuesIdx, in a specific nested loops iterations state, and set the new text in this topic for this iterations state.
| |
AppendOpenEndedTextIter(Int32, Int32, String) |
Relevant mostly for open ended questions. This function append the text inText to an existing text in question inQuesIdx in a specific loop iteration, and set the new text in the question in this iteration.
| |
AppendOpenEndedTextIter(Int32, String, String) |
Relevant mostly for open ended questions. This function append the text inText to an existing text in question inQuesIdx in a specific nested loops iterations state, and set the new text in the question in this iterations state.
| |
AppendSurveyorComment | ||
AppendTopicText |
Relevant only for grid question types.
Gets a question index, a topic index, and a text to append to the relevant topic text.
| |
AreAllAnswersVisible |
Relevant mainly for Questions that have no topics included. For those use AreAllTopicsVisible
Returs true if all the answers are visble in question inQuesIdx
| |
AreAllTopicsVisible |
Relevant mainly for Questions that have topics included.
Returns true if all the topics in question inQuesIdx are visible, otherwise returns false
| |
Ask(String, eAskButtons) | ||
Ask(DVar, eAskButtons) |
Will prompt a question to the surveyor, according to the given values. It’s answer data is not saved.
Valid only for PC Surveyor
| |
AsyncAsk | ||
AttachCopy(String) | ||
AttachCopy(String, String, String, Boolean) | ||
AttachFile(String) | ||
AttachFile(String, String, String, Boolean) | ||
AttachLink | ||
AttachUserCopy(String) | ||
AttachUserCopy(String, String, String, Boolean) | ||
AttachUserFile(String) | ||
AttachUserFile(String, String, String, Boolean) | ||
AVPosRef | ||
AVRef | ||
BrowseTo |
The function can be used in the start/end script in order to open a specific URL
| |
CheckTopicsMaxValue | ||
CheckTopicsMinValue | ||
CheckTopicsNotValues |
checks if the given answer index’s were not selected in a single choice grid question.
| |
CheckTopicsValues |
checks if the given answer index’s were selected in a single choice grid question.
| |
ClearAnswer |
Resets the Answer to it's original state.
Important Note: Should only be used in extreme cases and it is advised to consult with Dooblo support before using it in a script.
| |
ClearAnswerAllIterations |
This function clear the answers for question inQuesIdx that is in a loop chapter, in all loop iterations.
| |
ClearAnswerIter(Int32, Int32) |
Resets the Answer to it's original state within a specific iteration.
Important Note: Should only be used in extreme cases and it is advised to consult with Dooblo support before using it in a script.
| |
ClearAnswerIter(Int32, String) |
This function resets the answers in question inQuesIdx to it's original state within a specific nested loops iterations state. Important Note: Should only be used in extreme cases and it is advised to consult with Dooblo support before using it in a script.
| |
ClearFlag | ||
ClearSubjectGPSLocation |
Clears the current gps data, if was captured
| |
CloseGPS |
Closes the GPS in order not to overwrite the GPS data
you already captured.
| |
Contains |
Relevant mainly for Multiple Selection Questions
Returns true if the inValue was selected in the inQuesIdx question as one of the answers
| |
ContainsAnyIter |
Relevant mainly for Multiple Selection Questions that are part of an iteration
Returns true if the inValue was selected in the inQuesIdx question as one of the answers in at least one of the iterations
| |
ContainsChoice |
Relevant for single and multiple selection grid questions. Returns true if the value was selected in a specific topic and false otherwise
| |
ContainsChoiceIter(Int32, Int32, Object, Int32) |
Relevant for single and multiple selection grid questions. Returns true if the value was selected in a specific topic in a specific iteration and false otherwise
| |
ContainsChoiceIter(Int32, Int32, Object, String) |
Relevant for single and multiple selection grid questions. Returns true if the value was selected in a specific topic in a specific nested loops iterations state and false otherwise.
| |
ContainsChoiceIterOneOf(Int32, Int32, Int32, Object) |
Relevant for single and multiple selection grid questions. Returns true if one of the values was selected in a specific topic and iteration and false otherwise
| |
ContainsChoiceIterOneOf(Int32, Int32, String, Object) |
Relevant for single and multiple selection grid questions. Returns true if any of the values was selected in a specific topic in a specific nested loops iterations state.
| |
ContainsChoiceOneOf |
Relevant for single and multiple selection grid questions. Returns true if one of the values was selected in a specific topic and false otherwise
| |
ContainsIter(Int32, Object, Int32) |
Relevant mainly for Multiple Selection Questions that are part of an iteration
Returns true if the inValue was selected in the inQuesIdx question as one of the answers in inIter iteration
| |
ContainsIter(Int32, Object, String) |
Relevant for single and multiple selection questions. Returns true if the value inValue was selected, in a specific nested loops iterations state.
| |
ContainsIterOneOf(Int32, Int32, Object) |
Relevant mainly for Multiple Selection Questions that are part of an iteration
Returns true if one or more of the inValues was selected in the inQuesIdx question as one of the answers in inIter iteration
| |
ContainsIterOneOf(Int32, String, Object) |
Relevant for single and multiple selection questions. Returns true if any of the values was selected, in a specific nested loops iterations state.
| |
ContainsOneOf |
Relevant mainly for Multiple Selection Questions
Returns true if one or more of the inValues was selected in the inQuesIdx question as one of the answers
| |
ContainsSpecificRate |
Relevant mainly for Single Choice Grid Questions
Returns true if the inValue was selected in the inTopicIdx topic in the inQuesIdx question
| |
ContainsSpecificRateIter(Int32, Int32, Int32, Int32) |
Relevant mainly for Single Choice Grid Questions
Returns true if the inValue was selected in the inTopicIdx topic in the inQuesIdx question in iteration inIter
| |
ContainsSpecificRateIter(Int32, Int32, Int32, String) |
Relevant mainly for Single Choice Grid Questions.
Returns true if the inValue was selected in the inTopicIdx topic in the inQuesIdx question in nested loops iterations string inIter.
| |
CreateAnswerWithAdditional | ||
CreateArray |
Creats an array with given values.
| |
CreateAttachment |
Not In Use
| |
CreateAttachment(String) |
Not In Use
| |
CreateAttachment(String, String) |
Not In Use
| |
CreateAttachment(String, String, String, Boolean) |
Not In Use
| |
CreateCoordinates(Double, Double) | ||
CreateCoordinates(Double, Double, String) | ||
CreateCoordinates(Int32, Int32, Double, Int32, Int32, Double) | ||
CreateCoordinates(Int32, Int32, Double, Int32, Int32, Double, String) | ||
CreateCoords(Double, Double) |
Use to create a GPS location.
| |
CreateCoords(Double, Double, String) |
Use to create a GPS location.
| |
CreateCoords(Int32, Int32, Double, Int32, Int32, Double) |
Use to create a GPS location.
| |
CreateCoords(Int32, Int32, Double, Int32, Int32, Double, String) |
Use to create a GPS location.
| |
CreateCyclicArray |
Returns an integers array with size inSize, containing numbers in the range [1,inSize], in cyclic order, starting with the number inStart.
| |
CreateDate | ||
CreateDVar | ||
CreateEmptyList | ||
CreateGUID | ||
CreateGUIDFromString | ||
CreateIntArray |
Creats an array with given values.
| |
CreateIntentInfo | ||
CreateMapMarker(ISimpleCoordinates, String) | ||
CreateMapMarker(ISimpleCoordinates, String, Int32, Int32) | ||
CreateMultiIterationsString |
This function gets a list of iteration indexes of nested loops, and return this list as a string.
This returned value is to be used in all system loop functions that by default get a single iteration index.
| |
CreateRandomArray(Int32) |
Returns an integers array with size inSize, containing numbers in the range [1,inSize], in randomized order.
| |
CreateRandomArray(Int32, Int32, Int32) |
Returns an integers array with size inSize, containing numbers in the range [inMinValue,inMaxValue], in randomized order.
values amount in the range [inMinValue,inMaxValue] must be equal to or greater than inSize.
| |
CreateRandomCyclicArray |
Returns an integers array with size inSize, containing numbers in the range [1,inSize], in randomized cyclic order.
| |
Date | ||
DoCustomAction | ||
DoCyclicJump | ||
Equals |
Relevant mainly for Single Choice Questions
Returns true if the answer of inQuesIdx is inValue. It is equivalent to Answer(inQuesIdx)==inValue
| |
EqualsAnyIter |
Relevant mainly for Single Choice Questions that are part of an iteration
Returns true if the answer of inQuesIdx is inValue in at least one of the iterations
| |
EqualsIter |
Returns 'true' if value inValue is the answer of question inQues, in a specific nested loops iterations state.
| |
ExpandSeqArray | ||
ExternParam | ||
ExtFunc | ||
ExtFuncArray | ||
FillFromAttachment(IListSource, String, String, String, String, String, String, String) | ||
FillFromAttachment(IListSource, String, String, String, String, String, String, String, String, Boolean) | ||
FillFromDBFile(IListSource, String, String, String, String, String, String, String) | ||
FillFromDBFile(IListSource, String, String, String, String, String, String, String, String, Boolean) | ||
FillFromDBFileFilter | ||
FillFromDBFileGroup | ||
FillFromLocation(IListSource) | ||
FillFromLocation(IListSource, String, String) | ||
FillFromLocation(IListSource, String, String, String, String) | ||
FillFromLocation(IListSource, String, String, String, String, String, Boolean) | ||
FillFromLocationFilter(IListSource, String, DVar) | ||
FillFromLocationFilter(IListSource, String, String, String, DVar) | ||
FillFromLocationGroup | ||
FillFromStore(IListSource, String) |
This function is used for list sources in order to
set the list source configuration.
| |
FillFromStore(IListSource, String, String, String) |
This function is used for list sources in order to
set the list source configuration.
| |
FillFromStore(IListSource, String, String, String, String, String) | ||
FillFromStore(IListSource, Int32, String, String, String, String, String) | ||
FillFromStore(IListSource, Int32, String, String, String, String, String, String) | ||
FillFromStore(IListSource, String, String, String, String, String, String, Boolean) | ||
FillFromStoreFilter(IListSource, String, String, DVar) |
This function is used for list sources in order to
set the list source configuration.
| |
FillFromStoreFilter(IListSource, String, String, String, String, DVar) |
This function is used for list sources in order to
set the list source configuration.
| |
FillFromStoreGroup |
This function is used for list sources in order to
set the list source configuration.
| |
FillFromSubjectStore(IListSource) | ||
FillFromSubjectStore(IListSource, String, String) | ||
FillFromSubjectStore(IListSource, String, String, String, String) | ||
FillFromSubjectStore(IListSource, String, String, String, String, String, Boolean) | ||
FillFromSubjectStoreFilter(IListSource, String, DVar) | ||
FillFromSubjectStoreFilter(IListSource, String, String, String, DVar) | ||
FillFromSubjectStoreGroup | ||
FillFromUL | ||
FilterAnswersByAnswers(Int32, Int32) |
Hides or shows the answers in Multiple Selection,Single choice,Rating and Single Choice Grid (inTargetQuesIdx) that are selected in Multiple Selection, Single choice, Rating, Single Choice Grid and Single Choice Grid
| |
FilterAnswersByAnswers(Int32, Boolean, Int32) |
Hides or shows the answers in Multiple Selection,Single choice,Rating and Single Choice Grid (inTargetQuesIdx) that are selected in Multiple Selection, Single choice, Rating and Single Choice Grid
| |
FilterAnswersByAnswers(Int32, Boolean, Boolean, Int32) |
Hides or shows the answer in Multiple Selection,Single choice,Rating and Single Choice Grid (inTargetQuesIdx) that are selected in Multiple Selection, Single choice, Rating and Single Choice Grid
| |
FilterAnswersByTopics(Int32, Int32, Int32) |
Hides or shows the answers in Multiple Selection,Single choice,Rating, Single Choice Grid and Single Choice Grid (inTargetQuesIdx) that their mathcing (by index) topic in (inSourceIdx) of type Single Choice Grid, Single Choice Grid Matrix and Counter (Not including Single choiceGrid) has one of the values in (inValues)
| |
FilterAnswersByTopics(Int32, Boolean, Int32, Int32) |
Hides or shows the answers in Multiple Selection,Single choice,Rating and Single Choice Grid (inTargetQuesIdx) that their mathcing (by index) topic in Single Choice Grid, Matrix and Counter (inSourceIdx) has one of the values in (inValues)
| |
FilterAnswersByTopics(Int32, Boolean, Boolean, Int32, Int32) |
Hides or shows the answers in Multiple Selection,Single choice,Rating and Single Choice Grid (inTargetQuesIdx) that their mathcing (by index) topic in Single Choice Grid, Matrix and Counter (inSourceIdx) has one of the values in (inValues)
| |
FilterTopicsByAnswers(Int32, Int32) |
Hides or shows the topics in Matrix, Single Choice Grid, Stopper and Counter (inTargetQuesIdx) that thier matching (by index) answers are selected in Multiple Selection, Single choice, Rating, Single Choice Grid and Single Choice Grid
| |
FilterTopicsByAnswers(Int32, Boolean, Int32) |
Hides or shows the topics in Matrix, Single Choice Grid, Stopper and Counter (inTargetQuesIdx) that thier matching (by index) answers are selected in Multiple Selection, Single choice, Rating and Single Choice Grid
| |
FilterTopicsByAnswers(Int32, Boolean, Boolean, Int32) |
Hides or shows the topics in Matrix, Single Choice Grid, Stopper and Counter (inTargetQuesIdx) that thier matching (by index) answers are selected in Multiple Selection, Single choice, Rating and Single Choice Grid (Not including Single choiceGrid)
| |
FilterTopicsByTopics(Int32, Int32, Int32) |
Hides or shows the topics in Matrix, Single Choice Grid, Stopper and Counter (inTargetQuesIdx) that their mathcing (by index) topic in Single Choice Grid, Matrix and Counter (inSourceIdx) has one of the values in (inValues)
| |
FilterTopicsByTopics(Int32, Boolean, Int32, Int32) |
Hides or shows the topics in Matrix, Single Choice Grid, Stopper and Counter (inTargetQuesIdx) that their mathcing (by index) topic in Single Choice Grid, Matrix and Counter (inSourceIdx) has one of the values in (inValues)
| |
FilterTopicsByTopics(Int32, Boolean, Boolean, Int32, Int32) |
Hides or shows the topics in Matrix, Single Choice Grid, Stopper and Counter (inTargetQuesIdx) that their mathcing (by index) topic in Single Choice Grid, Matrix and Counter (inSourceIdx) has one of the values in (inValues)
| |
FindLocationByID | ||
FlagInterview | ||
Floor | ||
FormatNumber | ||
FormatNumberInvariant | ||
GetAllChapters | ||
GetAnswerChoiceIdx |
Returns the answer index according to the matching answer text given.
Returns -1 if does not exist
| |
GetAnswerChoiceIdxByCode |
Returns the answer index according to the matching answer ///code given.
| |
GetAnswerCount |
Returns the number of answers in a non-grid questions
| |
GetAnswerOriginalText |
Relevant only for grid question types.
Gets a question index, an answer index and returns the original text (in case it was changed by Append\'Set' functions)
| |
GetAnswers(Int32) |
Relevant for all questions.
Returns a list of the selected answers depending on the question type.
For example for a Single Choice question it would rerutn the selected answer (equivalent to Answer(inQuesIdx)).
For a Multiple Selection question it would return a list of all the selected answers
| |
GetAnswers(Int32, Boolean) |
Relevant for all questions.
Returns a list of the selected answers depending on the question type in a randomized order.
For example for a Single Choice question it would rerutn the selected answer (equivalent to Answer(inQuesIdx)).
For a Multiple Selection question it would return a list of all the selected answers in a randomized order.
| |
GetAnswers(Int32, Int32, Boolean) |
Relevant for all questions.
Returns a list of inMaxSize selected answers (or all of them if inMaxSize is larger than the number of selected answers) depending on the question type in a randomized order.
For example for a Single Choice question it would rerutn the selected answer (equivalent to Answer(inQuesIdx)).
For a Multiple Selection question it would return a list of inMaxSize selected answers in a randomized order.
| |
GetAnswersChoice(Int32, Int32) |
Relevant mainly for multiple selection grid questions. Returns an array of the answers that were selected in a specific topic
| |
GetAnswersChoice(Int32, Int32, Boolean) |
Relevant mainly for multiple selection grid questions. Returns an array of the answers that were selected in a specific topic in a randomized order
| |
GetAnswersChoice(Int32, Int32, Int32, Boolean) |
Relevant mainly for multiple selection grid questions. Returns a list of inMaxSize selected answers (or all of them if inMaxSize is larger than the number of selected answers) in a randomized order
| |
GetAnswersChoiceIter(Int32, Int32, Int32) |
Relevant mainly for multiple selection grid questions. Returns an array of the answers that were selected in a specific topic in a specific iteration
| |
GetAnswersChoiceIter(Int32, Int32, String) |
Relevant mainly for multiple selection grid questions within an iterated chapter. Returns a list of the selected answers in topic inTopic, in a specific nested loops iterations state.
| |
GetAnswersChoiceIter(Int32, Int32, Int32, Boolean) |
Relevant mainly for multiple selection grid questions. Returns an array of the answers that were selected in a specific topic in a specific iteration in a randomized order
| |
GetAnswersChoiceIter(Int32, Int32, String, Boolean) |
Relevant mainly for multiple selection grid questions within an iterated chapter. Returns a list of the selected answers in topic inTopic, in a specific nested loops iterations state. If needed, in a randomized order.
| |
GetAnswersChoiceIter(Int32, Int32, Int32, Int32, Boolean) |
Relevant mainly for multiple selection grid questions. Returns a list of inMaxSize selected answers (or all of them if inMaxSize is larger than the number of selected answers) in a randomized order
| |
GetAnswersChoiceIter(Int32, Int32, String, Int32, Boolean) |
Relevant mainly for multiple selection grid questions within an iterated chapter. Returns a list of the selected answers in topic inTopic, in a specific nested loops iterations state. If needed, in a randomized order and in a maximal array size.
| |
GetAnswersIter(Int32, Int32) |
Relevant for all questions that are within an iterated chapter.
Returns a list of the selected answers in a specific itreation depending on the question type.
For example for a Single Choice question it would rerutn the selected answer (equivalent to AnswerIter(inQuesIdx, inIter)).
For a Multiple Selection question it would return a list of all the selected answers
| |
GetAnswersIter(Int32, String) |
Relevant for all questions that are within an iterated chapter. Returns a list of the selected answers in a specific nested loops iterations state, depending on the question type.
For example, for a Multiple Selection question it would return a list of all the selected answers.
| |
GetAnswersIter(Int32, Int32, Boolean) |
Relevant for all questions that are within an iterated chapter.
Returns a list of the selected answers in a specific itreation depending on the question type in a randomized order.
For example for a Single Choice question it would rerutn the selected answer (equivalent to AnswerIter(inQuesIdx, inIter)).
For a Multiple Selection question it would return a list of all the selected answers in a randomized order.
| |
GetAnswersIter(Int32, String, Boolean) |
Relevant for all questions that are within an iterated chapter. Returns a list of the selected answers in a specific nested loops iterations state, if needed, in a randomized order.
For example, for a Multiple Selection question it would return a list of all the selected answers.
| |
GetAnswersIter(Int32, Int32, Int32, Boolean) | ||
GetAnswersIter(Int32, String, Int32, Boolean) |
Relevant for all questions that are within an iterated chapter. Returns a list of the selected answers in a specific nested loops iterations state, if needed, in a randomized order in a maximal array size.
For example, for a Multiple Selection question it would return a list of all the selected answers.
| |
GetAttachedFiles |
Returns an array of strings, each item holds the file name of an attachment within the interview.
| |
GetAttachedFiles(Int32) | ||
GetAttachedFilesCount | ||
GetAttachedFilesCountIter(Int32, Int32) | ||
GetAttachedFilesCountIter(Int32, String) | ||
GetAttachedFilesIter(Int32, Int32) | ||
GetAttachedFilesIter(Int32, String) | ||
GetAttachedFilesNames |
Returns an array of strings, each item holds the attachment name of an attachment within the interview.
| |
GetAttachedFilesNames(Int32) | ||
GetAttachedFilesNamesIter(Int32, Int32) | ||
GetAttachedFilesNamesIter(Int32, String) | ||
GetAttachment | ||
GetAttachmentByName |
Returns a file name according to a given attachment name.
| |
GetAttachmentID | ||
GetBaseSubjectProps | ||
GetChapter | ||
GetChapterIterations |
Returns an array that contains the numbers of the iterations that a spacific chapter was asked
| |
GetChapterIterationsNames |
Returns a string that contains the iterations names
| |
GetDeviceVersionAtLeast |
This function returns 'true' if the given STG data collection app version inOtherVersion is equal or less than the actual app version installed on the device.
| |
GetEnumName | ||
GetExternalSubjectProps | ||
GetExtraLabelOriginalText | ||
GetExtraLabelText | ||
GetGPSInfo |
Returns the current GPS info.
| |
GetGPSLocation |
Returns the current location as captured by the GPS.
| |
GetInstructionsOriginalText | ||
GetInstructionsText | ||
GetLocationProps | ||
GetNextCyclicArrayPosition | ||
GetNotCompletedChapters | ||
GetNotCompletedChaptersAsString | ||
GetNumOfTopicsNotAboveValue | ||
GetNumOfTopicsNotBelowValue | ||
GetNumOfTopicsWithNotValues |
returns the number of topics without the given values in a single choice grid question.
| |
GetNumOfTopicsWithValues |
returns the number of topics with the given answers in a single choice grid question.
| |
GetOriginalText |
Relevant for all question types.
Gets a question index and returns the original text in its body (in case it was changed by Append\'Set' functions)
| |
GetPageText |
Not In Use
| |
GetParentIterationIndex |
This function gets a level number within the nested loops and returns the index of the current iteration in that loop level.
| |
GetParentIterationIndexPath |
This function gets a level number within the nested loops and returns a list of the iteration indexes from the highest loop level (the most outer one) to the given level.
| |
GetParentIterationName |
This function gets a level number within the nested loops and returns the name of the current iteration in that loop level.
| |
GetPropertyAnswer | ||
GetPropertyAnswerIter(Int32, Int32, Int32) | ||
GetPropertyAnswerIter(Int32, Int32, String) | ||
GetPropertyQuestion | ||
GetPropertyQuestionIter(Int32, Int32) | ||
GetPropertyQuestionIter(Int32, String) | ||
GetPropertySurvey | ||
GetPropertyTopic | ||
GetPropertyTopicIter(Int32, Int32, Int32) | ||
GetPropertyTopicIter(Int32, Int32, String) | ||
GetQuestionIterations |
Returns an array that contains the numbers of the iterations that a spacific question was asked
| |
GetQuestionIterationsNames |
Returns a string that contains the names of the iterations that a specific question was asked
| |
GetQuestionType | ||
GetQuotasForSurvey | ||
GetRootChapter | ||
GetSerial | ||
GetSubjectProps | ||
GetTableFromAttachment(String, String, String, String, String, String) | ||
GetTableFromAttachment(String, String, String, String, String, String, String) | ||
GetTableFromDBFile(String, String, String) | ||
GetTableFromDBFile(String, String, String, String, String, String) | ||
GetTableFromDBFile(String, String, String, String, String, String, String) | ||
GetTableFromLocation | ||
GetTableFromLocation(String, String, String) | ||
GetTableFromLocation(String, String, String, String) | ||
GetTableFromStore(String) |
Will get a name of a subject store and return the table object.
in JS should be inserted into a ‘var’ type.
| |
GetTableFromStore(String, String, String, String) |
Will get the name of the subject store, and SQL commands
to pull through data out of the Table.
in JS should be inserted into a ‘var’ type.
| |
GetTableFromStore(String, String, String, String, String) | ||
GetTableFromSubjectStore | ||
GetTableFromSubjectStore(String, String, String) | ||
GetTableFromSubjectStore(String, String, String, String) | ||
GetText |
Relevant for all question types.
Gets a question index and returns the current text in its body
| |
GetTopicCount |
Returns the number of topics in a grid questions
| |
GetTopicOriginalText |
Relevant only for grid question types.
Gets a question index, a topic index and returns the original text (in case it was changed by Append\'Set' functions)
| |
GetVisibleAnswerCount |
Returns the number of visible answers in a non-grid questions
| |
GetVisibleTopicCount |
Returns the number of visible topics in a grid questions
| |
GPSAnswer | ||
GPSAnswerIter(Int32, Int32) | ||
GPSAnswerIter(Int32, String) | ||
GPSAnswers | ||
GPSAnswersIter(Int32, Int32) | ||
GPSAnswersIter(Int32, String) | ||
GPSSetAnswer | ||
GPSSetAnswerIter(Int32, Int32, ISimpleCoordinates) | ||
GPSSetAnswerIter(Int32, String, ISimpleCoordinates) | ||
GPSSetAnswers | ||
GPSSetAnswersIter(Int32, Int32, ISimpleCoordinates) | ||
GPSSetAnswersIter(Int32, String, ISimpleCoordinates) | ||
HasOtherSpec | ||
HasRepeatAnswers(Int32) | ||
HasRepeatAnswers(Int32, Int32) | ||
Iff | ||
ImagePositionAnswer | ||
ImagePositionAnswerIter(Int32, Int32, Int32) | ||
ImagePositionAnswerIter(Int32, String, Int32) | ||
ImagePositionSetAnswer | ||
ImagePositionSetAnswerIter(Int32, Int32, Int32, Int32, Int32, Int64, Int32) | ||
ImagePositionSetAnswerIter(Int32, String, Int32, Int32, Int32, Int64, Int32) | ||
InArray(Int32, Int32) |
returns True\False if a given value is within a given array.
| |
InArray(DVar, DVar) |
returns True\False if a given value is within a given array.
| |
IndexOf |
Will return the array index of a value within the array.
| |
IndexOfInt |
Will return the array index of a value within the array.
| |
IntArrayToString |
Will turn a string in a specific format, to an Integer array.
| |
intParse |
Convert integer represented in string inA, into an int type
| |
IsAllDigits |
Returns true if the string contains only digits and false otherwise.
| |
IsAnswerVisible |
Relevant mainly for Questions that have no topics included. For those use IsTopicVisible
Returs true if an answer inAnserIdx is visble in question inQuesIdx
| |
IsAnyAnswerVisible |
Relevant mainly for Questions that have no topics included. For those use IsAnyTopicVisible
Returs true if at least one of the answers is visble in question inQuesIdx
| |
IsAnyTopicVisible |
Relevant mainly for Questions that have topics included.
Returns true if at least one of the topics in question inQuesIdx is visible, otherwise returns false
| |
IsChapterVisible | ||
IsCodesAnswer |
This function's return's 'true' or 'false' if a special code was selected in a Numeric\Open-Ended question
| |
IsCodesAnswerIter(Int32, Int32) |
This function's return's 'true' or 'false' if a special code was selected in a Numeric\Open-Ended question within a loop with a given iteration.
| |
IsCodesAnswerIter(Int32, String) |
This function's return's 'true' or 'false' if a special code was selected in a Numeric\Open-Ended question within a nested loop.
| |
IsEMail |
Returns true if the string is a legal E-mail address and false otherwise
| |
IsFileExist | ||
IsMatch(String, DVar) | ||
IsMatch(String, DVar, Boolean) | ||
IsNullOrEmpty | ||
IsOtherSpec | ||
IsOtherSpecRepeated | ||
IsPlatform | ||
IsQuestionScored | ||
IsRegEx | ||
IsTopicVisible |
Relevant mainly for Questions that have topics included.
Returns true if the topic inTopicIdx in question inQuesIdx is visible, otherwise returns false
| |
LocateAddress | ||
MegaGetAnswer | ||
MegaSetAnswer | ||
NotAnswered |
Relevant for all Questions
Returns true if question inQuesIdx was not answered but was skipped
| |
NotAnsweredIter(Int32, Int32) |
Relevant mainly for Questions that are part of an iteration
Returns true if question inQuesIdx was not answered but got skipped in the iteration inIteration
| |
NotAnsweredIter(Int32, String) |
Returns true if question inQuesIdx was not answered but got skipped in a specific nested loops iterations state.
| |
NotContains |
Relevant mainly for Multiple Selection Questions
Returns true if the inValue was not selected in the inQuesIdx question as one of the answers
| |
NotContainsIter(Int32, Object, Int32) |
Relevant mainly for Multiple Selection Questions that are part of an iteration
Returns true if the inValue was not selected in the inQuesIdx question as one of the answers in inIter iteration
| |
NotContainsIter(Int32, Object, String) |
Relevant for single and multiple selection questions. Returns true if the value inValue wasn't selected, in a specific nested loops iterations state.
| |
NotContainsSpecificRate |
Relevant mainly for Single Choice Grid Questions
Returns true if the inValue was not selected in the inTopicIdx topic in the inQuesIdx question
| |
NotContainsSpecificRateIter(Int32, Int32, Int32, Int32) |
Relevant mainly for Single Choice Grid Questions
Returns true if the inValue was selected in the inTopicIdx topic in the inQuesIdx question in iteration inIter
| |
NotContainsSpecificRateIter(Int32, Int32, Int32, String) |
Relevant mainly for Single Choice Grid Questions.
Returns true if the inValue wasn't selected in the inTopicIdx topic in the inQuesIdx question in nested loops iterations string inIter.
| |
NotSubjectPropEquals | ||
NumOfChoices | Obsolete.
OBSELETE
| |
NumOfSelectedChoices |
Returns the number of answers selected in Multi-Selection questions.
| |
NumOfSelectedChoicesChoice |
Relevant for multiple selection grid questions. Returns the amount of the answers that were selected in a specific topic
| |
NumOfSelectedChoicesChoiceIter(Int32, Int32, Int32) |
Relevant for multiple selection grid questions. Returns the amount of the answers that were selected in a specific topic and in a specific iteration
| |
NumOfSelectedChoicesChoiceIter(Int32, Int32, String) |
Relevant for multiple selection grid questions. Returns the amount of the answers that were selected in a specific topic within a specific nested loops iterations state.
| |
NumOfSelectedChoicesIter(Int32, Int32) |
Returns the number of answers selected in Multi-Selection questions placed in a loop, within a given iteration.
| |
NumOfSelectedChoicesIter(Int32, String) |
Returns the number of answers selected in Multi-Selection questions placed in a loop, within a specific nested loops iterations state.
| |
OpenGPS |
Enables the GPS for use and call’s this function:
function OnGPSUpdated(inLocation)
{
SubjectGPSLocation = inLocation;
}
this function can be added to the advanced scripts and re-edited
| |
OpenUserSelection | ||
ParseJson | ||
ParseXml | ||
Prompt(String) |
Relevant for all questions.
Displays the inPrompt in a popup message window. Can also be used for debugging purposes while testing a survey during scripting.
You can combine explicit text within quotes or DVars with the '+' sign between them
| |
Prompt(DVar) |
Relevant for all questions.
Displays the inPrompt in a popup message window. Can also be used for debugging purposes while testing a survey during scripting.
You can combine explicit text within quotes or DVars with the '+' sign between them
| |
QRef |
Used to have SurveyToGo automatically shift question index when questions are moved around at design time
| |
QuestionChapter | ||
Random | ||
RandomizeAnswers(Int32) |
Releveant mainly for single choice and multiple selection questions.
Display the answers of question inQuesIdx in a randomized order.
| |
RandomizeAnswers(Int32, Int32) |
Releveant mainly for single choice and multiple selection questions.
Display the answers of question inQuesIdx in a randomized order, according to the order determined in inRandomArray.
| |
RandomizeArray |
Gets an integers array inArray, and returns an integers array in the same size of inArray, with randomized order of the original inArray content order.
| |
RandomizeTopics(Int32) |
Releveant mainly for single choice grid questions.
Display the topics of question inQuesIdx in a randomized order.
| |
RandomizeTopics(Int32, Int32) |
Releveant mainly for single choice grid questions.
Display the topics of question inQuesIdx in a randomized order, according to the order determined in inRandomArray.
| |
ReadFileLines |
This function is a Asynchronous function enabling to read the text seperated into lines in a given file saved on the device / PC.
As the function is Asynchronous, when the file is actually read the callback function void OnReadFileLinesResult(String inFileName, bool inSuccess, String[] inFileLines) is called
and it includes the filename, success (read or not) and a String array of the lines in the file it read.
You need to override it in your Advanced Scripts to perform what you need in case of failure or perfrom any action with the read text.
| |
ReadFileText |
This function reads the text in a given file saved on the device / PC.
As the function is Asynchronous, when the file is actually read the callback function void OnReadFileTextResult(String inFileName, bool inSuccess, String inFileText) is called
and it includes the filename, success (read or not) and a String array of the lines in the file it read.
You need to override it in your Advanced Scripts to perform what you need in case of failure or perfrom any action with the read text.
| |
RemoveAttachment |
Removes a specific attachment from an interview according to /// a given file name.
| |
RemoveAttachmentByName |
Removes a specific attachment from an interview according to /// a given attachment name.
| |
ReRandomizeIterations | ||
ResetAnswerText(Int32) | ||
ResetAnswerText(Int32, Int32) | ||
ResetQuestion | ||
ResetSortAnswers |
Cancels the Randomization defined for the Answers of that quetion. for example if the Randomize Answers is globally defnied for this question but on a certain condition
in an interview you want to ignore it you can use ResetSortAnswers(CurrQues).
| |
ResetSortTopics |
Cancels the Randomization defined for the Topics of that quetion. for example if the Randomize Topics is globally defnied for this question but on a certain condition
in an interview you want to ignore it you can use ResetSortTopics(CurrQues).
| |
ResetTopicText(Int32) | ||
ResetTopicText(Int32, Int32) | ||
RotateAnswers |
This function display the answers in some rotation order.
| |
RotateTopics |
This function display the topics of a question in some rotation order.
| |
Round |
Perform Excel like Rounding; Round the number to the nearest integer.
If the fractional component of the number is halfway between two integers, round up and for positive numbers and round down for negative numbers.
| |
RunFile | ||
RunProcess | ||
SelectedAnswerChoiceCode |
Relevent single choice grid and numeric choice grid questions.
Returnes the coding text of the answer coded for inChoiceIdx in inQuesIdx.
| |
SelectedAnswerChoiceText |
Relevent mainly for single choice grid and numeric grid questions.
Returns the text of the answer coded for inChoiceIdx in inQuesIdx.
| |
SelectedAnswerChoiceTextIter(Int32, Int32, Int32) |
Relevent mainly for single choice grid and numeric grid questions, included inside a loop chapter.
Returns the text of the answer coded for inChoiceIdx in inQuesIdx, during iteration inIter.
| |
SelectedAnswerChoiceTextIter(Int32, Int32, String) |
Relevent mainly for single choice grid and numeric grid questions, included inside a loop chapter. Returns the text of the answer coded for inChoiceIdx in inQuesIdx, during a specific nested loops iterations state.
| |
SelectedAnswerCode |
Relevent for single choice questions.
Returnes the coding text of the answer coded in inQuesIdx.
| |
SelectedAnswerText(Int32) |
Relevent mainly for single choice questions.
Returns the text of the answer that was coded in inQuesIdx.
| |
SelectedAnswerText(Int32, Boolean) |
Relevent mainly for single choice questions.
Returns the text of the answer that was coded in inQuesIdx. If inUseOtherSpecText = true, and the selected answer of inQuesIdx was "Other Specify", Returns the additional text entered for that answer.
| |
SelectedAnswerTextIter(Int32, Int32) |
Relevent mainly for single choice questions, that were included inside a loop chapter.
Returns the text of the answer that was coded in inQuesIdx, during iteration inIter.
| |
SelectedAnswerTextIter(Int32, String) |
Relevent mainly for single choice questions, that were included inside a loop chapter. Returns the text of the answer that was coded in inQuesIdx, during a specific nested loops iterations state.
| |
SelectedAnswerTextIter(Int32, Int32, Boolean) |
Relevent mainly for single choice questions, that were included inside a loop chapter.
Returns the text of the answer that was coded in inQuesIdx, during iteration inIter. If inUseOtherSpecText = true, and the selected answer of inQuesIdx during iteration inIter was "Other Specify", Returns the additional text entered for that answer.
| |
SelectedAnswerTextIter(Int32, String, Boolean) |
Relevent mainly for single choice questions, that were included inside a loop chapter. Returns the text of the answer that was coded in inQuesIdx, during a specific nested loops iterations state.
If inUseOtherSpecText = true, and the selected answer of inQuesIdx during iterations state inIter was "Other Specify", Returns the additional text entered for that answer.
| |
SetAnswer |
Relevant for all question types.
Sets the value of an answer/answers in question inQuesIdx with inValues.
If the question is of type Multiple Selection or a grid (Single Choice Grid, Numeric Grid etc) it will set the relevant answers with the corresponding values in inValues.
First answer will be set with the first value, second answer will be set with the second value etc.
| |
SetAnswerChoice |
It will set the relevant answers in the specific topic with the corresponding values in inValues
| |
SetAnswerChoiceIter(Int32, Int32, Int32, DVar) |
It will set the relevant answers in the specific topic and in a specific iteration with the corresponding values in inValues
| |
SetAnswerChoiceIter(Int32, Int32, String, DVar) |
This function sets the relevant answers inValues in the specific topic inTopic, in a specific nested loops iterations state.
| |
SetAnswerCode |
This function's set's a special code in a Numeric\Open-Ended Question
| |
SetAnswerCodeIter(Int32, String, Int32) |
This function's set's a special code in a Numeric\Open-Ended Question within a loop with a given iteration
| |
SetAnswerCodeIter(Int32, String, String) |
This function's set's a special code in a Numeric\Open-Ended Question within a nested loop.
| |
SetAnswerIter(Int32, Int32, DVar) |
Relevant for all question types that are part of an iteration.
Sets the value of an answer/answers in question inQuesIdx with inValues in the specific inIter iteration.
If the question is of type Multiple Selection or a grid (Single Choice Grid, Numeric Grid etc) it will set the relevant answers with the corresponding values in inValues.
First answer will be set with the first value, second answer will be set with the second value etc.
| |
SetAnswerIter(Int32, String, DVar) |
Relevant for all question types that are part of an iteration. Sets the value of an answer/answers in question inQuesIdx with inValues in the specific nested loops iterations state.
If the question is of type Multiple Selection or a grid (Single Choice Grid, Numeric Grid etc) it will set the relevant answers with the corresponding values in inValues. First answer will be set with the first value, second answer will be set with the second value etc.
| |
SetAnswerMatchByCoding(Int32, Int32) | ||
SetAnswerMatchByCoding(Int32, Int32, Boolean, Boolean) | ||
SetAnswerText |
Relevant for multi\single mention question types.
Will change the header text of an answer.
| |
SetAnswerTextFormat |
Relevant for multi/single mention question types.
Will set a text object by using piping methods into one place holder or more in the relevant answer
| |
SetAnswerVisible(Int32, Boolean) |
Relevant mainly for Questions that have no topics included. For those use SetTopicVisible
Hides all the answers inQuesIdx if the inShow is false or shows it if true
| |
SetAnswerVisible(Int32, Int32, Boolean) |
Relevant mainly for Questions that have no topics included. For those use SetTopicVisible
Hides answer inAnswerIdx in question inQuesIdx if the inShow is false or shows it if true
| |
SetAnswerVisible(Int32, Boolean, Boolean, Int32) |
Relevant mainly for Questions that have no topics included. For those use SetTopicVisible
This function hides or shows the answers in inArray based on the inShow value. false will hide them and true will make them visible.
The inReset will perform the comlimentary action to inShow to all answers if set to true:
if inShow is set to true and inReset is set to true all answers will become hiden before the inArray ones are shown and vice versa.
| |
SetAnswerWithAdditional | Obsolete.
Relevant for all question types.
Sets the value of an answer/answers in question inQuesIdx with inValues including the value of the Other(Specify).
If the question is of type Multiple Selection or a grid (Single Choice Grid, Numeric Grid etc) it will set the relevant answers with the corresponding values in inValues.
First answer will be set with the first value, second answer will be set with the second value etc.
| |
SetAnswerWithAdditionalIter(Int32, Int32, String, DVar) | Obsolete.
Relevant for all question types.
Sets the value of an answer/answers in question inQuesIdx with inValues including the value of the Other(Specify)in the specific inIter iteration.
If the question is of type Multiple Selection or a grid (Single Choice Grid, Numeric Grid etc) it will set the relevant answers with the corresponding values in inValues.
First answer will be set with the first value, second answer will be set with the second value etc.
| |
SetAnswerWithAdditionalIter(Int32, String, String, DVar) | Obsolete.
Relevant for all question types. Sets the value of an answer/answers in question inQuesIdx with inValues including the value of the Other(Specify) in the specific nested loops iterations state.
If the question is of type Multiple Selection or a grid (Single Choice Grid, Numeric Grid etc) it will set the relevant answers with the corresponding values in inValues. First answer will be set with the first value, second answer will be set with the second value etc.
| |
SetAnswerWithAdditionalTexts |
Sets multiple answers with additional texts. Use CreateAnswerWithAdditional() to create AnswerWithAdditionalText objects.
| |
SetAnswerWithAdditionalTextsIter(Int32, Int32, AnswerWithAdditionalText) | ||
SetAnswerWithAdditionalTextsIter(Int32, String, AnswerWithAdditionalText) |
Sets multiple answers with additional texts. Use CreateAnswerWithAdditional() to create AnswerWithAdditionalText objects.
Only works for Multiple Selection questions
| |
SetChapterVisible | ||
SetExtraLabelText | ||
SetExtraLabelTextFormat | ||
SetInstructionsText | ||
SetInstructionsTextFormat | ||
SetMultiAnswersVisible(Int32, DVar, ItemVisibleRef) | This function will create Visibility conditions for answers
within a question according to an answer of another question, that will determine which topics are shown\hidden and when.
saving multiple re-writing of SetAnswerVisible() functions.
| |
SetMultiAnswersVisible(Int32, DVar, Boolean, ItemVisibleRef) | This function will create Visibility conditions for answers
within a question according to an answer of another question, that will determine which topics are shown\hidden and when.
saving multiple re-writing of SetAnswerVisible() functions.
| |
SetMultiAnswersVisible(Int32, DVar, Boolean, Boolean, ItemVisibleRef) |
This function will create Visibility conditions for answers
within a question according to an answer of another question, that will determine which topics are shown\hidden and when.
saving multiple re-writing of SetAnswerVisible() functions.
| |
SetMultiTopicsVisible(Int32, DVar, ItemVisibleRef) | This function will create Visibility conditions for topics
within a question according to an answer of another question, that will determine which topics are shown\hidden and when.
saving multiple re-writing of SetAnswerVisible() functions.
| |
SetMultiTopicsVisible(Int32, DVar, Boolean, ItemVisibleRef) | This function will create Visibility conditions for topics
within a question according to an answer of another question, that will determine which topics are shown\hidden and when.
saving multiple re-writing of SetAnswerVisible() functions.
| |
SetMultiTopicsVisible(Int32, DVar, Boolean, Boolean, ItemVisibleRef) | This function will create Visibility conditions for topics
within a question according to an answer of another question, that will determine which topics are shown\hidden and when.
saving multiple re-writing of SetAnswerVisible() functions.
| |
SetPageText |
Not In Use
| |
SetPageTextFormat |
Not In Use
| |
SetQuestionAnswerFontScalePercent | ||
SetQuestionFontScalePercent | ||
SetQuestionScored | ||
SetQuestionTopicFontScalePercent | ||
SetSelectedAnswerAdditionalText |
Sets additional text for a previously selected answer, without deleting other answers. Does nothing if the answer isn't selected.
| |
SetSelectedAnswerAdditionalTextIter(Int32, String, String, Int32) | ||
SetSelectedAnswerAdditionalTextIter(Int32, String, String, String) | ||
SetSubjectLocationID(Int32) | ||
SetSubjectLocationID(Int32, Int32) | ||
SetText |
Relevant for all question types.
Will change the body text of a question.
| |
SetTextFormat |
Relevant for all question types.
Will set a text object by using piping methods into one place holder or more in the relevant question body
| |
SetTopicText |
Relevant for grid questions only.
Will change the header text of the topic
| |
SetTopicTextFormat |
Relevant for grid questions only.
Will set a text object by using piping methods into one place holder or more in the relevant topic
| |
SetTopicVisible(Int32, Boolean) |
Relevant mainly for Questions that have topics included.
Hides all the topics inQuesIdx if the inShow is false or shows them if true
| |
SetTopicVisible(Int32, Int32, Boolean) |
Relevant mainly for Questions that have topics included.
Hides the topic inTopicIdx in question inQuesIdx if the inShow is false or shows it if true
| |
SetTopicVisible(Int32, Boolean, Boolean, Int32) |
Relevant mainly for Questions that have topics included.
This function hides or shows the topics in inArray based on the inShow value. false will hide them and true will make them visible.
The inReset will perform the complimentary action to inShow to all topics if set to true:
if inShow is set to true and inReset is set to true all topics will become hiden before the inArray ones are shown and vice versa.
| |
ShowInterviewSummary | ||
Sleep | ||
SnapPicture | ||
SortAnswers(Int32) |
The function sorts the answers by lexicographical order from A-Z
| |
SortAnswers(Int32, Boolean) |
The function sorts the answers by lexicographical order from Z-A
| |
SortTopics(Int32) |
The function sorts the topic by lexicographical order from A-Z
| |
SortTopics(Int32, Boolean) |
The function sorts the topic by lexicographical order from Z-A
| |
StartFrontFacingCameraAttachment(String, String, Int64) | ||
StartFrontFacingCameraAttachment(String, String, Boolean, Int64) | ||
StartFrontFacingCameraLocalPath(String, String, Int64) | ||
StartFrontFacingCameraLocalPath(String, String, Boolean, Int64) | ||
StartIntent | ||
StopS | ||
StoreFunc | ||
stringCompare(String, String) | ||
stringCompare(String, String, Boolean) | ||
stringContains(String, String) |
Determines whether or not string inPart contained in string inFull
| |
stringContains(String, String, Boolean) |
Determines whether or not string inPart contained in string inFull
| |
stringFormat | ||
stringIndexOf |
Returns the (zero-based) index in string inFull of the first occurance of string inPart
| |
stringJoin |
Concatenates several strings in inArray into one string, joined be inSeperator.
| |
stringReplace |
Replace string inFind contained inside string inString, with the string inReplace
| |
stringSplit |
Split the string inString into several pieces, separated by inSeperator. all instances of inSeperator are removed.
| |
StringToIntArray |
Will turn a string in a specific format, to an Integer array.
| |
stringToLower |
Returns the string inA, containing just lower-case letters.
| |
stringToUpper |
Returns the string inA, containing just upper-case letters.
| |
stringTrim |
Trim all white-space characters from the start and end of inA string
| |
SubjectProp | ||
SubjectPropEquals | ||
SumMulti(Int32) |
Valid for a Numeric Grid type questions. The function calculates the sum on a specific question
| |
SumMulti(Int32, Int32) |
Valid for a Numeric Grid type questions. The function calculates the sum with an offset on a specific question
| |
SumMulti(Int32, Int32, Int32) |
Valid for a Numeric Grid type questions. The function calculates the sum with an offset on a specific question
| |
TimeDiffDays | ||
TimeDiffHours | ||
TimeDiffMilliSeconds | ||
TimeDiffMinutes | ||
TimeDiffMonths | ||
TimeDiffSeconds | ||
TimeDiffYears | ||
ToArrayT | ||
ToDVarT | ||
TopicText |
Relevant only for Grid question types
Gets and index of a question and an index of a topic and returns its text
| |
Trace | ||
TryGetSerial | ||
TVPosRef | ||
TVRef | ||
UpdateTOC | ||
VarName | ||
VRef | ||
WebServiceGet | ||
WebServicePost | ||
WriteFileText(String, String) | ||
WriteFileText(String, String, Boolean) |
This function writes the given text inText into a file created and saved on the device / PC, with the option to attach the file to the interview as an attachment.
As the function is Asynchronous, when the file is actually written the callback function void OnWriteFileTextResult(String inFileName, bool inSuccess, bool inAppended)) is called
and it includes the filename, success (read or not) and in this case the inAppended will be returned as false.
You need to override it in your Advanced Scripts to perform what you need in case of failure.
|