Get/set the active tab. The following values are available: "designer", "editor", "test", "embed", "logic" and "translation". Please note, not all tabs are visible.

Specifies whether users can switch between UI themes in the Preview tab.

Default value: true

View the "Switch Between Themes" demo

Specifies whether users can edit expressions in the Logic tab as plain text.

If you set this property to false, users can only use UI elements to edit logical expressions.

Default value: true

Obsolete. Use the showSurveyTitle property instead.

Specifies whether users can add, edit, and delete survey pages.

Default value: true

The delay on saving survey JSON on autoSave in ms. It is 500 ms by default. If during this period of time an end-user modify survey, then the last version will be saved only. Set to 0 to save immediately.

Set JSON as text into survey. Clear undo/redo states optionally.

Open file chooser dialog

Expand all property editor tabs (categories) in properties panel/grid

Collapse certain property editor tab (category) in properties panel/grid name - tab category name

Create a new page with the same elements and place it next to the current one. It returns the new created Survey.Page

Delete a currently selected element in the survey. It can be a question, a panel or a page.

Delete an element in the survey. It can be a question, a panel or a page.

Expand all property editor tabs (categories) in properties panel/grid

Expand certain property editor tab (category) in properties panel/grid name - tab category name

Copy a question to the active page

Returns the localized string by its id

This callback is used internally for providing survey JSON text.

Removes the Free Trial bar.

Default value: false

IMPORTANT: You can enable this property only if you have a Survey Creator commercial license. It is illegal to enable this property without a license.

You need to set this property to true if you want to inplace edit item values instead of texts.

Specifies whether to call the saveSurveyFunc each time survey settings are changed.

Default value: false

Return true if Preview tab is currently active

Returns true if Creator is currently doing undo or redo opertaions

Specifies whether to enable support for right-to-left languages.

Default value: false

The Survey JSON. Use it to get Survey JSON or change it.

Gets or sets the survey locale. The default value it is empty, this means the 'en' locale is used. You can set it to 'de' - German, 'fr' - French and so on.

Change the active view/tab. It will return false if it can't change the current tab.

Limits the number of choices that users can add to Checkbox, Dropdown, and Radiogroup questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maximumChoicesCount)

Limits the number of columns that users can add to Matrix, Matrix Dynamic, and Matrix Dropdown questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maximumColumnsCount)

Limits the number of rate value that users can add to Rating questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maximumRateValues)

Limits the number of rows that users can add to Matrix and Matrix Dropdown questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maximumRowsCount)

Limits the number of items in a logical expression.

Default value: -1 (unlimited)

Limits the number of visible choices. Users can click "Show more" to view hidden choices.

Set this property to -1 if you do not want to hide any choices.

Default value: 10

This function triggers user notification (via the alert() function if no onNotify event handler added).

The event is called when creator active tab is changed.

• sender the survey creator object that fires the event
• options.tabName the name of new active tab

The event is called when creator is going to change the active tab.

• sender the survey creator object that fires the event
• options.tabName the name of new active tab

The event is called after redo happens.

• options.state is an undo/redo item.

The event is called after undo happens.

• options.state is an undo/redo item.

The event is called before redo happens.

• options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.

The event is called before undo happens.

• options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.

The event is called before rendering a delete button in the Property Grid or in Question Editor. Obsolete, please use onCollectionItemAllowOperations

• sender the survey creator object that fires the event
• options.obj the survey Question
• options.item the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
• options.canDelete a boolean value. It is true by default. Set it false to remove delete button from the Property Grid or in Question Editor

The event is called before rendering a collection item from the Property Editor. For example: column in columns editor or item in choices and so on. You can make detail/edit and remove buttons invsible and/or disable editing.

• sender the survey creator object that fires the event
• options.obj the survey object: Question, Panel, Page or Survey
• options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
• options.propertyName the collection property name
• options.collection the editing collection where deleting item is located. It is can be columns in the matrices or choices in dropdown question and so on.
• options.item the collection item that we are going to delete
• options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
• options.allowEdit a boolean value. It is true by default. Set it false to disable editing.

The event is called on deleting a collection item from the Property Editor. For example: column in columns editor or item in choices and so on. Obsolete, please use onCollectionItemAllowOperations

