|
You need to set this property to false to allow your users build expressions visually only, without editing them in text editor.
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set this property to false to disable pages adding, editing and deleting
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set JSON as text into survey. Clear undo/redo states optionally.
- Type:
-
(value: string, clearState?: boolean) => void
- Parameters:
-
value, type: string
, JSON as text
clearState, type: boolean
, default false. Set this parameter to true to clear undo/redo states.
- Implemented in:
-
CreatorBase
|
|
Delete an element in the survey. It can be a question, a panel or a page.
- Type:
-
(element: Base) => void
- Parameters:
-
element, type: Base
, a survey element.
- Implemented in:
-
CreatorBase
|
|
Copy a question to the active page
- Type:
-
(question: Base) => void
- Parameters:
-
question, type: Base
, A copied Survey.Question
- Implemented in:
-
CreatorBase
|
|
Returns the localized string by its id
- Type:
-
(str: string) => any
- Parameters:
-
str, type: string
, the string id.
- Implemented in:
-
CreatorBase
|
|
This callback is used internally for providing survey JSON text.
- Type:
-
() => { text: string; isModified: boolean; } readonly
- Implemented in:
-
CreatorBase
|
|
You have right to set this property to true if you have bought the commercial licence only.
It will remove the text about non-commerical usage on the top of the widget.
Setting this property true without having a commercial licence is illegal.
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
- See also:
-
haveCommercialLicense
|
|
A boolean property, false by default. Set it to true to call protected doSave method automatically on survey changing.
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
Set it to true to activate RTL support
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
The Survey JSON. Use it to get Survey JSON or change it.
- Type:
-
any writable
- Implemented in:
-
CreatorBase
- See also:
-
text
|
|
Change the active view/tab. It will return false if it can't change the current tab.
- Type:
-
(viewName: string) => boolean
- Parameters:
-
viewName, type: string
, name of new active view (tab). The following values are available: "designer", "editor", "test", "embed" and "translation".
- Implemented in:
-
CreatorBase
|
|
maximumColumnsCount
property
|
|
You need to set this property to number more than 0 to limit the number of columns that users can create for matrix dynamic/matrix dropdown questions.
- Type:
-
number readonly
- Implemented in:
-
CreatorBase
|
|
You need to set this property to value bigger than 0 to disable adding more logic items in condition than this value.
- Type:
-
number readonly
- Implemented in:
-
CreatorBase
|
|
onCanDeleteItem
event
|
|
The event is called before rendering a delete button in the Property Grid or in Question Editor.
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
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
Obsolete, please use onShowingProperty event.
The event is called before showing a property in the Property Grid or in 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 Property Grid or in 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.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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.
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
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
- See also:
-
showObjectTitles
|
|
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.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
onMatrixColumnAdded
event
|
|
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.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
- See also:
-
onPropertyValueChanging
|
|
Use this event to change the value entered in the property editor. You may call a validation, so an end user sees the error immediately
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.newValue set the corrected value into this property. Leave it null if you are ok with the entered value.
options.doValidation set the value to true to call the property validation. If there is an error, the user sees it immediately.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
- See also:
-
onPropertyValidationCustomError
|
|
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 "Fast Entry" tab for "choices" property.
options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Fast Entry" tab for "choices" property by default.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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.
Example: Hide a category in the Properties Grid
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
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 "Test Survey" tab and "conditionEditor", "defaultValueEditor", "restfulEditor" - surveys for different property editors.
- Type:
-
Event<(sender: CreatorBase<T>, options: any) => any, any>
- Implemented in:
-
CreatorBase
|
|
A boolean property, false by default. Set it to true to deny editing.
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
This callback is used internally for setting survey JSON text.
- Type:
-
(text: string) => void readonly
- Implemented in:
-
CreatorBase
|
|
The default value is "auto". It shows the language selector if there are more than two languages are using in the survey.
It shows only used languages in the survey.
Set this property to false to hide the default language selector in the Test Survey Tab.
Set it to true to show this selector even if there is only one language in the survey
Set it to all to show the selector with all available languages (30+)
- Type:
-
string | boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set it to true to show "JSON Editor" tab and to false to hide the tab
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
Set it to true to show "Embed Survey" tab and to false to hide the tab
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
Set it to false to suppress an alert message about error on saving the survey into database.
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set this property to false to hide the show invisible element checkbox in the Test Survey Tab
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set it to true to show "JSON Editor" tab and to false to hide the tab
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
Set it to true to show "Logic" tab and to false to hide the tab
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
You need to set this property to true if you want to show titles instead of names in pages editor and object selector.
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
- See also:
-
onShowObjectDisplayName
|
|
Set this property to true if you want to show "page selector" in the toolabar instead of "pages editor"
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set this property to false to hide the pages selector in the Test Survey Tab
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set this property to false to hide the device simulator in the Test Survey Tab
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set it to true to show "Test Survey" tab and to false to hide the tab
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
You need to set this property to true if you want to show titles instead of names in expression editor.
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|
|
Set it to true to show "Translation" tab and to false to hide the tab
- Type:
-
boolean writable
- Implemented in:
-
CreatorBase
|
|
The editing survey object (Survey.Survey)
- Type:
-
T readonly
- Implemented in:
-
CreatorBase
|
|
The Survey JSON as a text. Use it to get Survey JSON or change it.
- Type:
-
string writable
- Implemented in:
-
CreatorBase
- See also:
-
JSON
|
|
You need to set this property to true if you want to use tabs instead of accordion in the popup element's editor.
- Type:
-
boolean readonly
- Implemented in:
-
CreatorBase
|