Merge branch release/v8.2.0 into master

[bu]/[plugins] Fixed description

api.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions
@@ -42,6 +42,8 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 		if (!oLogicDocument)
 			return;
 		
+		CheckCurrentSelection(oLogicDocument);
+		
 		if (oPr && oFormPr)
 		{
 			if (oPr.GroupKey)
@@ -59,6 +61,7 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 			oPr.UncheckedFont = "Segoe UI Symbol";
 		}
 		
+		
 		var nCheckedSymbol   = oPr && oPr.CheckedSymbol ? oPr.CheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.CheckedSymbol;
 		var nUncheckedSymbol = oPr && oPr.UncheckedSymbol ? oPr.UncheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.UncheckedSymbol;
 		var sCheckedFont     = oPr && oPr.CheckedFont ? oPr.CheckedFont : Asc.c_oAscSdtCheckBoxDefaults.CheckedFont;
@@ -85,8 +88,11 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 			if (oFormPr)
 			{
 				private_ApplyFormPr(oCC, oFormPr, oLogicDocument);
-				oCC.UpdatePlaceHolderTextPrForForm();
-				private_CheckFormKey(oCC, oLogicDocument);
+				
+				if (oPr && oPr.GroupKey)
+					private_CheckRadioButtonChoice(oCC, oLogicDocument, oPr.GroupKey);
+				else
+					private_CheckFormKey(oCC, oLogicDocument);
 			}
 
 			if (oCommonPr)
@@ -165,27 +171,44 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 			private_PerformAddCheckBox();
 		}
 	};
-	window['Asc']['asc_docs_api'].prototype['asc_AddContentControlPicture'] = window['Asc']['asc_docs_api'].prototype.asc_AddContentControlPicture = function(oFormPr, oCommonPr)
+	window['Asc']['asc_docs_api'].prototype['asc_AddContentControlPicture'] = window['Asc']['asc_docs_api'].prototype.asc_AddContentControlPicture = function(oFormPr, oCommonPr, isSignature)
 	{
 		var oLogicDocument = this.private_GetLogicDocument();
 		if (!oLogicDocument)
 			return;
+		
+		CheckCurrentSelection(oLogicDocument);
 
 		oLogicDocument.RemoveTextSelection();
 		if (!oLogicDocument.IsSelectionLocked(AscCommon.changestype_Paragraph_Content))
 		{
 			oLogicDocument.StartAction(AscDFH.historydescription_Document_AddContentControlPicture);
 
-			var oCC = oLogicDocument.AddContentControlPicture();
+			// 150x32pt for Signature
+			let w = isSignature ? 150 / 72 * 25.4 : undefined;
+			let h = isSignature ? 32 / 72 * 25.4 : undefined;
+			
+			var oCC = oLogicDocument.AddContentControlPicture(w, h);
 			let oFormParaDrawing = null;
 			if (oCC && oFormPr)
 			{
 				oCC.SetFormPr(oFormPr);
 				oCC.UpdatePlaceHolderTextPrForForm();
+				let pictPr = new AscCommon.CSdtPictureFormPr();
+				if (isSignature)
+				{
+					pictPr.SetSignature(true);
+					let glossary = oLogicDocument.GetGlossaryDocument();
+					if (glossary)
+						oCC.SetPlaceholder(glossary.GetDefaultPlaceholderSignatureOformDocPartId());
+				}
+				
+				oCC.SetPictureFormPr(pictPr);
+				
 				private_CheckFormKey(oCC, oLogicDocument);
-
+				oLogicDocument.Recalculate(true);
 				oFormParaDrawing = oCC.ConvertFormToFixed();
-				oCC.SetPictureFormPr(new AscCommon.CSdtPictureFormPr());
+				
 				var aDrawings = oCC.GetAllDrawingObjects();
 				for(var nDrawing = 0; nDrawing < aDrawings.length; ++nDrawing)
 				{
@@ -237,6 +260,11 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 					oLogicDocument.Recalculate(true);
 					oCC.UpdatePictureFormLayout();
 				}
+				else
+				{
+					oCC.ReplaceContentWithPlaceHolder();
+					oCC.ApplyPicturePr(true);
+				}
 			}
 
 			if (oCC && oCommonPr)
@@ -255,11 +283,17 @@ window["AscOForm"] = window.AscOForm = AscOForm;
  			oLogicDocument.FinalizeAction();
 		}
 	};