• sender the survey creator object that fires the event
• options.obj the survey object: Question, Panel, Page or Survey
• options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
• options.propertyName the collection property name
• options.collection the editing collection where deleting item is located. It is can be columns in the matrices or choices in dropdown question and so on.
• options.item the collection item that we are going to delete
• options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection

Use this event to modify the title in a condition editor. The title is changing during editing. In case of empty or incorrect expression it tells that expression is incorrect

• sender the survey creator object that fires the event.
• options.expression the current expression. If the expression is empty or incorrect then the value is empty.
• options.title the default value of the title. You can change the default value.

Use this event to modify the list (name and titles) of the questions available in a condition editor.

• sender the survey creator object that fires the event
• options.obj the survey object which property is edited in the Property Editor.
• options.propertyName the name of the edited property.
• options.editor the instance of Property Editor.
• options.list the list of the questions available for condition

Use this event to add/remove/modify the element (question/panel) menu items.

• sender the survey creator object that fires the event
• options.obj the survey object which property is edited in the Property Editor.
• options.items the list of menu items. It has two required fields: text and onClick: function(obj: Survey.Base) and optional name field.

The event is fired when the survey creator is initialized and a survey object (Survey.Survey) is created.

• sender the survey creator object that fires the event
• options.survey the survey object showing in the creator.

Use this event to control drag&drop operations.

• sender the survey creator object that fires the event.
• options.survey the editing survey object.
• options.allow set it to false to disable dragging.
• options.target a target element that is dragging.
• options.source a source element. It can be null, if it is a new element, dragging from toolbox.
• options.parent a page or panel where target element is dragging.
• options.insertBefore an element before the target element is dragging. It can be null if parent container (page or panel) is empty or dragging an element under the last element of the container.
• options.insertAfter an element after the target element is dragging. It can be null if parent container (page or panel) is empty or dragging element to the top of the parent container.

Use this event to disable user interactions with a question or panel on the design surface.

The event handler accepts the following arguments:

• sender- A Survey Creator instance that raised the event.
• options.obj - A survey element instance (question or panel) for which you can disable user interactions.
• options.allowAddToToolbox - Allows users to save the current survey element configuration in the Toolbox.
• options.allowChangeRequired - Allows users to make the survey element required.
• options.allowChangeType - Allows users to change the survey element type.
• options.allowCopy - Allows users to duplicate the survey element.
• options.allowDelete - Allows users to delete the survey element.
• options.allowDragging - Allows users to drag and drop the survey element.
• options.allowEdit - Allows users to edit survey element properties on the design surface. If you disable this property, users can edit the properties only in the Property Grid.

To disable a user interaction, set the correponding allow... property to false.

The event is called on deleting an element (question/panel/page) from the survey. Typically, when a user click the delete from the element menu.

• sender the survey creator object that fires the event
• options.element an instance of the deleting element
• options.elementType the type of the element: 'question', 'panel' or 'page'.
• options.allowing set it to false to cancel the element deleting

The event is called on generation a new name for a new created element.

• sender the survey creator object that fires the event
• options.element a new created survey element. It can be question, panel or page
• options.name a new suggested name, that is unique for the current survey. You can suggest your own name. If it is unique, creator will assign it to the element.
• options.isUnique a boolean property, set this property to false, if you want to ask Creator to generate another name

The event allows to display the custom name for objects: questions, pages and panels. By default the object name is using. You may show object title by setting showObjectTitles property to true. Use this event, if you want custom display name for objects.

• sender the survey creator object that fires the event
• options.obj the survey object, Survey, Page, Panel or Question
• options.reason the name of the UI that requests the object display name.
• options.displayName change this property to show your custom display name for the object

The list of possible values in options.reason:

• "condition" - raised from Condition modal window or on setup condition in a logic tab
• "survey-tester" - raised from page selector list in "Preview" tab
• "survey-tester-selected" - raised on setting page selector title in "Preview" tab
• "survey-translation" - raised from translation tab
• "property-editor" - raised on showing question property editor, for example "gotoName". It is raised for all elements (questions) in the dropdown.
• "property-grid" - raised from showing object selector for property grid in "Designer" tab.
• "property-grid-title" - raised on rendering selected object title in property grid in "Designer" tab.

The event is called on setting a readOnly property of the property editor. By default the property.readOnly property is used. You may changed it and make the property editor read only or enabled for a particular object.

