[de] Add methods for plugins to work with forms

Fix bug #57097

api.js

@@ -181,6 +181,7 @@
 				oCC.UpdatePlaceHolderTextPrForForm();
 				oCC.ConvertFormToFixed();
 				oCC.SetPictureFormPr(new AscCommon.CSdtPictureFormPr());
+				oCC.SelectContentControl();
 				var aDrawings = oCC.GetAllDrawingObjects();
 				for(var nDrawing = 0; nDrawing < aDrawings.length; ++nDrawing) 
 				{

apiBuilder.js

@@ -53,82 +53,92 @@
 	var Api = window["Asc"]["asc_docs_api"] || window["Asc"]["spreadsheet_api"];
  
 	/**
-	 * Form common properties
+	 * Common form properties.
 	 * @typedef {Object} FormPrBase
-	 * @property {string} key
-	 * @property {string} tip
-	 * @property {boolean} required
-	 * @property {string} placeholder
+	 * @property {string} key - Form key.
+	 * @property {string} tip - Form tip text.
+	 * @property {boolean} required - Specifies if the form is required or not.
+	 * @property {string} placeholder - Form placeholder text.
 	 */
 
 	/**
-	 * Text form specific properties
+	 * Specific text form properties.
 	 * @typedef {Object} TextFormPrBase
-	 * @property {boolean} comb
-	 * @property {number} maxCharacters
-	 * @property {number} cellWidth
-	 * @property {boolean} multiLine
-	 * @property {boolean} autoFit
+	 * @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 {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.
 	 */
 
 	/**
-	 * Checkbox form properties
+	 * Text form properties.
 	 * @typedef {FormPrBase | TextFormPrBase} TextFormPr
 	 */
 	 
 	/**
-	 * Checkbox specific properties
+	 * Specific checkbox properties.
 	 * @typedef {Object} CheckBoxFormPrBase
-	 * @property {boolean} radio
+	 * @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.
 	 */
 
 	/**
-	 * Checkbox form properties
+	 * Checkbox form properties.
 	 * @typedef {FormPrBase | CheckBoxFormPrBase} CheckBoxFormPr
 	 */
 
 	/**
-	 * Combobox specific properties
+	 * Specific combo box properties.
 	 * @typedef {Object} ComboBoxFormPrBase
-	 * @property {boolean} editable
-	 * @property {boolean} autoFit
-	 * @property {Array.<string | Array.<string>>} items
+	 * @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.
+	 * @property {Array.<string | Array.<string>>} items - The combo box items.
+     * This array consists of strings or arrays of two strings where the first string is the displayed value and the second one is its meaning.
+     * If the array consists of single strings, then the displayed value and its meaning are the same.
+     * Example: ["First", ["Second", "2"], ["Third", "3"], "Fourth"].
+
 	 */
 
 	/**
-	 * Combobox form properties
+	 * Combo box form properties.
 	 * @typedef {FormPrBase | ComboBoxFormPrBase} ComboBoxFormPr
 	 */
 
 	/**
-	 * Condition when to scale image.
+	 * The condition to scale an image in the picture form.
 	 * @typedef {"always" | "never" | "tooBig" | "tooSmall"} ScaleFlag
 	 */
 
 	/**
-	 * Value from 0 to 100
+	 * Value from 0 to 100.
 	 * @typedef {number} percentage
 	 */
 
 	/**
-	 * Picture form specific properties
+	 * Specific picture form properties.
 	 * @typedef {Object} PictureFormPrBase
-	 * @property {ScaleFlag} scaleFlag
-	 * @property {boolean} lockAspectRatio
-	 * @property {boolean} respectBorders
-	 * @property {percentage} shiftX
-	 * @property {percentage} shiftY
+	 * @property {ScaleFlag} scaleFlag - The condition to scale an image in the picture form: "always", "never", "tooBig" or "tooSmall".
+	 * @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.
+	 * @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.
 	 */
 
 	/**
-	 * Picture form properties
+	 * Picture form properties.
 	 * @typedef {FormPrBase | PictureFormPrBase} PictureFormPr
 	 */
 
 	/**
-	 * Create a text form
+	 * Creates a text form with the specified text form properties.
 	 * @memberof Api
-	 * @param {TextFormPr} oFormPr - text form properties
+	 * @param {TextFormPr} oFormPr - Text form properties.
 	 * @returns {ApiTextForm}
 	 */
 	Api.prototype.CreateTextForm = function(oFormPr)
@@ -150,9 +160,9 @@
 		return new AscBuilder.ApiTextForm(oCC);
 	};
 	/**
-	 * Create the checkbox/radiobutton form
+	 * Creates a checkbox/radio button form with the specified checkbox/radio button form properties.
 	 * @memberof Api
-	 * @param {CheckBoxFormPr} oFormPr - checkbox(radiobutton) form properties
+	 * @param {CheckBoxFormPr} oFormPr - Checkbox/radio button form properties.
 	 * @returns {ApiCheckBoxForm}
 	 */
 	Api.prototype.CreateCheckBoxForm = function(oFormPr)
@@ -219,9 +229,9 @@
 		return new AscBuilder.ApiCheckBoxForm(oCC);
 	};
 	/**
-	 * Create a combobox/dropdown form
+	 * Creates a combo box/dropdown form with the specified combo box/dropdown form properties.
 	 * @memberof Api
-	 * @param {ComboBoxFormPr} oFormPr - combobox form properties
+	 * @param {ComboBoxFormPr} oFormPr - Combo box/dropdown form properties.
 	 * @returns {ApiComboBoxForm}
 	 */
 	Api.prototype.CreateComboBoxForm = function(oFormPr)