+	window['Asc']['asc_docs_api'].prototype['asc_AddContentControlSignature'] = window['Asc']['asc_docs_api'].prototype.asc_AddContentControlSignature = function(oFormPr, oCommonPr)
+	{
+		return this.asc_AddContentControlPicture(oFormPr, oCommonPr, true);
+	};
 	window['Asc']['asc_docs_api'].prototype['asc_AddContentControlList'] = window['Asc']['asc_docs_api'].prototype.asc_AddContentControlList = function(isComboBox, oPr, oFormPr, oCommonPr)
 	{
 		var oLogicDocument = this.private_GetLogicDocument();
 		if (!oLogicDocument)
 			return;
+		
+		CheckCurrentSelection(oLogicDocument);
 
 		oLogicDocument.RemoveTextSelection();
 		if (!oLogicDocument.IsSelectionLocked(AscCommon.changestype_Paragraph_Content))
@@ -293,6 +327,8 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 		var oLogicDocument = this.private_GetLogicDocument();
 		if (!oLogicDocument)
 			return;
+		
+		CheckCurrentSelection(oLogicDocument);
 
 		oLogicDocument.RemoveTextSelection();
 		if (!oLogicDocument.IsSelectionLocked(AscCommon.changestype_Paragraph_Content))
@@ -339,6 +375,8 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 		var oLogicDocument = this.private_GetLogicDocument();
 		if (!oLogicDocument)
 			return;
+		
+		CheckCurrentSelection(oLogicDocument);
 
 		let textFormPr      = contentControlPr ? contentControlPr.TextFormPr : null;
 		let formPr          = contentControlPr ? contentControlPr.FormPr : null;
@@ -372,6 +410,8 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 		let logicDocument = this.private_GetLogicDocument();
 		if (!logicDocument)
 			return;
+		
+		CheckCurrentSelection(logicDocument, true);
 
 		function AddComplexForm()
 		{
@@ -430,6 +470,161 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 
 		return AscWord.FormToJson(form);
 	};
+	window['Asc']['asc_docs_api'].prototype['asc_SetFormValue'] = window['Asc']['asc_docs_api'].prototype.asc_SetFormValue = function(value, formId)
+	{
+		let logicDocument = this.private_GetLogicDocument();
+		if (!logicDocument)
+			return;
+		
+		let form = logicDocument.GetContentControl(formId);
+		if (!form || !form.IsForm())
+			return;
+		
+		return this.private_SetFormValue(form.GetId(), value);
+	};
+	window['Asc']['asc_docs_api'].prototype['asc_GetFormValue'] = window['Asc']['asc_docs_api'].prototype.asc_GetFormValue = function(formId)
+	{
+		let logicDocument = this.private_GetLogicDocument();
+		if (!logicDocument)
+			return "";
+		
+		let form = logicDocument.GetContentControl(formId);
+		if (!form || !form.IsForm())
+			return "";
+		
+		if (form.IsPictureForm())
+			return "";
+		else if (form.IsCheckBox())
+			return form.IsCheckBoxChecked();
+		else if (form.IsPlaceHolder())
+			return "";
+		
+		return form.GetInnerText();
+	};
+	window['Asc']['asc_docs_api'].prototype.private_SetFormValue = function(internalId, value)
+	{
+		let oLogicDocument = this.private_GetLogicDocument();
+		
+		if (!AscCommon.g_oTableId
+			|| !oLogicDocument
+			|| !oLogicDocument.IsDocumentEditor())
+			return;
+		
+		let oForm = AscCommon.g_oTableId.GetClass(internalId);
+		
+		if (!oForm
+			|| !(oForm instanceof AscWord.CInlineLevelSdt)
+			|| !oForm.IsForm())
+			return;
+		
+		// При проверке лока внутри параграфа мы ориентируемся на выделение внутри этого параграфа
+		// поэтому нужно выделить форму
+		let state = oLogicDocument.SaveDocumentState();
+		oForm.SelectContentControl();
+		
+		let oParagraph = oForm.GetParagraph();
+		
+		oForm.SkipFillingFormModeCheck(true);
+		oForm.SkipSpecialContentControlLock(true);
+		if (!oParagraph
+			|| oLogicDocument.IsSelectionLocked(AscCommon.changestype_None, {
+				Type      : AscCommon.changestype_2_ElementsArray_and_Type,
+				Elements  : [oParagraph],
+				CheckType : AscCommon.changestype_Paragraph_Content
+			}, true, oLogicDocument.IsFillingFormMode()))
+		{
+			oLogicDocument.LoadDocumentState(state);
+			oForm.SkipFillingFormModeCheck(false);
+			oForm.SkipSpecialContentControlLock(false);
+			return;
+		}
+		oLogicDocument.LoadDocumentState(state);
+		oForm.SkipFillingFormModeCheck(false);
+		oForm.SkipSpecialContentControlLock(false);
+		
+		oLogicDocument.StartAction(AscDFH.historydescription_Document_FillFormInPlugin);
+		
+		let isClear = false;
+		if (null === value)
+		{
+			isClear = true;
+		}
+		else if (oForm.IsTextForm() || oForm.IsComboBox())
+		{
+			let sValue = AscBuilder.GetStringParameter(value, "");
+			if (!sValue)
+				isClear = true;
+			else
+				oForm.SetInnerText(sValue);
+		}
+		else if (oForm.IsDropDownList())
+		{
+			let sValue = AscBuilder.GetStringParameter(value, "");
+			let oPr    = oForm.GetDropDownListPr();
+			let nIndex = oPr.FindByText(sValue);
+			if (-1 !== nIndex)
+				oForm.SelectListItem(oPr.GetItemValue(nIndex));
+			else
+				isClear = true;
+		}
+		else if (oForm.IsCheckBox())
+		{
+			let isChecked = value === "true" ? true : value === "false" ? false : AscBuilder.GetBoolParameter(value, null);
+			if (null !== isChecked)
+				oForm.SetCheckBoxChecked(isChecked);
+			else
+				isClear = true;
+		}
+		else if (oForm.IsPictureForm())
+		{
+			let sValue = AscBuilder.GetStringParameter(value, "");
+			if (!sValue)
+				return;
+			
+			let oImg;
+			let allDrawings = oForm.GetAllDrawingObjects();
+			for (let nDrawing = 0; nDrawing < allDrawings.length; ++nDrawing)
+			{
+				if (allDrawings[nDrawing].IsPicture())
+				{
+					oImg = allDrawings[nDrawing].GraphicObj;
+					break;
+				}
+			}
+			
+			if (oImg)
+			{
+				oForm.SetShowingPlcHdr(false);
+				oImg.setBlipFill(AscFormat.CreateBlipFillRasterImageId(sValue));
+			}
+			else
+			{
+				isClear = true;
+			}
+		}
+		else if (oForm.IsDatePicker())
+		{
+			let sValue = AscBuilder.GetStringParameter(value, "");
+			if (!sValue)
+				isClear = true;
+			else
+				oForm.SetInnerText(sValue);
+			
+			// TODO: Надо FullDate попытаться выставить по заданному значение. Сейчас мы всегда сбрасываем на текущую дату
+			 let datePickerPr = oForm.GetDatePickerPr().Copy();
+			 datePickerPr.SetFullDate(null);
+			 oForm.SetDatePickerPr(datePickerPr);
+		}
+		
+		if (isClear)
+			oForm.ClearContentControlExt();
+		
+		oLogicDocument.OnChangeForm(oForm);
+		oLogicDocument.Recalculate();
+		oLogicDocument.UpdateTracks();
+		oLogicDocument.UpdateInterface();
+		oLogicDocument.FinalizeAction();
+	};
 
 	function private_CheckFormKey(form, logicDocument)
 	{
@@ -451,6 +646,26 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 		formPr.SetKey(key);
 		form.SetFormPr(formPr);
 	}
+	function private_CheckRadioButtonChoice(form, logicDocument, groupKey)
+	{
+		if (!form || !form.IsForm() || !logicDocument)
+			return;
+		
+		let choice = form.GetFormKey();
+		if (choice && "" !== choice.trim())
+			return;
+		
+		let formManager  = logicDocument.GetFormsManager();
+		let keyGenerator = formManager.GetKeyGenerator();
+		
+		let formPr = form.GetFormPr().Copy();
+		if (!formPr)
+			return;
+		
+		choice = keyGenerator.GetNewChoiceByGroupKey(groupKey);
+		formPr.SetKey(choice);
+		form.SetFormPr(formPr);
+	}
 	function private_ApplyFormPr(form, formPr, logicDocument)
 	{
 		if (!form || !formPr)
@@ -458,19 +673,49 @@ window["AscOForm"] = window.AscOForm = AscOForm;
 		
 		form.SetFormPr(formPr.Copy());
 		
-		if (formPr.GetFixed())
+		let docPartId = form.GetPlaceholder();
+		let glossary  = logicDocument.GetGlossaryDocument();
+		if ((form.IsTextForm()
+				|| form.IsDropDownList()
+				|| form.IsComboBox()
+				|| form.IsDatePicker())
+			&&
+			(docPartId === glossary.GetDefaultPlaceholderTextDocPartId()
+				|| docPartId === glossary.GetDefaultPlaceholderListDocPartId()
+				|| docPartId === glossary.GetDefaultPlaceholderDateTimeDocPartId()))
+		{
+			if (docPartId === glossary.GetDefaultPlaceholderTextDocPartId())
+				form.SetPlaceholder(glossary.GetDefaultPlaceholderTextOformDocPartId());
+			else if (docPartId === glossary.GetDefaultPlaceholderListDocPartId())
+				form.SetPlaceholder(glossary.GetDefaultPlaceholderListOformDocPartId());
+			else if (docPartId === glossary.GetDefaultPlaceholderDateTimeDocPartId())
+				form.SetPlaceholder(glossary.GetDefaultPlaceholderDateTimeOformDocPartId());
+
+			if (form.IsPlaceHolder())
+				form.private_FillPlaceholderContent();
+		}
+		
+		let paragraph = form.GetParagraph();
+		if (form.IsMainForm() && formPr.GetFixed() && (!paragraph || !paragraph.GetParentShape()))
 		{
 			logicDocument.Recalculate(true);
 			let drawing = form.ConvertFormToFixed();
 			if (drawing)
-			{
-				let drawingPr = new Asc.asc_CImgProperty();
-				drawingPr.asc_putWrappingStyle(Asc.c_oAscWrapStyle2.Square);
-				drawing.Set_Props(drawingPr);
-				
-				form.MoveCursorToContentControl(false);
-			}
+				drawing.SelectAsDrawing();
 		}
 	}
+	
+	function CheckCurrentSelection(logicDocument, isComplex)
+	{
+		let form = logicDocument.GetContentControl();
+		
+		if (!form || !form.IsForm() || (form.IsComplexForm() && !isComplex))
+			return;
+		
+		if (isComplex)
+			form = form.GetMainForm();
+		
+		form.MoveCursorOutsideForm(false);
+	}
 
 })(window, window.document);