• sender the survey creator object that fires the event
• options.obj the survey object, Survey, Page, Panel or Question
• options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
• options.readOnly a boolean value. It has value equals to options.readOnly property by default. You may change it.
• options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
• options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.

This event is raised after a user has edited a text value on the design surface. This value may include HTML markup. You can handle the onHtmlToMarkdown event to convert the HTML markup to Markdown.

The event handler accepts the following arguments:

• sender - A Survey Creator instance that raised the event.
• options.element - The instance of a survey element (survey, page, panel, question) that the user configures.
• options.name - The name of a property whose value has been edited.
• options.html - HTML content. Pass this field's value to an HTML-to-Markdown converter.
• options.text - A text string that may contain Markdown. Assign the result of the HTML-to-Markdown conversion to this field.

The event is called on adding a new Survey.ItemValue object. It uses as an element in choices array in Radiogroup, checkbox and dropdown questions or Matrix columns and rows properties. Use this event, to set ItemValue.value and ItemValue.text properties by default or set a value to the custom property.

• sender the survey creator object that fires the event
• options.obj the object that contains the itemsValues array, for example selector, rating and single choice matrix questions.
• options.propertyName the object property Name. It can be "choices" for selector questions or rateValues for rating question or columns/rows for single choice matrix.
• options.newItem a new created Survey.ItemValue object.
• options.itemValues an editing Survey.ItemValue array. newItem object is not added yet into this array.

Use this event to modify the display text of a logic item in the Logic tab.

The event handler accepts the following arguments:

• sender - A Survey Creator instance that raised the event.
• options.expression - A logical expression associated with the logic item.
• options.expressionText - The same expression in a user-friendly format. It may contain question titles instead of question names.
• options.logicItem - A logic item object. Contains an array of actions and other properties.
• options.text - The expression and actions in a user-friendly format. Redefine this property if you want to change the display text.

The event is called when a user adds a new column into MatrixDropdown or MatrixDynamic questions. Use it to set some properties of Survey.MatrixDropdownColumn by default, for example name or a custom property.

• sender the survey creator object that fires the event
• options.matrix a matrix question where column is located, matrix.columns.
• options.newColumn a new created Survey.MatrixDropdownColumn object.
• options.columns editable columns objects. They can be different from options.matrix.columns. options.columns and options.matrix.columns are equal after user press Apply or Cancel and options.columns will be set to options.matrix.columns or reset to initial state.

The event is called when a survey is changed in the designer. A new page/question/page is added or existing is removed, a property is changed and so on.

• sender the survey creator object that fires the event options object contains the information about certain modifications

• options.type contains string constant describing certain modification Available values:

• options.type: "ADDED_FROM_TOOLBOX"

• options.question: newly added question

• options.type: "PAGE_ADDED"

• options.newValue: newly created page

• options.type: "PAGE_MOVED"

• options.page: page has been moved

• options.indexFrom: pevious index

• options.indexTo: new index

• options.type: "QUESTION_CONVERTED"

• options.className: the converted class name

• options.oldValue: pevious object

• options.newValue: the new object, converted from oldVale to the given class name

• options.type: "QUESTION_CHANGED_BY_EDITOR"

• options.question: question has been edited in the popup question editor

• options.type: "PROPERTY_CHANGED"

• options.name: the name of the property has been changed

• options.target: the object containing the changed property

• options.oldValue: the previous value of the changed property

• options.newValue: the new value of the changed property

• options.type: "OBJECT_DELETED"

• options.target: deleted object

• options.type: "VIEW_TYPE_CHANGED"

• options.newType: new type of the creator view: editor or designer

• options.type: "DO_DROP"

• options.page: the page of the drap/drop operation

• options.source: the source dragged object

• options.target: the drop target

• options.newElement: a new element. It is defined if a user drops question or panel from the toolbox

• options.type: "TRANSLATIONS_CHANGED"

• options.type: "JSON_EDITOR"

The event is called in case of UI notifications. By default all notifications are done via built-in alert () function. In case of any subscriptions to this event all notifications will be redirected into the event handler.

• options.message is a message to show.

The event is fired then one need to choose files.

• sender the survey creator object that fires the event input file input HTML element callback need to be called after files has been chosen

The event is called on adding a new page into the survey.

