ActionArguments Class

An extension can set ApplyChanges to have the property values of the survey object updated (based on changes to .PropertyValues) and optionally complete the workflow step.

System names of the properties that has been changed. Important: only properties that has been changed *before* the action handler was called are present. Hence, if the action handler makes changes to PropertyValues then the changed properties are not immediately reflected in ChangedProperies.

The type of event that caused the action.

Property values of the survey object (considering the changes made during the survey). See InitialPropertyValues for a description of the data types. Tip: use the GetPropertyValue method for easy access to the property values.

Initial property values of the survey object at the time when the survey was initiated. Keys in the dictionary are property system names. Values are collections of property values. Each value for a property is either a: string (VP datatype text, hyperlink, xml), integer (VP datatype integer, RP, SP), boolean (VP datatype bool), TimeSpan (VP datatype TimeSpan), double (VP datatype decimal) or DateTime (VP datatype DateTime). The result for value property will always contain zero or one value. The result for set- and reference-properties can contain zero, one or multiple values. For set- and reference-properties the value ids are returned (set property value ids or data object ids). Tip: use the GetPropertyValue method for easy access to the property values.

Is true if it is a parent/child survey and the survey object has a parent

Log entries describing who changed which properties and when on the survey object. Tip: can also be accessed with GetMostRecentLogEntry().

Action arguments for performing action on parent survey object (if any). Is only populated if parent and child survey objects are submitted in the same call.

Source key of the parent object if the object is a child. Is null if the survey object is parent

Current property values of the survey object (considering the changes made during the survey). Tip: if changes are made to PropertyValues and the survey object should be updated accordingly then remember to set ApplyChanges=true.

Contains info about the previus and current workflow steps. Note: RoutingInfo is null if EventType==SurveyCloses.

It skips the survey required fields validation when it is true. This flag is set true when a survey is set ApplyChangesAndCompleteStep from the PostActionHandler.

Source key of the survey object to perform post actions on.

Id of the survey that the survey object has been processed in.

Has all (relevant) workflow steps been completed for the survey object? WorkflowCompleted is false if: * The action is being executed as a result of survey being prematurely closed. * The action is configured to run after every step and the step that has just completed isn't the final one for the object.

Log entries describing who completed which workflow steps and when on the survey object. Is empty if the survey object hasn't completed any steps.

Applies the changes made to the survey object during the survey to a data object. Important: only changes made *before* the action handler was called are applied. Hence, if the action handler makes changes to PropertyValues then those changes are not applied by the method. The data object is not saved to the database!

Utility method for converting an object uid to an id (of for example a data object or property etc.).

Utility method for converting an object id to an uid (of for example a data object or property etc.).

Get most recent log entry for a property. Returns null if no entries can be found.

Utility method for easy retrieval of a single property value from either InitialPropertyValues or FinalPropertyValues.

Converts object to boolean.

Converts object to DateTime.

Converts object to integer.