apiBuilder.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions
@@ -38,10 +38,13 @@
 	// Import
 	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 	const AscBuilder         = window["AscBuilder"];
-	const GetStringParameter = AscBuilder.GetStringParameter;
-	const GetBoolParameter   = AscBuilder.GetBoolParameter;
-	const GetNumberParameter = AscBuilder.GetNumberParameter;
-	const GetArrayParameter  = AscBuilder.GetArrayParameter;
+
+	const ApiDocument            = AscBuilder.ApiDocument;
+	const GetStringParameter     = AscBuilder.GetStringParameter;
+	const GetBoolParameter       = AscBuilder.GetBoolParameter;
+	const GetNumberParameter     = AscBuilder.GetNumberParameter;
+	const GetArrayParameter      = AscBuilder.GetArrayParameter;
+	const executeNoFormLockCheck = AscBuilder.executeNoFormLockCheck;
 	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	/**
@@ -57,38 +60,59 @@
 	 * @typedef {Object} FormPrBase
 	 * @property {string} key - Form key.
 	 * @property {string} tip - Form tip text.
+	 * @property {string} tag - Form tag.
 	 * @property {boolean} required - Specifies if the form is required or not.
 	 * @property {string} placeholder - Form placeholder text.
+	 * @see office-js-api/Examples/Enumerations/FormPrBase.js
 	 */
 
 	/**
-	 * Specific text form properties.
+	 * Specific text field properties.
 	 * @typedef {Object} TextFormPrBase
-	 * @property {boolean} comb - Specifies if the text form should be a comb of characters with the same cell width. The maximum number of characters must be set to a positive value.
-	 * @property {number} maxCharacters - The maximum number of characters in the text form.
+	 * @property {boolean} comb - Specifies if the text field should be a comb of characters with the same cell width. The maximum number of characters must be set to a positive value.
+	 * @property {number} maxCharacters - The maximum number of characters in the text field.
 	 * @property {number} cellWidth - The cell width for each character measured in millimeters. If this parameter is not specified or equal to 0 or less, then the width will be set automatically.
-	 * @property {boolean} multiLine - Specifies if the current fixed size text form is multiline or not.
-	 * @property {boolean} autoFit - Specifies if the text form content should be autofit, i.e. whether the font size adjusts to the size of the fixed size form.
+	 * @property {boolean} multiLine - Specifies if the current fixed size text field is multiline or not.
+	 * @property {boolean} autoFit - Specifies if the text field content should be autofit, i.e. whether the font size adjusts to the size of the fixed size form.
+	 * @see office-js-api/Examples/Enumerations/TextFormPrBase.js
 	 */
 
 	/**
-	 * Text form properties.
+	 * Text field properties.
 	 * @typedef {FormPrBase | TextFormPrBase} TextFormPr
+	 * @see office-js-api/Examples/Enumerations/TextFormPr.js
 	 */
