survey-creator-core 1.9.51 → 1.9.53

package/survey-creator-core.d.ts

@@ -1,16 +1,16 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.51
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.53
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: https://surveyjs.io/Licenses#SurveyCreator
 */
 import { Base, JsonObjectProperty, Question, SurveyModel, ItemValue } from "survey-core";
-import { MatrixDropdownColumn, IAction, Action, ILocalizableOwner, LocalizableString } from "survey-core";
-import { ActionContainer, DragDropSurveyElements, DragDropChoices, Event, AdaptiveActionContainer } from "survey-core";
-import { PageModel, IElement, IPanel, ISurveyElement, SurveyElement } from "survey-core";
-import { QuestionSelectBase, Operand, DragOrClickHelper, PanelModel, QuestionDropdownModel } from "survey-core";
-import { ListModel, PopupModel, EventBase, PanelModelBase, QuestionNonValue } from "survey-core";
-import { SurveyTemplateRendererTemplateData, QuestionRatingModel, QuestionRowModel, ComputedUpdater, QuestionCheckboxModel } from "survey-core";
-import { ILocalizableString, ArrayChanges, ImageItemValue, HashTable, QuestionMatrixDynamicModel } from "survey-core";
+import { MatrixDropdownColumn, ILocalizableString, IAction, Action, ILocalizableOwner } from "survey-core";
+import { LocalizableString, ActionContainer, DragDropSurveyElements, DragDropChoices, Event } from "survey-core";
+import { AdaptiveActionContainer, PageModel, IElement, IPanel, ISurveyElement } from "survey-core";
+import { SurveyElement, QuestionSelectBase, Operand, DragOrClickHelper, PanelModel } from "survey-core";
+import { QuestionDropdownModel, ListModel, PopupModel, EventBase, PanelModelBase } from "survey-core";
+import { QuestionNonValue, SurveyTemplateRendererTemplateData, QuestionRatingModel, QuestionRowModel, ComputedUpdater } from "survey-core";
+import { QuestionCheckboxModel, ArrayChanges, ImageItemValue, HashTable, QuestionMatrixDynamicModel } from "survey-core";
 import { QuestionMatrixModel, QuestionMatrixDropdownModel, QuestionPanelDynamicModel, QuestionCommentModel, MatrixDynamicRowModel } from "survey-core";
 
 export { editorLocalization as localization };
@@ -63,6 +63,7 @@ export interface ISurveyCreatorOptions {
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): string;
   onConditionGetTitleCallback(expression: string, title: string): string;
   onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
+  getTranslationExportedText(obj: Base, name: string, locString: ILocalizableString, locale: string, text: string): string;
 }
 /*
 * Survey Creator configuration. Pass it as an argument to the `SurveyCreator` constructor:
@@ -1037,10 +1038,23 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onTranslationImportItem: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
-  * The method is called when the translation from csv file is imported.
+  * The event is called when the translation from csv file is imported.
   */
   onTranslationImported: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * Use this event to modify a translated string before it is exported to CSV.
+  * 
+  * 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 exported to CSV.
+  * - `options.locale` - The current locale identifier (`"en"`, `"de"`, etc.). Contains an empty string if the default locale is used.
+  * - `options.name` - A full name of the translated string. It is composed of names of all parent elements, for example: `"mySurvey.page1.question2.title"`.
+  * - `options.locString` - A `LocalizableString` instance. Call the `options.locString.getLocaleText(locale)` method if you need to get a text string for a specific locale.
+  * - `options.text` - A text string to be exported. The string is taken from the current locale. Redefine this property if you want to export a different string.
+  */
+  onTranslationExportItem: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * Use this event to control drag&drop operations.
   * - sender the survey creator object that fires the event.
   * - options.survey the editing survey object.
@@ -1498,6 +1512,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): string;
   onConditionGetTitleCallback(expression: string, title: string): string;
   onLogicGetTitleCallback(expression: string, expressionText: string, text: string, logicItem: any): string;
+  getTranslationExportedText(obj: Base, name: string, locString: ILocalizableString, locale: string, text: string): string;
   /*
   * 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.
@@ -2122,6 +2137,7 @@ export declare class StringEditorConnector extends Base {
   setItemValue(item: ItemValueWrapperViewModel): void;
   onDoActivate: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
   onEditComplete: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
+  onBackspaceEmptyString: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
 }
 export declare class StringEditorViewModelBase extends Base {
   constructor(locString: LocalizableString, creator: CreatorBase);
@@ -2792,6 +2808,7 @@ export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): string;
   onConditionGetTitleCallback(expression: string, title: string): string;
   onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
+  getTranslationExportedText(obj: Base, name: string, locString: ILocalizableString, locale: string, text: string): string;
 }
 export declare class ImageItemValueWrapperViewModel extends ItemValueWrapperViewModel {
   constructor(creator: CreatorBase, question: QuestionSelectBase, item: ImageItemValue, templateData: any, itemsRoot: any);
@@ -3085,6 +3102,7 @@ export declare class TranslationItem extends TranslationItemBase {
   name: string;
   locString: ILocalizableString;
   defaultValue: string;
+  context: any;
   hashValues: any;
   customText: string;
   afterRender: any;
@@ -3323,6 +3341,7 @@ export declare class QuestionDropdownAdornerViewModel extends QuestionAdornerVie
   isCollapsed: boolean;
   visibleCount: number;
   get question(): QuestionDropdownModel;
+  get itemComponent(): string;
   get needToCollapse(): boolean;
   get isCollapseView(): boolean;
   leftFocus(): void;