• sender the survey creator object that fires the event
• options.page the new survey Page object.

The event is called on adding a new panel into the survey. Typically, when a user dropped a Panel from the Question Toolbox into designer Survey area.

• sender the survey creator object that fires the event
• options.panel a new added survey panel. Survey.Panel object
• options.page the survey Page object where question has been added.

The event is fired when the survey creator creates survey in Preview tab for testing.

• sender the survey creator object that fires the event
• options.survey the survey object showing in the "Preview" tab.

The event is called after a property editor (in fact a survey question) has been created and all it's properties have been assign. You can use this event to modify the property editor properties or set event handlers to customize it's behavior

• options.obj the survey object that is currently editing in the property grid
• options.property the property that the current property editor is editing
• options.editor the property editor. In fact it is a survey question. We are using a heavily customizable survey as a property grid in Creator V2. It means that every property editor is a question.

The event is called after a property editor setups its title actions. You can use this event to modify the property editor title actions

• options.obj the survey object that is currently editing in the property grid
• options.property the property that the current property editor is editing
• options.editor the property editor. In fact it is a survey question. We are using a heavily customizable survey as a property grid in Creator V2. It means that every property editor is a question.
• options.titleActions the list of title actions.

The event is called after a survey that represents the Property Grid is created and all its questions (property editors) are setup. You can use this event to modify this survey to change the property grid behavior

• options.obj the survey object that is currently editing in the property grid
• options.survey the property grid survey

Use this event to show a custom error in the Question Editor on pressing Apply or OK buttons, if the values are not set correctly. The error will be displayed under the property editor.

• sender the survey creator object that fires the event
• options.obj the survey object which property is edited in the Property Editor.
• options.propertyName the name of the edited property.
• options.value the property value.
• options.error the error you want to display. Set the empty string (the default value) or null if there is no errors.

An event that is raised each time a user edits a survey object property. Use this event to correct or validate the property value while the user enters it.

The event handler accepts the following arguments:

• sender- A Survey Creator instance that raised the event.
• options.obj - A survey object instance (question or panel) whose property is being edited.
• options.propertyName - The name of the property.
• options.value - A property value entered by a user.
• options.newValue - A corrected property value. Specify this field if you want to override the options.value.
• options.doValidation - Enable this field to validate the property value while the user enters it.

The event is called on adding a new question into the survey. Typically, when a user dropped a Question from the Question Toolbox into designer Survey area.

• sender the survey creator object that fires the event
• options.question a new added survey question. Survey.Question object
• options.page the survey Page object where question has been added.

The event is called after the selected element is changed.

• options.newSelectedElement the new selected element in the survey desiger: question, panel, page or survey.

The event is called on changing the selected element. You may change the new selected element by changing the property options.newSelectedElement to your own

• options.newSelectedElement the element that is going to be selected in the survey desiger: question, panel, page or survey.

Use this event to control Property Editors UI.

• sender the survey creator object that fires the event
• options.obj the survey object which property is edited in the Property Editor.
• options.propertyName the name of the edited property.
• options.editorOptions options that can be changed.
• options.editorOptions.allowAddRemoveItems a boolean property, true by default. Set it false to disable add/remove items in array properties. For example 'choices', 'columns', 'rows'.
• options.editorOptions.allowRemoveAllItems a boolean property, true by default. Set it false to disable remove all items in array properties. For example 'choices', 'columns', 'rows'.
• options.editorOptions.showTextView a boolean property, true by default. Set it false to disable "Manual Entry" tab for "choices" property.
• options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Manual Entry" tab for "choices" property by default.

The event is called before showing a property in the Properties Grid or in the Question Editor.

• sender the survey creator object that fires the event
• options.obj the survey object, Survey, Page, Panel or Question
• options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
• options.canShow a boolean value. It is true by default. Set it false to hide the property from the Properties Grid and in the Question Editor.
• options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
• options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.

Example: Hide a category in the Properties Grid

The event is fired when the survey creator creates a survey object (Survey.Survey).

• sender the survey creator object that fires the event
• options.survey the survey object showing in the creator.
• options.reason indicates what component of the creator requests the survey. There are several reason types: "designer" - survey for designer survey, "test" - survey for "Preview" tab and "conditionEditor", "defaultValueEditor", "restfulEditor" - surveys for different property editors.