+	
+	/**
+	 * Form insertion specific properties.
+	 * @typedef {Object} FormInsertPr
+	 * @property {boolean} [placeholderFromSelection=false] - Specifies if the currently selected text should be saved as a placeholder of the inserted form.
+	 * @property {boolean} [keepSelectedTextInForm=true] - Specifies if the currently selected text should be saved as the content of the inserted form.
+	 * @see office-js-api/Examples/Enumerations/FormInsertPr.js
+	 */
+	
+	/**
+	 * Properties for inserting a text field.
+	 * @typedef {FormPrBase | TextFormPrBase | FormInsertPr} TextFormInsertPr
+	 * @see office-js-api/Examples/Enumerations/TextFormInsertPr.js
+	 */
+	
 	 
 	/**
-	 * Specific checkbox properties.
+	 * Specific checkbox / radio button properties.
 	 * @typedef {Object} CheckBoxFormPrBase
 	 * @property {boolean} radio - Specifies if the current checkbox is a radio button. In this case, the key parameter is considered as an identifier for the group of radio buttons.
+	 * @see office-js-api/Examples/Enumerations/CheckBoxFormPrBase.js
 	 */
 
 	/**
-	 * Checkbox form properties.
+	 * Checkbox / radio button properties.
 	 * @typedef {FormPrBase | CheckBoxFormPrBase} CheckBoxFormPr
+	 * @see office-js-api/Examples/Enumerations/CheckBoxFormPr.js
 	 */
 
 	/**
-	 * Specific combo box properties.
+	 * Specific combo box / dropdown list properties.
 	 * @typedef {Object} ComboBoxFormPrBase
 	 * @property {boolean} editable - Specifies if the combo box text can be edited.
 	 * @property {boolean} autoFit - Specifies if the combo box form content should be autofit, i.e. whether the font size adjusts to the size of the fixed size form.
@@ -97,21 +121,25 @@
      * If the array consists of single strings, then the displayed value and its meaning are the same.
      * Example: ["First", ["Second", "2"], ["Third", "3"], "Fourth"].
 
+	 * @see office-js-api/Examples/Enumerations/ComboBoxFormPrBase.js
 	 */
 
 	/**
-	 * Combo box form properties.
+	 * Combo box / dropdown list properties.
 	 * @typedef {FormPrBase | ComboBoxFormPrBase} ComboBoxFormPr
+	 * @see office-js-api/Examples/Enumerations/ComboBoxFormPr.js
 	 */
 
 	/**
 	 * The condition to scale an image in the picture form.
 	 * @typedef {"always" | "never" | "tooBig" | "tooSmall"} ScaleFlag
+	 * @see office-js-api/Examples/Enumerations/ScaleFlag.js
 	 */
 
 	/**
 	 * Value from 0 to 100.
 	 * @typedef {number} percentage
+	 * @see office-js-api/Examples/Enumerations/percentage.js
 	 */
 
 	/**
@@ -121,244 +149,370 @@
 	 * @property {boolean} lockAspectRatio - Specifies if the aspect ratio of the picture form is locked or not.
 	 * @property {boolean} respectBorders - Specifies if the form border width is respected or not when scaling the image.
 	 * @property {percentage} shiftX - Horizontal picture position inside the picture form measured in percent:
-	 * * <b>0</b> - the picture is placed on the left;
-	 * * <b>50</b> - the picture is placed in the center;
-	 * * <b>100</b> - the picture is placed on the right.
+	 * <b>0</b> - the picture is placed on the left;
+	 * <b>50</b> - the picture is placed in the center;
+	 * <b>100</b> - the picture is placed on the right.
 	 * @property {percentage} shiftY - Vertical picture position inside the picture form measured in percent:
-	 * * <b>0</b> - the picture is placed on top;
-	 * * <b>50</b> - the picture is placed in the center;
-	 * * <b>100</b> - the picture is placed on the bottom.
+	 * <b>0</b> - the picture is placed on top;
+	 * <b>50</b> - the picture is placed in the center;
+	 * <b>100</b> - the picture is placed on the bottom.
+	 * @see office-js-api/Examples/Enumerations/PictureFormPrBase.js
 	 */
 
 	/**
 	 * Picture form properties.
 	 * @typedef {FormPrBase | PictureFormPrBase} PictureFormPr
+	 * @see office-js-api/Examples/Enumerations/PictureFormPr.js
 	 */
 
 	/**
-	 * Creates a text form with the specified text form properties.
+	 * Specific date form properties.
+	 * @typedef {Object} DateFormPrBase
+	 * @property {string} format	- The date format, ex: mm.dd.yyyy
+	 * @property {string} lang		- The date language. Possible value for this parameter is a language identifier as defined by
+	 * RFC 4646/BCP 47. Example: "en-CA".
+	 * @see office-js-api/Examples/Enumerations/DateFormPrBase.js
+	 */
+
+	/**
+	 * Date form properties.
+	 * @typedef {FormPrBase | DateFormPrBase} DateFormPr
+	 * @see office-js-api/Examples/Enumerations/DateFormPr.js
+	 */
+
+	/**
+	 * Creates a text field with the specified text field properties.
 	 * @memberof Api
-	 * @param {TextFormPr} oFormPr - Text form properties.
+	 * @typeofeditors ["CDE", "CFE"]
+	 * @param {TextFormPr} oFormPr - Text field properties.
 	 * @returns {ApiTextForm}
+	 * @see office-js-api/Examples/Forms/Api/Methods/CreateTextForm.js
 	 */
 	Api.prototype.CreateTextForm = function(oFormPr)
 	{
-		if (!oFormPr)
-			oFormPr = {};
-
-		let oCC = CreateCommonForm(oFormPr);
-
-		let oPr = new AscCommon.CSdtTextFormPr();
-		oPr.SetComb(GetBoolParameter(oFormPr["comb"], false));
-		oPr.SetMaxCharacters(GetNumberParameter(oFormPr["maxCharacters"], -1));
-		oPr.SetMultiLine(GetBoolParameter(oFormPr["multiLine"], false));
-		oPr.SetAutoFit(GetBoolParameter(oFormPr["autoFit"], false));
-		oPr.SetWidth((GetNumberParameter(oFormPr["cellWidth"], 0) * 72 * 20 / 25.4) | 0);
-
-		oCC.ApplyTextFormPr(oPr);
-		CheckFormKey(oCC);
-		return new AscBuilder.ApiTextForm(oCC);
+		return executeNoFormLockCheck(function()
+		{
+			if (!oFormPr)
+				oFormPr = {};
+			
+			let form = CreateCommonForm(oFormPr);
+			ApplyTextFormPr(form, oFormPr);
+			CheckFormKey(form);
+			return new AscBuilder.ApiTextForm(form);
+		}, this);
 	};
 	/**
-	 * Creates a checkbox/radio button form with the specified checkbox/radio button form properties.
+	 * Creates a checkbox / radio button with the specified checkbox / radio button properties.
 	 * @memberof Api
-	 * @param {CheckBoxFormPr} oFormPr - Checkbox/radio button form properties.
+	 * @typeofeditors ["CDE", "CFE"]
+	 * @param {CheckBoxFormPr} oFormPr - Checkbox / radio button properties.
 	 * @returns {ApiCheckBoxForm}
+	 * @see office-js-api/Examples/Forms/Api/Methods/CreateCheckBoxForm.js
 	 */
 	Api.prototype.CreateCheckBoxForm = function(oFormPr)
 	{
-		if (!oFormPr)
-			oFormPr = {};
-
-		oFormPr["placeholder"] = undefined;
-
-		var oCC;
-		var oCheckboxPr  = new AscCommon.CSdtCheckBoxPr();
-		if (GetBoolParameter(oFormPr["radio"], false))
+		return executeNoFormLockCheck(function()
 		{
-			oCheckboxPr.CheckedSymbol   = 0x25C9;
-			oCheckboxPr.UncheckedSymbol = 0x25CB;
-			oCheckboxPr.GroupKey        = GetStringParameter(oFormPr["key"], "Group1");
-		}
-		else
-		{
-			oCheckboxPr.CheckedSymbol   = 0x2611;
-			oCheckboxPr.UncheckedSymbol = 0x2610;
-		}
-
-		oCheckboxPr.CheckedFont = "Segoe UI Symbol";
-		oCheckboxPr.UncheckedFont = "Segoe UI Symbol";
-
-		var nCheckedSymbol   = oCheckboxPr && oCheckboxPr.CheckedSymbol ? oCheckboxPr.CheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.CheckedSymbol;
-		var nUncheckedSymbol = oCheckboxPr && oCheckboxPr.UncheckedSymbol ? oCheckboxPr.UncheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.UncheckedSymbol;
-		var sCheckedFont     = oCheckboxPr && oCheckboxPr.CheckedFont ? oCheckboxPr.CheckedFont : Asc.c_oAscSdtCheckBoxDefaults.CheckedFont;
-		var sUncheckedFont   = oCheckboxPr && oCheckboxPr.UncheckedFont ? oCheckboxPr && oCheckboxPr.UncheckedFont : Asc.c_oAscSdtCheckBoxDefaults.UncheckedFont;
-
-		var isLoadFonts = false;
-		if (!AscCommon.IsAscFontSupport(sCheckedFont, nCheckedSymbol))
-		{
-			isLoadFonts = true;
-			AscFonts.FontPickerByCharacter.getFontBySymbol(nCheckedSymbol);
-		}
-
-		if (!AscCommon.IsAscFontSupport(sUncheckedFont, nUncheckedSymbol))
-		{
-			isLoadFonts = true;
-			AscFonts.FontPickerByCharacter.getFontBySymbol(nUncheckedSymbol);
-		}
-
-		function private_PerformAddCheckBox()
-		{
-			oCC = CreateCommonForm(oFormPr);
-			oCC.ApplyCheckBoxPr(oCheckboxPr);
-		}
-
-		if (isLoadFonts)
-		{
-			var oFonts = {};
-			oFonts[sCheckedFont]   = true;
-			oFonts[sUncheckedFont] = true;
-
-			AscCommon.Check_LoadingDataBeforePrepaste(this, oFonts, {}, private_PerformAddCheckBox);
-		}
-		else
-		{
-			private_PerformAddCheckBox();
-		}
-
-		CheckFormKey(oCC);
-		return new AscBuilder.ApiCheckBoxForm(oCC);
+			if (!oFormPr)
+				oFormPr = {};
+			
+			oFormPr["placeholder"] = undefined;
+			
+			var oCC;
+			var oCheckboxPr = new AscCommon.CSdtCheckBoxPr();
+			if (GetBoolParameter(oFormPr["radio"], false))
+			{
+				oCheckboxPr.CheckedSymbol   = 0x25C9;
+				oCheckboxPr.UncheckedSymbol = 0x25CB;
+				oCheckboxPr.GroupKey        = GetStringParameter(oFormPr["key"], "Group1");
+			}
+			else
+			{
+				oCheckboxPr.CheckedSymbol   = 0x2611;
+				oCheckboxPr.UncheckedSymbol = 0x2610;
+			}
+			
+			oCheckboxPr.CheckedFont   = "Segoe UI Symbol";
+			oCheckboxPr.UncheckedFont = "Segoe UI Symbol";
+			
+			var nCheckedSymbol   = oCheckboxPr && oCheckboxPr.CheckedSymbol ? oCheckboxPr.CheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.CheckedSymbol;
+			var nUncheckedSymbol = oCheckboxPr && oCheckboxPr.UncheckedSymbol ? oCheckboxPr.UncheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.UncheckedSymbol;
+			var sCheckedFont     = oCheckboxPr && oCheckboxPr.CheckedFont ? oCheckboxPr.CheckedFont : Asc.c_oAscSdtCheckBoxDefaults.CheckedFont;
+			var sUncheckedFont   = oCheckboxPr && oCheckboxPr.UncheckedFont ? oCheckboxPr && oCheckboxPr.UncheckedFont : Asc.c_oAscSdtCheckBoxDefaults.UncheckedFont;
+			
+			var isLoadFonts = false;
+			if (!AscCommon.IsAscFontSupport(sCheckedFont, nCheckedSymbol))
+			{
+				isLoadFonts = true;
+				AscFonts.FontPickerByCharacter.getFontBySymbol(nCheckedSymbol);
+			}
+			
+			if (!AscCommon.IsAscFontSupport(sUncheckedFont, nUncheckedSymbol))
+			{
+				isLoadFonts = true;
+				AscFonts.FontPickerByCharacter.getFontBySymbol(nUncheckedSymbol);
+			}
+			
+			function private_PerformAddCheckBox()
+			{
+				oCC = CreateCommonForm(oFormPr);
+				oCC.ApplyCheckBoxPr(oCheckboxPr);
+			}
+			
+			if (isLoadFonts)
+			{
+				var oFonts             = {};
+				oFonts[sCheckedFont]   = true;
+				oFonts[sUncheckedFont] = true;
+				
+				AscCommon.Check_LoadingDataBeforePrepaste(this, oFonts, {}, private_PerformAddCheckBox);
+			}
+			else
+			{
+				private_PerformAddCheckBox();
+			}
+			
+			CheckFormKey(oCC);
+			return new AscBuilder.ApiCheckBoxForm(oCC);
+		}, this);
 	};
 	/**
-	 * Creates a combo box/dropdown form with the specified combo box/dropdown form properties.
+	 * Creates a combo box / dropdown list with the specified combo box / dropdown list properties.
 	 * @memberof Api
-	 * @param {ComboBoxFormPr} oFormPr - Combo box/dropdown form properties.
+	 * @typeofeditors ["CDE", "CFE"]
+	 * @param {ComboBoxFormPr} oFormPr - Combo box / dropdown list properties.
 	 * @returns {ApiComboBoxForm}
+	 * @see office-js-api/Examples/Forms/Api/Methods/CreateComboBoxForm.js
 	 */
 	Api.prototype.CreateComboBoxForm = function(oFormPr)
 	{
-		if (!oFormPr)
-			oFormPr = {};
-
-		var oPr = new AscCommon.CSdtComboBoxPr();
-		oPr.AddItem(AscCommon.translateManager.getValue("Choose an item"), "");
-
-		var oCC = CreateCommonForm(oFormPr);
-
-		let sPlaceholder = GetStringParameter(oFormPr["placeholder"], undefined);
-
-		let arrList = GetArrayParameter(oFormPr["items"], []);
-		for (let nIndex = 0, nCount = arrList.length; nIndex < nCount; ++nIndex)
+		return executeNoFormLockCheck(function()
 		{
-			let oItem = arrList[nIndex];
-
-			if (GetStringParameter(oItem, null))
+			if (!oFormPr)
+				oFormPr = {};
+			
+			var oPr = new AscCommon.CSdtComboBoxPr();
+			oPr.AddItem(AscCommon.translateManager.getValue("Choose an item"), "");
+			
+			var oCC = CreateCommonForm(oFormPr);
+			
+			let sPlaceholder = GetStringParameter(oFormPr["placeholder"], undefined);
+			
+			let arrList = GetArrayParameter(oFormPr["items"], []);
+			for (let nIndex = 0, nCount = arrList.length; nIndex < nCount; ++nIndex)
 			{
-				oPr.AddItem(oItem, oItem);
+				let oItem = arrList[nIndex];
+				
+				if (GetStringParameter(oItem, null))
+				{
+					oPr.AddItem(oItem, oItem);
+				}
+				else if (GetArrayParameter(oItem, null))
+				{
+					let sDisplay = GetStringParameter(oItem[0], null);
+					let sValue   = GetStringParameter(oItem[1], null);
+					if (null !== sDisplay && null !== sValue)
+						oPr.AddItem(sDisplay, sValue);
+				}
 			}
-			else if (GetArrayParameter(oItem, null))
+			oPr.SetAutoFit(GetBoolParameter(oFormPr["autoFit"], false));
+			
+			if (!GetBoolParameter(oFormPr["editable"], false))
 			{
-				let sDisplay = GetStringParameter(oItem[0], null);
-				let sValue   = GetStringParameter(oItem[1], null);
-				if (null !== sDisplay && null !== sValue)
-					oPr.AddItem(sDisplay, sValue);
-			}
-		}
-		oPr.SetAutoFit(GetBoolParameter(oFormPr["autoFit"], false));
-
-		if (!GetBoolParameter(oFormPr["editable"], false))
-		{
-			if (sPlaceholder)
-			{
-				oCC.ApplyDropDownListPr(oPr);
+				if (sPlaceholder)
+				{
+					oCC.ApplyDropDownListPr(oPr);
+				}
+				else
+				{
+					oCC.SetDropDownListPr(oPr);
+					oCC.SelectListItem();
+				}
 			}
 			else
 			{
-				oCC.SetDropDownListPr(oPr);
-				oCC.SelectListItem();
+				if (sPlaceholder)
+				{
+					oCC.ApplyComboBoxPr(oPr);
+				}
+				else
+				{
+					oCC.SetComboBoxPr(oPr);
+					oCC.SelectListItem();
+				}
 			}
-		}
-		else
-		{
-			if (sPlaceholder)
-			{
-				oCC.ApplyComboBoxPr(oPr);
-			}
-			else
-			{
-				oCC.SetComboBoxPr(oPr);
-				oCC.SelectListItem();
-			}
-		}
-
-		CheckFormKey(oCC);
-		return new AscBuilder.ApiComboBoxForm(oCC);
+			
+			CheckFormKey(oCC);
+			return new AscBuilder.ApiComboBoxForm(oCC);
+		}, this);
 	};
 	/**
 	 * Creates a picture form with the specified picture form properties.
 	 * @memberof Api
+	 * @typeofeditors ["CDE", "CFE"]
 	 * @param {PictureFormPr} oFormPr - Picture form properties.
 	 * @returns {ApiPictureForm}
+	 * @see office-js-api/Examples/Forms/Api/Methods/CreatePictureForm.js
 	 */
 	Api.prototype.CreatePictureForm = function(oFormPr)
 	{
-		if (!oFormPr)
-			oFormPr = {};
-
-		if (GetStringParameter("placeholder", null))
-			oFormPr["placeholder"] = AscCommon.translateManager.getValue("Click to load image");
-
-		var oCC = CreateCommonForm(oFormPr);
-		oCC.ApplyPicturePr(true);
-		oCC.ConvertFormToFixed();
-
-		let oPr = new AscCommon.CSdtPictureFormPr();
-
-		let sScale = GetStringParameter(oFormPr["scaleFlag"], undefined);
-		switch (sScale)
+		return executeNoFormLockCheck(function()
 		{
-			case "always": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Always); break;
-			case "never": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Never); break;
-			case "tooBig": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Bigger); break;
-			case "tooSmall": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Smaller); break;
-		}
-
-		oPr.SetConstantProportions(GetBoolParameter(oFormPr["lockAspectRatio"], true));
-		oPr.SetRespectBorders(GetBoolParameter(oFormPr["respectBorders"], false));
-		oPr.SetShiftX(Math.max(0, Math.min(100, GetNumberParameter(oFormPr["shiftX"], 50))) / 100);
-		oPr.SetShiftY(Math.max(0, Math.min(100, GetNumberParameter(oFormPr["shiftY"], 50))) / 100);
-
-		oCC.SetPictureFormPr(oPr);
-
-		CheckFormKey(oCC);
-		return new AscBuilder.ApiPictureForm(oCC);
+			if (!oFormPr)
+				oFormPr = {};
+			
+			if (GetStringParameter("placeholder", null))
+				oFormPr["placeholder"] = AscCommon.translateManager.getValue("Click to load image");
+			
+			var oCC = CreateCommonForm(oFormPr);
+			oCC.ApplyPicturePr(true);
+			oCC.ConvertFormToFixed();
+			
+			let oPr = new AscCommon.CSdtPictureFormPr();
+			
+			let sScale = GetStringParameter(oFormPr["scaleFlag"], undefined);
+			switch (sScale)
+			{
+				case "always":
+					oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Always);
+					break;
+				case "never":
+					oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Never);
+					break;
+				case "tooBig":
+					oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Bigger);
+					break;
+				case "tooSmall":
+					oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Smaller);
+					break;
+			}
+			
+			oPr.SetConstantProportions(GetBoolParameter(oFormPr["lockAspectRatio"], true));
+			oPr.SetRespectBorders(GetBoolParameter(oFormPr["respectBorders"], false));
+			oPr.SetShiftX(Math.max(0, Math.min(100, GetNumberParameter(oFormPr["shiftX"], 50))) / 100);
+			oPr.SetShiftY(Math.max(0, Math.min(100, GetNumberParameter(oFormPr["shiftY"], 50))) / 100);
+			
+			oCC.SetPictureFormPr(oPr);
+			
+			CheckFormKey(oCC);
+			return new AscBuilder.ApiPictureForm(oCC);
+		}, this);
+	};
+	/**
+	 * Creates a date form with the specified date form properties.
+	 * @memberof Api
+	 * @typeofeditors ["CDE", "CFE"]
+	 * @param {DateFormPr} oFormPr - Date form properties.
+	 * @returns {ApiDateForm}
+	 * @see office-js-api/Examples/Forms/Api/Methods/CreateDateForm.js
+	 */
+	Api.prototype.CreateDateForm = function(oFormPr)
+	{
+		return executeNoFormLockCheck(function()
+		{
+			if (!oFormPr)
+				oFormPr = {};
+			
+			let form = CreateCommonForm(oFormPr);
+			ApplyDateFormPr(form, oFormPr);
+			CheckFormKey(form);
+			return new AscBuilder.ApiDateForm(form);
+		}, this);
+	};
+	/**
+	 * Inserts a text box with the specified text box properties over the selected text.
+	 * @memberof ApiDocument
+	 * @typeofeditors ["CDE", "CFE"]
+	 * @param {TextFormInsertPr} oFormPr - Properties for inserting a text field.
+	 * @returns {ApiTextForm}
+	 * @see office-js-api/Examples/Forms/ApiDocument/Methods/InsertTextForm.js
+	 */
+	ApiDocument.prototype.InsertTextForm = function(oFormPr)
+	{
+		return executeNoFormLockCheck(function()
+		{
+			if (!oFormPr)
+				oFormPr = {};
+			
+			let logicDocument = this.Document;
+			let placeholder   = GetStringParameter(oFormPr["placeholder"], undefined);
+			if (GetBoolParameter(oFormPr["placeholderFromSelection"], false))
+				placeholder = logicDocument.GetSelectedText();
+			
+			if (!GetBoolParameter(oFormPr["keepSelectedTextInForm"], true))
+				logicDocument.RemoveBeforePaste();
+			
+			let contentControl = logicDocument.AddContentControl(c_oAscSdtLevelType.Inline);
+			if (!contentControl)
+				return null;
+			
+			ApplyCommonFormPr(contentControl, oFormPr);
+			SetFormPlaceholder(contentControl, placeholder);
+			ApplyTextFormPr(contentControl, oFormPr, true);
+			CheckFormKey(contentControl);
+			return new AscBuilder.ApiTextForm(contentControl);
+		}, this);
 	};
 	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 	// Private area
 	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 	function CreateCommonForm(oFormPr)
 	{
-		if (!oFormPr)
-			oFormPr = {};
+		let contentControl = new AscCommonWord.CInlineLevelSdt();
 		
-		var oTempFormPr = new AscCommon.CSdtFormPr();
-		oTempFormPr.SetHelpText(GetStringParameter(oFormPr["tip"], undefined));
-		oTempFormPr.SetRequired(GetBoolParameter(oFormPr["required"], false));
-		oTempFormPr.SetKey(GetStringParameter(oFormPr["key"], undefined));
-
-		var oCC = new AscCommonWord.CInlineLevelSdt();
-
-		let sPlaceHolder = GetStringParameter(oFormPr["placeholder"], undefined);
-		if (sPlaceHolder)
-			oCC.SetPlaceholderText(sPlaceHolder);
+		ApplyCommonFormPr(contentControl, oFormPr);
+		
+		let placeholder = oFormPr ? GetStringParameter(oFormPr["placeholder"], undefined) : undefined;
+		SetFormPlaceholder(contentControl, placeholder);
+		
+		let tag = oFormPr ? GetStringParameter(oFormPr["tag"], undefined) : undefined;
+		if (tag)
+			contentControl.SetTag(tag);
+		
+		contentControl.ReplaceContentWithPlaceHolder(false);
+		contentControl.UpdatePlaceHolderTextPrForForm();
+		return contentControl;
+	}
+	function SetFormPlaceholder(form, text)
+	{
+		if (text)
+			form.SetPlaceholderText(text);
 		else
-			oCC.SetPlaceholder(c_oAscDefaultPlaceholderName.Text);
+			form.SetPlaceholder(c_oAscDefaultPlaceholderName.Text);
+	}
+	function ApplyCommonFormPr(form, formPr)
+	{
+		if (!formPr)
+			formPr = {};
+		
+		let sdtFormPr = new AscCommon.CSdtFormPr();
+		sdtFormPr.SetHelpText(GetStringParameter(formPr["tip"], undefined));
+		sdtFormPr.SetRequired(GetBoolParameter(formPr["required"], false));
+		sdtFormPr.SetKey(GetStringParameter(formPr["key"], undefined));
+		form.SetFormPr(sdtFormPr);
+	}
+	function ApplyTextFormPr(form, formPr, keepContent)
+	{
+		let textFormPr = new AscCommon.CSdtTextFormPr();
+		textFormPr.SetComb(GetBoolParameter(formPr["comb"], false));
+		textFormPr.SetMaxCharacters(GetNumberParameter(formPr["maxCharacters"], -1));
+		textFormPr.SetMultiLine(GetBoolParameter(formPr["multiLine"], false));
+		textFormPr.SetAutoFit(GetBoolParameter(formPr["autoFit"], false));
+		textFormPr.SetWidth((GetNumberParameter(formPr["cellWidth"], 0) * 72 * 20 / 25.4) | 0);
+		form.ApplyTextFormPr(textFormPr, keepContent);
+	}
+	function ApplyDateFormPr(form, formPr)
+	{
+		let datePickerPr = new AscCommon.CSdtDatePickerPr();
 
-		oCC.ReplaceContentWithPlaceHolder(false);
-		oCC.SetFormPr(oTempFormPr);
-		oCC.UpdatePlaceHolderTextPrForForm();
+		var nLcid = Asc.g_oLcidNameToIdMap[formPr["lang"]];
+		if (undefined == nLcid)
+			nLcid = 1033;
 
-		return oCC;
+		datePickerPr.SetDateFormat(GetStringParameter(formPr["format"], "mm/dd/yyyy"));
+		datePickerPr.SetLangId(nLcid);
+
+		form.ApplyDatePickerPr(datePickerPr);
 	}
 	function CheckFormKey(form)
 	{
@@ -386,7 +540,11 @@
 	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 	Api.prototype["CreateTextForm"]     = Api.prototype.CreateTextForm;
 	Api.prototype["CreatePictureForm"]  = Api.prototype.CreatePictureForm;
+	Api.prototype["CreateDateForm"]		= Api.prototype.CreateDateForm;
 	Api.prototype["CreateCheckBoxForm"] = Api.prototype.CreateCheckBoxForm;	
-	Api.prototype["CreateComboBoxForm"] = Api.prototype.CreateComboBoxForm;	
+	Api.prototype["CreateComboBoxForm"] = Api.prototype.CreateComboBoxForm;
+	
+	ApiDocument.prototype["InsertTextForm"] = ApiDocument.prototype.InsertTextForm;
 
 }(window, null));