@@ -283,9 +293,9 @@
 		return new AscBuilder.ApiComboBoxForm(oCC);
 	};
 	/**
-	 * Create a picture form
+	 * Creates a picture form with the specified picture form properties.
 	 * @memberof Api
-	 * @param {PictureFormPr} oFormPr - picture form properties
+	 * @param {PictureFormPr} oFormPr - Picture form properties.
 	 * @returns {ApiPictureForm}
 	 */
 	Api.prototype.CreatePictureForm = function(oFormPr)

apiPlugins.js

@@ -0,0 +1,251 @@
+/*
+ * (c) Copyright Ascensio System SIA 2010-2022
+ *
+ * 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)
+ * version 3 as published by the Free Software Foundation. In accordance with
+ * Section 7(a) of the GNU AGPL its Section 15 shall be amended to the effect
+ * that Ascensio System SIA expressly excludes the warranty of non-infringement
+ * of any third-party rights.
+ *
+ * This program is distributed WITHOUT ANY WARRANTY; without even the implied
+ * 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
+ * street, Riga, Latvia, EU, LV-1050.
+ *
+ * The  interactive user interfaces in modified source and object code versions
+ * of the Program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU AGPL version 3.
+ *
+ * Pursuant to Section 7(b) of the License you must retain the original Product
+ * logo when distributing the program. Pursuant to Section 7(e) we decline to
+ * grant you any rights under trademark law for use of our trademarks.
+ *
+ * All the Product's GUI elements, including illustrations and icon sets, as
+ * well as technical writing content are licensed under the terms of the
+ * Creative Commons Attribution-ShareAlike 4.0 International. See the License
+ * terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
+ *
+ */
+
+"use strict";
+
+(function(window)
+{
+	/**
+	 * Returns information about all the forms that have been added to the document
+	 * @memberof Api
+	 * @typeofeditors ["CDE"]
+	 * @alias GetAllForms
+	 * @returns {[]} - An array of forms
+	 * @example
+	 * window.Asc.plugin.executeMethod("GetAllForms");
+	 */
+	window["asc_docs_api"].prototype["pluginMethod_GetAllForms"] = function()
+	{
+		let oFormsManager = this.private_GetFormsManager();
+		if (!oFormsManager)
+			return [];
+
+		let arrForms  = oFormsManager.GetAllForms();
+		let arrResult = [];
+		for (let nIndex = 0, nCount = arrForms.length; nIndex < nCount; ++nIndex)
+		{
+			arrResult.push(arrForms[nIndex].GetContentControlPr().GetEventObject());
+		}
+		return arrResult;
+	};
+	/**
+	 * Returns information about all the forms that have been added to the document with specified Tag
+	 * @memberof Api
+	 * @typeofeditors ["CDE"]
+	 * @alias GetFormsByTag
+	 * @param {string} tag - Tag of the form
+	 * @returns {[]} - An array of forms
+	 * @example
+	 * window.Asc.plugin.executeMethod("GetFormsByTag");
+	 */
+	window["asc_docs_api"].prototype["pluginMethod_GetFormsByTag"] = function(tag)
+	{
+		let oFormsManager = this.private_GetFormsManager();
+		if (!oFormsManager)
+			return [];
+
+		let arrForms  = oFormsManager.GetAllForms();
+		let arrResult = [];
+		let oForm     = null;
+		for (let nIndex = 0, nCount = arrForms.length; nIndex < nCount; ++nIndex)
+		{
+			oForm = arrForms[nIndex];
+			if (oForm.GetTag() === tag)
+				arrResult.push(oForm.GetContentControlPr().GetEventObject());
+		}
+		return arrResult;
+	};
+	/**
+	 * Set value for specified form
+	 * @memberof Api
+	 * @typeofeditors ["CDE"]
+	 * @alias SetFormValue
+	 * @param {string} internalId - A unique internal identifier of the content control.
+	 * @param {*} value - Depends on the type of a form
+	 * @example
+	 * window.Asc.plugin.executeMethod("SetFormValue");
+	 */
+	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();
+	};
+	/**
+	 * Get form value
+	 * @memberof Api
+	 * @typeofeditors ["CDE"]
+	 * @alias GetFormValue
+	 * @param {string} internalId - A unique internal identifier of the content control.
+	 * @returns {null | string} Value of the form (null means the form is filled with a placeholder)
+	 * @example
+	 * window.Asc.plugin.executeMethod("GetFormValue");
+	 *
+	 */
+	window["asc_docs_api"].prototype["pluginMethod_GetFormValue"] = function(internalId)
+	{
+		if (!AscCommon.g_oTableId)
+			return "";
+
+		let oForm = AscCommon.g_oTableId.GetClass(internalId);
+
+		if (!oForm
+			|| !(oForm instanceof AscWord.CInlineLevelSdt)
+			|| !oForm.IsForm())
+			return "";
+
+		if (oForm.IsPlaceHolder())
+			return null;
+
+		if (oForm.IsTextForm() || oForm.IsComboBox() || oForm.IsDropDownList())
+		{
+			return oForm.GetInnerText();
+		}
+		else if (oForm.IsCheckBox())
+		{
+			return oForm.IsCheckBoxChecked();
+		}
+		else if (oForm.IsPictureForm())
+		{
+			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)
+				return oImg.getBase64Img();
+		}
+
+		return "";
+	};
+
+})(window);

configs/word.json

@@ -1,8 +1,9 @@
 {
   "sdk": {
     "min": [
-      "api.js"
-    ],
+      "api.js",
+	  "apiPlugins.js"
+	],
     "common": [      
 	  "apiBuilder.js"
     ]