An event that is raised after a property in a survey object has changed.

• sender- A Survey Creator instance that raised the event.
• options.obj - A survey object instance (question or panel) whose property has changed.
• options.propertyName - The name of the property.
• options.value - A new property value.

Obsolete. Please use onPreviewSurveyCreated event.

The method is called when the translation from csv file is imported.

Use this event to modify the imported localizable text. To block importing a particular localization text, set the options.text into undefined.

The event handler accepts the following arguments:

• sender - A Survey Creator instance that raised the event.
• options.locale - the locale name, like 'en', 'de' and so on.
• options.name - The full name of the localizable string, it can be: "survey.page1.question2.title"
• options.text - The imported text for the locale for this item. Set it to undefined or empty string to block importing for this item

Use this event to define is the locale initially selected (default value) and ready for translaion or it is unselected.

The event handler accepts the following arguments:

• sender - A Survey Creator instance that raised the event.
• options.locale - the locale name, like 'en', 'de' and so on.
• options.isSelected - it is true by default. Set it to false to make the translation unselected.

Use this event to modify the list of the strings available in the Translation tab.

The event handler accepts the following arguments:

• sender - A Survey Creator instance that raised the event.
• options.obj - A survey object instance (survey, page, panel, question) whose string translations are being edited in the Translation tab.
• options.propertyName - The name of a property being translated.
• options.visible - A Boolean value that specifies the property visibility. Set it to false to hide the property.

The event is fired on uploading the files.

• sender the survey creator object that fires the event There are two properties in options: files the Javascript File objects array callback called on upload complete, which takes two string arguments: a status and an image link

Contains the value of the pageEditMode property specified in the constructor.

Set delay for page hover

Enables the read-only mode. If you set this property to true, users cannot change the initial survey configuration.

Default value: false

This method performs redo uperation if possible.

Assign to this property a function that will be called on clicking the 'Save' button or on any change if isAutoSave equals true.

Get or set the current selected object in the Creator. It can be a question, panel, page or survey itself.

This callback is used internally for setting survey JSON text.

Specifies whether the Preview tab displays the language selector.

Accepted values:

• "auto" (default)
  Display the language selector only if the survey is translated into more than one language.

• true
  Always display the language selector regardless of how many languages are used in the survey.

• false
  Never display the language selector.

• "all"
  Always display the language selector with all supported languages.

See also: Localization & Globalization

Obsolete. Use the showDefaultLanguageInPreviewTab property instead.

Specifies whether to display the Designer tab.

Default value: true

Specifies whether to display the Embed Survey tab.

Default value: false

Specifies whether to show an error message if a survey is not saved in the database.

Default value: true

Returns the current show view name. The possible returns values are: "designer", "editor", "test", "embed", "logic" and "translation".

Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.

Default value: true

Obsolete. Use the showInvisibleElementsInPreviewTab property instead.

Specifies whether to display the JSON Editor tab.

Default value: true

Specifies whether to display the Logic tab.

Default value: false

Specifies whether UI elements display survey, page, and question titles instead of their names.

Default value: false

Set this property to true if you want to show "page selector" in the toolabar instead of "pages editor"

Specifies whether to show the page selector at the bottom of the Preview tab.

Default value: true

Obsolete. Use the showPagesInPreviewTab property instead.

Show Preview tab

Specifies whether to display the Preview tab.

Default value: true

Set this this property grid false to hide the property grid.

Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.

Default value: true

Obsolete. Use the showSimulatorInPreviewTab property instead.

Specifies whether users can see and edit the survey title and related survey properties.

Default value: true

Obsolete. Please use showPreviewTab property

Specifies whether to display question titles instead of names when users edit logical expressions.

Default value: false

Specifies whether to display the Translation tab.

Default value: false

This method starts undo/redo transaction: all changes will be stored as one undo/redo item.

Returns the creator state. It may return empty string or "saving" and "saved".

This method stops undo/redo transaction.

The editing survey object (Survey.Survey)

The Survey JSON as a text. Use it to get Survey JSON or change it.

A UI theme used to display the survey in the Preview tab.

Accepted values: "modern", "default", "defaultV2"

Default value: "defaultV2"

This method performs undo uperation if possible.

Upload the files on a server

Check for errors in property grid and adorners of the selected elements. Returns true if selected element is null or there is no errors.