+

apiPlugins.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2022
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions
@@ -41,16 +41,18 @@
      * @property {string} Id - A unique identifier of the content control. It can be used to search for a certain content control and make reference to it in the code.
      * @property {ContentControlLock} Lock - A value that defines if it is possible to delete and/or edit the content control or not: 0 - only deleting, 1 - no deleting or editing, 2 - only editing, 3 - full access.
      * @property {string} InternalId - A unique internal identifier of the content control. It is used for all operations with content controls.
-     */
+     * @see office-js-api/Examples/Plugins/Forms/Enumeration/ContentControl.js
+	 */
 
 	/**
      * @typedef {(0 | 1 | 2 | 3)} ContentControlLock
      * A value that defines if it is possible to delete and/or edit the content control or not:
-	 * * **0** - only deleting
-	 * * **1** - disable deleting or editing
-	 * * **2** - only editing
-	 * * **3** - full access
-     */
+	 * **0** - only deleting
+	 * **1** - disable deleting or editing
+	 * **2** - only editing
+	 * **3** - full access
+     * @see office-js-api/Examples/Plugins/Forms/Enumeration/ContentControlLock.js
+	 */
 
 	/**
 	 * Returns information about all the forms that have been added to the document.
@@ -58,8 +60,7 @@
 	 * @typeofeditors ["CDE"]
 	 * @alias GetAllForms
 	 * @returns {ContentControl[]} - An array with all the forms from the document.
-	 * @example
-	 * window.Asc.plugin.executeMethod("GetAllForms");
+	 * @see office-js-api/Examples/Plugins/Forms/Api/Methods/GetAllForms.js
 	 */
 	window["asc_docs_api"].prototype["pluginMethod_GetAllForms"] = function()
 	{
@@ -82,8 +83,7 @@
 	 * @alias GetFormsByTag
 	 * @param {string} tag - The form tag.
 	 * @returns {ContentControl[]} - An array with all the forms from the document with the specified tag.
-	 * @example
-	 * window.Asc.plugin.executeMethod("GetFormsByTag");
+	 * @see office-js-api/Examples/Plugins/Forms/Api/Methods/GetFormsByTag.js
 	 */
 	window["asc_docs_api"].prototype["pluginMethod_GetFormsByTag"] = function(tag)
 	{
@@ -109,108 +109,11 @@
 	 * @alias SetFormValue
 	 * @param {string} internalId - A unique internal identifier of the form.
 	 * @param {string | boolean} value - Form value to be set. Its type depends on the form type.
-	 * @example
-	 * window.Asc.plugin.executeMethod("SetFormValue");
+	 * @see office-js-api/Examples/Plugins/Forms/Api/Methods/SetFormValue.js
 	 */
 	window["asc_docs_api"].prototype["pluginMethod_SetFormValue"] = function(internalId, value)
 	{
-		let oLogicDocument = this.private_GetLogicDocument();
-
-		if (!AscCommon.g_oTableId
-			|| !oLogicDocument
-			|| !oLogicDocument.IsDocumentEditor())
-			return;
-
-		let oForm = AscCommon.g_oTableId.GetClass(internalId);
-
-		if (!oForm
-			|| !(oForm instanceof AscWord.CInlineLevelSdt)
-			|| !oForm.IsForm())
-			return;
-
-		let oParagraph = oForm.GetParagraph();
-
-		oForm.SkipSpecialContentControlLock(true);
-		if (!oParagraph
-			|| oLogicDocument.IsSelectionLocked(AscCommon.changestype_None, {
-				Type      : AscCommon.changestype_2_ElementsArray_and_Type,
-				Elements  : [oParagraph],
-				CheckType : AscCommon.changestype_Paragraph_Content
-			}, true, oLogicDocument.IsFillingFormMode()))
-		{
-			oForm.SkipSpecialContentControlLock(false);
-			return;
-		}
-		oForm.SkipSpecialContentControlLock(false);
-
-		oLogicDocument.StartAction(AscDFH.historydescription_Document_FillFormInPlugin);
-
-		let isClear = false;
-		if (null === value)
-		{
-			isClear = true;
-		}
-		else if (oForm.IsTextForm() || oForm.IsComboBox())
-		{
-			let sValue = AscBuilder.GetStringParameter(value, "");
-			if (!value)
-				isClear = true;
-			else
-				oForm.SetInnerText(sValue);
-		}
-		else if (oForm.IsDropDownList())
-		{
-			let sValue = AscBuilder.GetStringParameter(value, "");
-			let oPr    = oForm.GetDropDownListPr();
-			let nIndex = oPr.FindByText(sValue);
-			if (-1 !== nIndex)
-				oForm.SelectListItem(oPr.GetItemValue(nIndex));
-			else
-				isClear = true;
-		}
-		else if (oForm.IsCheckBox())
-		{
-			let isChecked = value === "true" ? true : value === "false" ? false : AscBuilder.GetBoolParameter(value, null);
-			if (null !== isChecked)
-				oForm.SetCheckBoxChecked(isChecked);
-			else
-				isClear = true;
-		}
-		else if (oForm.IsPictureForm())
-		{
-			let sValue = AscBuilder.GetStringParameter(value, "");
-			if (!sValue)
-				return;
-
-			let oImg;
-			let allDrawings = oForm.GetAllDrawingObjects();
-			for (let nDrawing = 0; nDrawing < allDrawings.length; ++nDrawing)
-			{
-				if (allDrawings[nDrawing].IsPicture())
-				{
-					oImg = allDrawings[nDrawing].GraphicObj;
-					break;
-				}
-			}
-
-			if (oImg)
-			{
-				oForm.SetShowingPlcHdr(false);
-				oImg.setBlipFill(AscFormat.CreateBlipFillRasterImageId(sValue));
-			}
-			else
-			{
-				isClear = true;
-			}
-		}
-
-		if (isClear)
-			oForm.ClearContentControlExt();
-
-		oLogicDocument.OnChangeForm(oForm);
-		oLogicDocument.Recalculate();
-		oLogicDocument.UpdateTracks();
-		oLogicDocument.FinalizeAction();
+		this.private_SetFormValue(internalId, value);
 	};
 	/**
 	 * Returns a value of the specified form.
@@ -219,9 +122,7 @@
 	 * @alias GetFormValue
 	 * @param {string} internalId - A unique internal identifier of the form.
 	 * @returns {null | string | boolean} The form value in the string or boolean format depending on the form type. The null value means that the form is filled with a placeholder.
-	 * @example
-	 * window.Asc.plugin.executeMethod("GetFormValue");
-	 *
+	 * @see office-js-api/Examples/Plugins/Forms/Api/Methods/GetFormValue.js
 	 */
 	window["asc_docs_api"].prototype["pluginMethod_GetFormValue"] = function(internalId)
 	{
@@ -267,3 +168,4 @@
 	};
 
 })(window);
+

oform/OForm.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/Role.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/BaseFormatObject.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/Document.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/FieldGroup.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/FieldMaster.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/User.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/UserMaster.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/changes/DictionaryBase.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/changes/DocumentChanges.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/changes/FieldGroupChanges.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/changes/FieldMasterChanges.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/changes/UserChanges.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/format/changes/UserMasterChanges.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/xml/XmlContext.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions

oform/xml/XmlPackage.js

@@ -1,5 +1,5 @@
 /*
- * (c) Copyright Ascensio System SIA 2010-2019
+ * (c) Copyright Ascensio System SIA 2010-2024
  *
  * This program is a free software product. You can redistribute it and/or
  * modify it under the terms of the GNU Affero General Public License (AGPL)
@@ -12,7 +12,7 @@
  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
  * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
  *
- * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * You can contact Ascensio System SIA at 20A-6 Ernesta Birznieka-Upish
  * street, Riga, Latvia, EU, LV-1050.
  *
  * The  interactive user interfaces in modified source and object code versions