survey-creator-core 1.9.125 → 1.9.127

package/typings/creator-base.d.ts

@@ -59,9 +59,6 @@ export declare class ToolbarActionContainer extends ActionContainer {
 export declare type toolboxLocationType = "left" | "right" | "sidebar";
 export declare class CreatorEvent extends EventBase<CreatorBase, any> {
 }
-/**
- * Base class for Survey Creator.
- */
 export declare class CreatorBase extends Base implements ISurveyCreatorOptions, ICreatorSelectionOwner, ILocalizableOwner {
     protected options: ICreatorOptions;
     getMarkdownHtml(text: string, name: string): string;
@@ -250,12 +247,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * A Boolean value that specifies the property's read-only status.
      */
     onGetPropertyReadOnly: CreatorEvent;
-    /**
-     * 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.
-     */
     onSurveyInstanceCreated: CreatorEvent;
     /**
      * An event that is raised when Survey Creator obtains a survey element name to display it in the UI.
@@ -285,15 +276,22 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     onGetObjectDisplayName: CreatorEvent;
     /**
-     * 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.
+     * An event that 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.
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.element`: `any`\
+     * The instance of a survey element (survey, page, panel, question) that the user configures.
+     * - `options.name`: `string`\
+     * The name of a property whose value has been edited.
+     * - `options.html`: `string`\
+     * HTML content. Pass this field's value to an HTML-to-Markdown converter.
+     * - `options.text`: `string`\
+     * A text string that may contain Markdown. Assign the result of the HTML-to-Markdown conversion to this field.
      */
     onHtmlToMarkdown: CreatorEvent;
     /**
@@ -323,6 +321,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * To disable a user interaction, set the correponding `allow...` property to `false`.
      *
      * [Specify Adorner Visibility](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#specify-adorner-availability (linkStyle))
+     * @see onCollectionItemAllowOperations
      */
     onElementAllowOperations: CreatorEvent;
     /**
@@ -365,96 +364,158 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     onShowingProperty: CreatorEvent;
     onCanShowProperty: CreatorEvent;
     /**
-     * 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
+     * An event that is raised when a [survey that represents the Property Grid](https://surveyjs.io/survey-creator/documentation/creator-v2-whats-new#survey-creator-ui-elements-are-surveys) is instantiated. Handle this event to customize the Property Grid by modifying the survey.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.object`: `any`\
+     * A survey element being edited in the Property Grid.
+     * - `options.survey`: [`SurveyModel`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model)
+     * A survey that respresents the Property Grid. Use the `SurveyModel` API to modify the survey.
+     * @see onPropertyEditorCreated
      */
     onPropertyGridSurveyCreated: CreatorEvent;
     /**
-      * 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.
-      */
+     * An event that is raised when a property editor is created in the Property Grid. Use this event to modify the property editor or add event handlers to it.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.editor`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * A property editor. It is an object of the [`Question`](https://surveyjs.io/form-library/documentation/question) type because the Property Grid is [built upon a regular survey](https://surveyjs.io/survey-creator/documentation/creator-v2-whats-new#survey-creator-ui-elements-are-surveys).
+     * - `options.property`: `JsonObjectProperty`\
+     * A property that corresponds to the created property editor.
+     * @see onSetPropertyEditorOptions
+     * @see onPropertyGridSurveyCreated
+     */
     onPropertyEditorCreated: CreatorEvent;
     /**
-     * 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.
+     * An event that is raised when title actions are added to a property editor. Title actions are most often used to reveal hints for properties configured by users. Handle this event you want to add, remove, or modify the title actions.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.object`: `any`\
+     * A survey element being edited in the Property Grid.
+     * - `options.editor`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * A property editor that contains the title actions. It is an object of the [`Question`](https://surveyjs.io/form-library/documentation/question) type because the Property Grid is [built upon a regular survey](https://surveyjs.io/survey-creator/documentation/creator-v2-whats-new#survey-creator-ui-elements-are-surveys).
+     * - `options.property`: `JsonObjectProperty`\
+     * A property that corresponds to the property editor.
+     * - `options.titleActions`: [`IAction[]`](https://surveyjs.io/form-library/documentation/api-reference/iaction)\
+     * A list of title actions.
      */
     onPropertyEditorUpdateTitleActions: CreatorEvent;
     /**
-     * An event that is raised before Survey Creator displays a pop-up window called from the Property Grid. This window allows users to edit choices, conditions, and so on.
-     *
-     * Use this event to customize the pop-up window, for example, add custom action buttons.
+     * An event that is raised before Survey Creator displays a pop-up window called from the Property Grid. This window allows users to edit choices, conditions, etc. Use this event to customize the pop-up window, for example, add custom action buttons.
      *
      * Parameters:
      *
-     * - `sender` - A Survey Creator instance that raised the event.
-     * - `options.obj` - An instance of a survey element (question or panel) that users are configuring in the Property Grid.
-     * - `options.property`- A `JsonObjectProperty` object with metadata about the property being edited.
-     * - `options.editor` - A property editor. It is an object of the [`Question`](https://surveyjs.io/form-library/documentation/question) type because the Property Grid is [built upon a regular survey](https://surveyjs.io/survey-creator/documentation/creator-v2-whats-new#survey-creator-ui-elements-are-surveys).
-     * - `options.popupEditor` - An editor inside the pop-up window.
-     * - `options.popupModel` - A `PopupBaseViewModel` object that describes the pop-up window model. Use `options.popupModel.footerToolbar` to access the actions at the bottom of the window.
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.obj`: `any`\
+     * The instance of a survey element (question or panel) that users are configuring in the Property Grid.
+     * - `options.property`: `JsonObjectProperty`\
+     * A property being edited.
+     * - `options.editor`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * A property editor. It is an object of the [`Question`](https://surveyjs.io/form-library/documentation/question) type because the Property Grid is [built upon a regular survey](https://surveyjs.io/survey-creator/documentation/creator-v2-whats-new#survey-creator-ui-elements-are-surveys).
+     * - `options.popupEditor`: `any`\
+     * An editor inside the pop-up window.
+     * - `options.popupModel`: `PopupBaseViewModel`\
+     * A pop-up window model. Use `options.popupModel.footerToolbar` to access the actions at the bottom of the window.
      */
     onPropertyGridShowModal: CreatorEvent;
     onCanDeleteItem: CreatorEvent;
     onCollectionItemDeleting: CreatorEvent;
     /**
-     * The event is called before rendering a collection item in a property editor. For example: a column in a column editor, or an item in Choices and so on.
-     * Use this event to prevent a collection item from being edited or removed from a collection.
-     *- 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 a collection where a target item is located. It is can be Columns in Matrices or Choices in Dropdown question and so on.
-     *- options.item a target collection item
-     *- options.allowDelete a boolean value. It is `true` by default. Set it false to prevent an item from being removed from the collection
-     *- options.allowAdd a boolean value. It is `true` by default. Set it false to prevent an item from being added to the collection
-     *- options.allowEdit a boolean value. It is `true` by default. Set it `false` to disable editing.
+     * An event that is raised when Survey Creator obtains permitted operations for a collection item (a choice option in Choices, a column or row in Columns, etc.). Use this event to prevent users from adding, deleting, or editing a particular collection item.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.obj`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A survey element (survey, page, panel, question) that contains the collection to which the target item belongs.
+     * - `options.property`: `JsonObjectProperty`\
+     * A property that contains the collection to which the target item belongs.
+     * - `options.propertyName`: `string`\
+     * The property's name: `columns`, `rows`, `choices`, `rateValues`, etc.
+     * - `options.collection`: [`Survey.Base[]`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * An array of collection items to which the target item belongs ([`columns`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#columns) or [`rows`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#rows) in matrix questions, [`choices`](https://surveyjs.io/form-library/documentation/api-reference/questionselectbase#choices) in select-based questions, etc.).
+     * - `options.item`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A target collection item.
+     * - `options.allowAdd`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to prevent the target item from being added to the collection.
+     * - `options.allowDelete`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to prevent the target item from being deleted.
+     * - `options.allowEdit`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to prevent the target item from being edited.
+     * @see onElementAllowOperations
      */
     onCollectionItemAllowOperations: CreatorEvent;
     /**
-      * 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.
-      */
+     * An event that is raised when users add a new collection item (a choice option to Choices, a column or row to Columns, etc.). Use this event to modify this item.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.obj`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A survey element (survey, page, panel, question) that contains the collection to which the target item belongs.
+     * - `options.property`: `JsonObjectProperty`\
+     * A property that contains the collection to which the target item belongs.
+     * - `options.propertyName`: `string`\
+     * The property's name: `columns`, `rows`, `choices`, `rateValues`, etc.
+     * - `options.newItem`: [`ItemValue`](https://surveyjs.io/form-library/documentation/itemvalue)\
+     * A new collection item. Overwrite its `value` or `text` property if you want to change the item's value or display text.
+     * - `options.itemValues`: [`ItemValue[]`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * An array of collection items to which the target item belongs ([`columns`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#columns) or [`rows`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#rows) in matrix questions, [`choices`](https://surveyjs.io/form-library/documentation/api-reference/questionselectbase#choices) in select-based questions, etc.). This array does not include `options.newItem`.
+     *
+     * > This event is not raised when users add a new column to a [Multi-Select Matrix](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list) or [Dynamic Matrix](https://surveyjs.io/form-library/documentation/api-reference/dynamic-matrix-table-question-model). For these cases, handle the [`onMatrixColumnAdded`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#onMatrixColumnAdded) event instead.
+     * @see onCollectionItemAllowOperations
+     */
     onItemValueAdded: CreatorEvent;
     /**
-     * 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.
+     * An event that is raised when users add a new column to a [Multi-Select Matrix](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list) or [Dynamic Matrix](https://surveyjs.io/form-library/documentation/api-reference/dynamic-matrix-table-question-model). Use this event to modify this column.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.matrix`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * A Multi-Select or Dynamic Matrix to which a new column is being added.
+     * - `options.newColumn`: [`MatrixDropdownColumn`](https://surveyjs.io/form-library/documentation/api-reference/matrixdropdowncolumn)\
+     * A new matrix column. Edit its properties if you want to modify this column.
+     * - `options.columns`: [`MatrixDropdownColumn[]`](https://surveyjs.io/form-library/documentation/api-reference/matrixdropdowncolumn)\
+     * An array of matrix columns. This array does not include `options.newColumn`.
+     *
+     * > This event is not raised when users add a new column to a [Single-Select Matrix](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model). For this case, handle the [`onItemValueAdded`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#onItemValueAdded) event instead.
+     * @see onCollectionItemAllowOperations
      */
     onMatrixColumnAdded: CreatorEvent;
     /**
-     * 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.allowBatchEdit a boolean property, true by default. Set it false to hide the "Edit" button for the "choices" property.
-     *- options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Manual Entry" tab for "choices" property by default.
+     * An event that is raised when a table property editor is created in the Property Grid. Use this event to configure the table property editor.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.obj`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A survey element (survey, page, panel, question) for which the table property editor is created.
+     * - `options.propertyName`: `string`\
+     * The name of the property with which the editor is associated: [`"columns"`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#columns), [`"rows"`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#rows), [`"choices"`](https://surveyjs.io/form-library/documentation/api-reference/questionselectbase#choices), etc.
+     * - `options.editorOptions.allowAddRemoveItems`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to disallow users to add and delete table rows.
+     * - `options.editorOptions.allowRemoveAllItems`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to disallow users to delete all table rows.
+     * - `options.editorOptions.allowBatchEdit`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to disallow users to edit table content as text in a pop-up window.
+     * @see onPropertyEditorCreated
      */
     onSetPropertyEditorOptions: CreatorEvent;
-    /**
-     * 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.
-     */
     onGenerateNewName: CreatorEvent;
     /**
      * An event that is raised when Survey Creator validates a modified value of a survey element property. Use this event to display a custom error message when the value is incorrect.
@@ -502,7 +563,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * - `sender`: `CreatorBase`\
      * A Survey Creator instance that raised the event.
      * - `options.obj`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
-     * A survey element (question, panel, page, or the survey itself) whose property is has changed.
+     * A survey element (question, panel, page, or the survey itself) whose property has changed.
      * - `options.propertyName`: `string`\
      * The name of the modified property.
      * - `options.value`: `any`\
@@ -512,21 +573,24 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     onSurveyPropertyValueChanged: CreatorEvent;
     /**
-      * 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
-      *- options.sortOrder "asc" (default) | "none". Change it to "none", if you don't want to sort your condition list
-      */
-    onConditionQuestionsGetList: CreatorEvent;
-    /**
-     * 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.
+     * An event that is raised when a condition editor renders a list of questions available for selection. Use this event to modify this list.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.obj`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A survey element (question, panel, page, or the survey itself) for which the condition editor is displayed.
+     * - `options.propertyName`: `string`\
+     * The name of a property being configured: `enableIf`, `requiredIf`, `visibleIf`, etc.
+     * - `options.editor`: `any`\
+     * A condition editor instance.
+     * - `options.list`: `any`\
+     * A list of questions available for selection.
+     * - `options.sortOrder`: `"asc"` (default) | `"none"`\
+     * The sort order of questions within the list. Set this property to `"none"` to disable sorting.
      */
+    onConditionQuestionsGetList: CreatorEvent;
     onConditionGetTitle: CreatorEvent;
     /**
      * An event that is raised when Survey Creator populates a condition editor with operators. Use this event to hide individual condition operators.
@@ -543,19 +607,23 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * A condition opeator for which the event is raised.
      * - `options.show`: `boolean`\
      * A Boolean property that you can set to `false` if you want to hide the condition operator.
-     *
      */
     onGetConditionOperator: CreatorEvent;
     /**
-     * Use this event to modify the display text of a logic item in the Logic tab.
+     * An event that is raised when the Logic tab constructs a user-friendly display text for a logic rule. Use this event to modify this display text.
      *
-     * The event handler accepts the following arguments:
+     * Parameters:
      *
-     * - `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.
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.expression`: `string`\
+     * A logical expression associated with the logic rule.
+     * - `options.expressionText`: `string`\
+     * The same expression in a user-friendly format.
+     * - `options.logicItem`: `SurveyLogicItem`\
+     * An object that describes the logic rule. Contains an array of actions and other properties.
+     * - `options.text`: `string`\
+     * A user-friendly display text for the logic rule. Modify this parameter if you want to override the display text.
      */
     onLogicItemDisplayText: CreatorEvent;
     /**
@@ -614,6 +682,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
       * - `options.source` - A dragged element.
       * - `options.target` - A drop target.
       * - `options.newElement` - A new element. This parameter is defined only if users drag a question or panel from the Toolbox.
+      * @see state
       */
     onModified: CreatorEvent;
     /**
@@ -627,7 +696,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * The question users added.
      * - `options.page`: [`PageModel`](https://surveyjs.io/form-library/documentation/api-reference/page-model)\
      * A page to which the question was added.
-     * - `options.reason`: `"DROPPED_FROM_TOOLBOX"` | `"ADDED_FROM_PAGEBUTTON"` | `"ELEMENT_COPIED"`\
+     * - `options.reason`: `"DROPPED_FROM_TOOLBOX"` | `"ADDED_FROM_PAGEBUTTON"` | `"ELEMENT_COPIED"` | `"ELEMENT_CONVERTED"`\
      * A value that indicates how the question was added: dragged from the [Toolbox](https://surveyjs.io/survey-creator/documentation/toolbox-customization), created using the Add Question button, or duplicated.
      *
      * [Customize Survey Elements on Creation](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#customize-survey-elements-on-creation (linkStyle))
@@ -692,6 +761,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * [Design Mode Survey Instance](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#design-mode-survey-instance (linkStyle))
      *
      * > If you want this event raised at startup, assign a survey JSON schema to the [`JSON`](#JSON) property *after* you add a handler to the event. If the JSON schema should be empty, specify the `JSON` property with an empty object.
+     * @see survey
      */
     onDesignerSurveyCreated: CreatorEvent;
     /**
@@ -711,9 +781,15 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     onPreviewSurveyCreated: CreatorEvent;
     onTestSurveyCreated: CreatorEvent;
     /**
-     * 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.
+     * An event that is raised when Survey Creator [displays a toast notification](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#notify). Use this event to implement custom toast notification.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.message`: `string`\
+     * A message to display.
+     * @see notify
      */
     onNotify: CreatorEvent;
     /**
@@ -756,15 +832,23 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * A choice item for which the event is raised. This parameter has a value only when the dialog window is opened to select images for an [Image Picker](https://surveyjs.io/form-library/documentation/api-reference/image-picker-question-model) question.
      * - `options.callback: (files: Array<File>)`: `Function`\
      * A callback function to which you should pass selected files.
+     * @see onUploadFile
      * @see uploadFiles
      */
     onOpenFileChooser: CreatorEvent;
     /**
-     * The event is fired on uploading the files.
+     * An event that is raised when a user selects a file to upload. Use this event to upload the file to your server.
      *
-     * - `sender` - the survey creator object that fires the event
-     * - `options.files` - the Javascript File objects array
-     * - `options.callback(status, imageLink)` - called on upload complete
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.question`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * A question for which files are being uploaded.
+     * - `options.files`: [`File[]`](https://developer.mozilla.org/en-US/docs/Web/API/File)\
+     * Files to upload.
+     * - `options.callback(status: string, fileUrl: string)`: `Function`\
+     * A callback function that you should call when a file is uploaded successfully or when file upload fails. Pass `"success"` or `"error"` as the `status` argument. If the file upload is successful, pass the file's URL as the `fileUrl` argument.
      *
      *  [View Demo](https://surveyjs.io/survey-creator/examples/file-upload/ (linkStyle))
      * @see uploadFiles
@@ -950,13 +1034,70 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * @see onDragEnd
      */
     onDragDropAllow: CreatorEvent;
+    /**
+     * An event that allows you to create a custom message panel.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.question`: [`Question`](https://surveyjs.io/form-library/documentation/question)\
+     * A question for which the event is raised.
+     * - `options.messageText`: `string`\
+     * A notification message that you want to display. Assign a custom string value to this parameter.
+     * - `options.actionText`: `string`\
+     * A caption text for the action link. Assign a custom string value to this parameter.
+     * - `options.onClick`: `function`\
+     * A function that is called when users click the action link. Assign a custom function to this parameter.
+     *
+     * A message panel is displayed within a question box on the design surface. It contains a text message and an optional action link. The following image illustrates a built-in message panel that appears when a question sources its choice options from another question or from a web service:
+     *
+     * <img src="https://surveyjs.io/stay-updated/release-notes/articles/v1.9.126/creator-message-panel.png" alt="Survey Creator: A message panel" width="75%">
+     *
+     * To create a custom message panel, handle the `onCreateCustomMessagePanel` event. This event is raised for questions whose `isMessagePanelVisible` property set to `true`. The following code shows how to enable this property based on a condition. This code implements a custom data source selector for select-based questions (Dropdown, Checkboxes, Radio Button Group). When a survey author selects any data source other than "Custom", the `isMessagePanelVisible` property becomes enabled, indicating that the `onCreateCustomMessagePanel` event must be raised. A function that handles this event specifies custom message and action link texts and `onClick` event handler:
+     *
+     * ```js
+     * import { Serializer } from "survey-core";
+     * import { SurveyCreatorModel } from "survey-creator-core";
+     *
+     * Serializer.addProperty("selectbase", {
+     *   name: "choicesDataSource",
+     *   displayName: "Data source",
+     *   category: "choices",
+     *   choices: [
+     *     { text: "Country", value: "country" },
+     *     { text: "Region", value: "region" },
+     *     { text: "City", value: "city" },
+     *     { text: "Custom", value: "custom" }
+     *   ],
+     *   onSetValue: function (obj: any, value: any) {
+     *     // Set the custom property value
+     *     obj.setPropertyValue("choicesDataSource", value);
+     *     // Display the message panel based on a condition
+     *     obj.setPropertyValue("isMessagePanelVisible", value !== "custom");
+     *   }
+     * });
+     *
+     * const creator = new SurveyCreatorModel({});
+     *
+     * creator.onCreateCustomMessagePanel.add((_, options) => {
+     *   options.messageText = "Choices for this question are loaded from a predefined data source. ";
+     *   options.actionText = "Go to settings";
+     *   // Focus the "Data source" editor within the Property Grid
+     *   options.onClick = () => {
+     *     creator.selectElement(options.question, "choicesDataSource");
+     *   };
+     * });
+     * ```
+     */
+    onCreateCustomMessagePanel: CreatorEvent;
     getSurveyJSONTextCallback: () => {
         text: string;
         isModified: boolean;
     };
     setSurveyJSONTextCallback: (text: string) => void;
     /**
-     * Limits the number of items in a logical expression.
+     * Limits the number of items in a logical condition.
      *
      * Default value: -1 (unlimited)
      */
@@ -990,7 +1131,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * If you set this property to `false`, users can only use UI elements to edit logical expressions.
      *
      * Default value: `true`
-     *
      * @see showLogicTab
      */
     allowEditExpressionsInTextEditor: boolean;
@@ -1122,10 +1262,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     get showInvisibleElementsInPreviewTab(): boolean;
     set showInvisibleElementsInPreviewTab(val: boolean);
-    /**
-     * Set this property to true if you want to show "page selector" in the toolabar instead of "pages editor"
-     */
-    showPageSelectorInToolbar: boolean;
     /**
      * Specifies whether users can switch between UI themes in the Preview tab.
      *
@@ -1138,21 +1274,20 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     tabbedMenu: AdaptiveActionContainer<TabbedMenuItem>;
     get tabs(): Array<TabbedMenuItem>;
     set tabs(val: Array<TabbedMenuItem>);
-    /**
-     * Returns the localized string by its id
-     * @param str the string id.
-     */
     getLocString(str: string): string;
     /**
-     * Specifies whether to show an error message if a survey is not saved in the database.
+     * Specifies whether to show an error message if a survey is not saved in a database.
      *
      * Default value: `true`
      */
     showErrorOnFailedSave: boolean;
     protected onSetReadOnly(newVal: boolean): void;
     /**
-     * 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.
+     * Specifies the locale of the Survey Creator UI.
+     *
+     * Default value: `""` (inherited from `editorLocalization.currentLocale`)
+     *
+     * [Localization & Globalization](https://surveyjs.io/survey-creator/documentation/survey-localization-translate-surveys-to-different-languages (linkStyle))
      */
     get locale(): string;
     set locale(value: string);
@@ -1234,7 +1369,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     showSidebarValue: boolean;
     onShowSidebarVisibilityChanged: CreatorEvent;
     /**
-     * Specifies whether to show the sidebar that displays Property Grid.
+     * Specifies whether to show the sidebar that displays the Property Grid.
      *
      * Default value: `true`
      * @see sidebarLocation
@@ -1326,7 +1461,8 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     isCanModifyProperty(obj: Base, propertyName: string): boolean;
     onIsPropertyReadOnlyCallback(obj: Base, property: JsonObjectProperty, readOnly: boolean, parentObj: Base, parentProperty: JsonObjectProperty): boolean;
     /**
-     * The editing survey object (Survey.Survey)
+     * A [survey](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model) being configured in the Designer tab.
+     * @see onDesignerSurveyCreated
      */
     get survey(): SurveyModel;
     private existingPages;
@@ -1401,11 +1537,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     protected setSurvey(survey: SurveyModel): void;
     private getSurveyTextFromDesigner;
     protected setTextValue(value: string): void;
-    /**
-     * Set JSON as text  into survey. Clear undo/redo states optionally.
-     * @param value JSON as text
-     * @param clearState default false. Set this parameter to true to clear undo/redo states.
-     */
     changeText(value: string, clearState?: boolean): void;
     /**
      * A survey JSON schema as a string.
@@ -1420,7 +1551,15 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     protected createSurveyCore(json: any, reason: string): SurveyModel;
     private _stateValue;
     /**
-     * Returns the creator state. It may return empty string or "saving" and "saved".
+     * Indicates the state of Survey Creator.
+     *
+     * Possible values:
+     *
+     * - `""` - Survey Creator doesn't have unsaved changes.
+     * - `"modified"` - Survey Creator has unsaved changes.
+     * - `"saving"` - Changes are being saved.
+     * - `"saved"` - Changes are successfully saved.
+     * @see onModified
      */
     get state(): string;
     protected setState(value: string): void;
@@ -1430,10 +1569,13 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     notifySurveyPropertyChanged(options: any): void;
     notifySurveyItemMoved(options: any): void;
     /**
-     * This function triggers user notification (via the alert() function if no onNotify event handler added).
-     * @see onNotify
+     * Displays a toast notification with a specified message.
+     *
+     * If you want to implement custom toast notification from scratch, handle the [`onNotify`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#onNotify) event.
+     * @param message A message to display.
+     * @param type A notification type: `"info"` (default) or `"error"`.
      */
-    notify(msg: string, type?: "info" | "error"): void;
+    notify(message: string, type?: "info" | "error"): void;
     protected convertQuestion(obj: Question, className: string): Question;
     private getDefaultElementJSON;
     private singlePageJSON;
@@ -1461,8 +1603,9 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     createNewElement(json: any): IElement;
     copyElement(element: Base): IElement;
     /**
-     * Copy a question to the active page
-     * @param question A copied Survey.Question
+     * Creates a copy of a specified question and inserts the copy next to this question.
+     * @param question A question to copy.
+     * @returns The instance of a new question.
      */
     fastCopyQuestion(question: Base): IElement;
     /**
@@ -1489,8 +1632,11 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     deleteElement(element: Base): void;
     /**
-     * Create a new page with the same elements and place it next to the current one. It returns the new created Survey.Page
-     * @param page A copied Survey.Page
+     * Creates a copy of a specified page and inserts the copy next to this page.
+     * @param page A [page](https://surveyjs.io/form-library/documentation/api-reference/page-model) to copy.
+     * @returns The [instance of a new page](https://surveyjs.io/form-library/documentation/api-reference/page-model).
+     * @see onPageAdding
+     * @see onPageAdded
      */
     copyPage(page: PageModel): PageModel;
     protected deleteObjectCore(obj: any): void;
@@ -1539,8 +1685,9 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     validateSelectedElement(): boolean;
     /**
-     * Deletes all custom translation strings for the passed locale from Survey Creator and from the generated survey JSON schema.
+     * Deletes all custom translation strings for a specified locale from Survey Creator and from the generated survey JSON schema.
      * @param locale A locale code (for example, "en").
+     * @see locale
      */
     deleteLocaleStrings(locale: string): void;
     private getPropertyGridExpandedCategory;
@@ -1550,20 +1697,24 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     clickToolboxItem(newElement: any, panel?: IPanel, modifiedType?: string): void;
     getJSONForNewElement(json: any): any;
     /**
-     * Open file chooser dialog
-     * @param input file input element
-     * @param onFilesChosen a call back function to process chosen files
+     * Opens a dialog window for users to select files.
+     * @param input A [file input HTML element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
+     * @param callback A callback function that you can use to process selected files. Accepts an array of JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/API/File" target="_blank">File</a> objects.
+     * @see onOpenFileChooser
+     * @see onUploadFile
      */
-    chooseFiles(input: HTMLInputElement, onFilesChosen: (files: File[]) => void, context?: {
+    chooseFiles(input: HTMLInputElement, callback: (files: File[]) => void, context?: {
         element: SurveyElement;
         item?: ItemValue;
     }): void;
     /**
-     * Upload the files on a server
-     * @param files files to upload
-     * @param uploadingCallback a call back function to get the status on uploading the file and operation result - URI of the uploaded file
+     * Uploads files to a server.
+     * @param files An array of JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/API/File" target="_blank">File</a> objects that represent files to upload.
+     * @param question A [question instance](https://surveyjs.io/form-library/documentation/api-reference/question) for which files are uploaded.
+     * @param callback A callback function that indicates the upload status&mdash;"success" or "error"&mdash;as the first argument. If a file is uploaded successfully, the second argument contains the file's URL.
+     * @see onUploadFile
      */
-    uploadFiles(files: File[], question: Question, uploadingCallback: (status: string, data: any) => any): void;
+    uploadFiles(files: File[], question: Question, callback: (status: string, data: any) => any): void;
     private _rootElementValue;
     get rootElement(): HTMLElement;
     setRootElement(element: HTMLElement): void;
@@ -1612,7 +1763,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     /**
      * A delay between changing survey settings and saving the survey JSON schema, measured in milliseconds. Applies only when the [`isAutoSave`](#isAutoSave) property is `true`.
      *
-     * Default value: 500 (taken from `settings.autoSave.delay`)
+     * Default value: 500 (inherited from `settings.autoSave.delay`)
      *
      * If a user changes the settings once again during the delay, only the latest version will be saved.
      */
@@ -1688,17 +1839,17 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     isMobileView: boolean;
     isTouch: any;
     /**
-     * Specifies Toolbox location.
+     * Specifies the Toolbox location.
      *
      * Possible values:
      *
-     * - `"left"` (default) - Displays Toolbox on the left side of the design surface.
-     * - `"right"` - Displays Toolbox on the right side of the design surface.
-     * - `"sidebar"` - Displays Toolbox as an overlay on top of Property Grid. Use the [`sidebarLocation`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#sidebarLocation) property to specify Property Grid position.
+     * - `"left"` (default) - Displays the Toolbox on the left side of the design surface.
+     * - `"right"` - Displays the Toolbox on the right side of the design surface.
+     * - `"sidebar"` - Displays the Toolbox as an overlay on top of the Property Grid. Use the [`sidebarLocation`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#sidebarLocation) property to specify the Property Grid position.
      */
     toolboxLocation: toolboxLocationType;
     /**
-     * Specifies the position of the sidebar that displays Property Grid. Applies only when [`showSidebar`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#showSidebar) is `true`.
+     * Specifies the position of the sidebar that displays the Property Grid. Applies only when [`showSidebar`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#showSidebar) is `true`.
      *
      * Possible values:
      *
@@ -1712,6 +1863,11 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     dispose(): void;
     enableLinkFileEditor: boolean;
 }
+/**
+ * A class with properties, methods, and events that allow you to configure Survey Creator and manage its elements.
+ *
+ * [View Demo](https://surveyjs.io/survey-creator/examples/free-nps-survey-template/ (linkStyle))
+ */
 export declare class SurveyCreatorModel extends CreatorBase {
 }
 export declare class StylesManager {