Compare commits

...

14 Commits

Author SHA1 Message Date
8e661ab8a9 [oform] Fix the size for inner shape of a signature form 2025-06-02 16:50:10 +03:00
bee4c2702c Merge pull request 'fix/roles-builder' (#3) from fix/roles-builder into release/v9.0.0 2025-05-28 17:08:38 +00:00
9446505728 [form] Add a default role to the new form if it isn't specified 2025-05-28 18:51:03 +03:00
d80cc23221 [de] Add ability so specify the role when adding form using office-js-api 2025-05-28 00:02:14 +03:00
a602d9aa36 [forms] Add methods to work with oform roles 2025-05-27 18:24:07 +03:00
ea7e3c0f02 Fix bug #70332
Convert drawing to inline form when adding picture content control
2025-05-05 16:55:41 +03:00
1da45dde0e For bug #71640
Add subforms to a complex form with the role name of the complex form
2025-04-30 12:03:09 +03:00
4ac368daa0 Merge branch hotfix/v8.3.3 into release/v9.0.0 2025-04-21 09:08:04 +00:00
b8cbadfde6 Merge branch hotfix/v8.3.2 into release/v9.0.0 2025-04-01 08:39:13 +00:00
4732938f0a Merge branch hotfix/v8.3.2 into master 2025-03-19 12:50:23 +00:00
7505fadefe Fix bug #73572
Fix changing roles order
2025-03-17 18:32:49 +03:00
439c9b3085 [de] Don't translate default role name 2025-03-14 21:18:45 +03:00
f4d5a88be0 Merge pull request '[bu][plugins] Use Api in proto' (#2) from fix/bu-description into release/v9.0.0
Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/sdkjs-forms/pulls/2
2025-03-06 11:36:13 +00:00
c8bff88071 [bu][plugins] Use Api in proto 2025-03-06 15:23:08 +07:00
7 changed files with 279 additions and 15 deletions

16
api.js
View File

@ -189,6 +189,17 @@ window["AscOForm"] = window.AscOForm = AscOForm;
let h = isSignature ? 32 / 72 * 25.4 : undefined;
var oCC = oLogicDocument.AddContentControlPicture(w, h);
// MSWord can't open files with anchored picture content controls (70332)
if (oCC && !oFormPr)
{
let allDrawings = oCC.GetAllDrawingObjects();
for (let i = 0; i < allDrawings.length; ++i)
{
allDrawings[i].MakeInline();
}
}
let oFormParaDrawing = null;
if (oCC && oFormPr)
{
@ -263,7 +274,7 @@ window["AscOForm"] = window.AscOForm = AscOForm;
else
{
oCC.ReplaceContentWithPlaceHolder();
oCC.ApplyPicturePr(true);
oCC.ApplyPicturePr(true, w, h);
}
}
@ -673,6 +684,9 @@ window["AscOForm"] = window.AscOForm = AscOForm;
form.SetFormPr(formPr.Copy());
if (!form.IsMainForm() && form.GetMainForm().GetFormRole() !== formPr.GetRole())
form.SetFormRole(form.GetMainForm().GetFormRole());
let docPartId = form.GetPlaceholder();
let glossary = logicDocument.GetGlossaryDocument();
if ((form.IsTextForm()

View File

@ -61,6 +61,7 @@
* @property {string} key - Form key.
* @property {string} tip - Form tip text.
* @property {string} tag - Form tag.
* @property {string} role - The role to fill out form.
* @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
@ -197,7 +198,7 @@
let form = CreateCommonForm(oFormPr);
ApplyTextFormPr(form, oFormPr);
CheckFormKey(form);
CheckForm(form);
return new AscBuilder.ApiTextForm(form);
}, this);
};
@ -272,7 +273,7 @@
private_PerformAddCheckBox();
}
CheckFormKey(oCC);
CheckForm(oCC);
return new AscBuilder.ApiCheckBoxForm(oCC);
}, this);
};
@ -342,7 +343,7 @@
}
}
CheckFormKey(oCC);
CheckForm(oCC);
return new AscBuilder.ApiComboBoxForm(oCC);
}, this);
};
@ -394,7 +395,7 @@
oCC.SetPictureFormPr(oPr);
CheckFormKey(oCC);
CheckForm(oCC);
return new AscBuilder.ApiPictureForm(oCC);
}, this);
};
@ -415,7 +416,7 @@
let form = CreateCommonForm(oFormPr);
ApplyDateFormPr(form, oFormPr);
CheckFormKey(form);
CheckForm(form);
return new AscBuilder.ApiDateForm(form);
}, this);
};
@ -449,10 +450,216 @@
ApplyCommonFormPr(contentControl, oFormPr);
SetFormPlaceholder(contentControl, placeholder);
ApplyTextFormPr(contentControl, oFormPr, true);
CheckFormKey(contentControl);
CheckForm(contentControl);
return new AscBuilder.ApiTextForm(contentControl);
}, this);
};
/**
* Class representing a collection of form roles.
* @constructor
* @since 9.0.0
* @typeofeditors ["CFE"]
*/
function ApiFormRoles(oform)
{
this.oform = oform;
}
/**
* Role properties.
* @typedef {FormPrBase | DateFormPrBase} DateFormPr
* @see office-js-api/Examples/Enumerations/DateFormPr.js
*/
/**
* Role properties.
* @typedef {Object} RoleProperties
* @property {string} color
* @see office-js-api/Examples/Enumerations/RolePr.js
*/
/**
* Get the collection of form roles.
*
* @since 9.0.0
* @typeofeditors ["CFE"]
* @returns {ApiFormRoles}
* @see office-js-api/Examples/Forms/ApiDocument/Methods/GetFormRoles.js
*/
ApiDocument.prototype.GetFormRoles = function()
{
return new ApiFormRoles(this.Document.GetOFormDocument());
};
/**
* Add new role.
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @param {string} name - The name of role being added.
* @param {RoleProperties} props - Properties for the new role.
* @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/Add.js
*/
ApiFormRoles.prototype.Add = function(name, props)
{
if (!this.oform || !name || this.oform.getRole(name))
return false;
let rgba = ParseRoleColor(props && props["color"] ? props["color"] : null);
let rolePr = new AscOForm.CRoleSettings();
rolePr.Name = name;
rolePr.Color = AscCommon.CreateAscColorCustom(rgba.R, rgba.G, rgba.B);
this.oform.addRole(rolePr);
return true;
};
/**
* Remove role.
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @param {string} name - The name of role to be removed.
* @param {string} [delegateRole] - The name of the role to which all forms binded to this role will be delegated.
* @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/Remove.js
*/
ApiFormRoles.prototype.Remove = function(name, delegateRole)
{
if (!this.oform)
return false;
return this.oform.removeRole(name, delegateRole);
};
/**
* Get the number of roles.
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @returns {number}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetCount.js
*/
ApiFormRoles.prototype.GetCount = function()
{
if (!this.oform)
return 0;
return this.oform.getAllRoles().length;
};
/**
* List all roles.
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @returns {string[]}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetAllRoles.js
*/
ApiFormRoles.prototype.GetAllRoles = function()
{
if (!this.oform)
return [];
let roles = this.oform.getAllRoles();
let result = [];
for (let i = 0; i < roles.length; ++i)
{
result.push(roles[i].getRole());
}
return result;
};
/**
* Check if a role with the specified name exists.
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @param {string} name - The name of role.
* @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/HaveRole.js
*/
ApiFormRoles.prototype.HaveRole = function(name)
{
return this.oform && this.oform.haveRole(name);
};
/**
* Get the color of the specified role
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @param {string} name - The name of role.
* @returns {null | {r:byte, g:byte, b:byte}}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetRoleColor.js
*/
ApiFormRoles.prototype.GetRoleColor = function(name)
{
if (!this.oform || !this.oform.haveRole(name))
return null;
let color = this.oform.getRoleSettings(name).getColor();
if (!color)
return null;
return {
"r" : color.r,
"g" : color.g,
"b" : color.b
};
};
/**
* Set the color of the specified role
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @param {string} name - The name of role.
* @param {string} color - The specified color.
* @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/SetRoleColor.js
*/
ApiFormRoles.prototype.SetRoleColor = function(name, color)
{
if (!this.oform || !this.oform.haveRole(name))
return false;
let rgba = ParseRoleColor(color);
let rolePr = new AscOForm.CRoleSettings();
rolePr.Name = name;
rolePr.Color = AscCommon.CreateAscColorCustom(rgba.R, rgba.G, rgba.B);
this.oform.editRole(name, rolePr);
return true;
};
/**
* Move role up in filling order.
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @param {string} name - The name of role.
* @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/MoveUp.js
*/
ApiFormRoles.prototype.MoveUp = function(name)
{
if (!this.oform)
return false;
return this.oform.moveUpRole(name);
};
/**
* Move role down in filling order.
* @memberof ApiFormRoles
* @since 9.0.0
* @typeofeditors ["CFE"]
* @param {string} name - The name of role.
* @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/MoveUp.js
*/
ApiFormRoles.prototype.MoveDown = function(name)
{
if (!this.oform)
return false;
return this.oform.moveDownRole(name);
};
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Private area
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@ -489,6 +696,7 @@
sdtFormPr.SetHelpText(GetStringParameter(formPr["tip"], undefined));
sdtFormPr.SetRequired(GetBoolParameter(formPr["required"], false));
sdtFormPr.SetKey(GetStringParameter(formPr["key"], undefined));
sdtFormPr.SetRole(GetStringParameter(formPr["role"], undefined));
form.SetFormPr(sdtFormPr);
}
function ApplyTextFormPr(form, formPr, keepContent)
@ -514,6 +722,11 @@
form.ApplyDatePickerPr(datePickerPr);
}
function CheckForm(form)
{
CheckFormKey(form);
CheckFormRole(form);
}
function CheckFormKey(form)
{
let logicDocument = editor && editor.WordControl && editor.WordControl.m_oLogicDocument;
@ -535,6 +748,30 @@
formPr.SetKey(key);
form.SetFormPr(formPr);
}
function CheckFormRole(form)
{
let logicDocument = editor && editor.WordControl && editor.WordControl.m_oLogicDocument;
if (!form || !form.IsForm() || !logicDocument)
return;
let role = form.GetFormRole();
if (role && "" !== role.trim())
return;
let oform = logicDocument.GetOFormDocument();
if (!oform)
return;
let defaultRole = oform.getDefaultRole();
if (!defaultRole)
return;
form.SetFormRole(defaultRole.getRole());
}
function ParseRoleColor(color)
{
return color ? AscCommon.RgbaTextToRGBA(color) : {R : 254, G : 248, B : 229, A : 255};
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Export
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@ -545,6 +782,17 @@
Api.prototype["CreateComboBoxForm"] = Api.prototype.CreateComboBoxForm;
ApiDocument.prototype["InsertTextForm"] = ApiDocument.prototype.InsertTextForm;
ApiDocument.prototype["GetFormRoles"] = ApiDocument.prototype.GetFormRoles;
ApiFormRoles.prototype["Add"] = ApiFormRoles.prototype.Add;
ApiFormRoles.prototype["Remove"] = ApiFormRoles.prototype.Remove;
ApiFormRoles.prototype["GetCount"] = ApiFormRoles.prototype.GetCount;
ApiFormRoles.prototype["GetAllRoles"] = ApiFormRoles.prototype.GetAllRoles;
ApiFormRoles.prototype["HaveRole"] = ApiFormRoles.prototype.HaveRole;
ApiFormRoles.prototype["GetRoleColor"] = ApiFormRoles.prototype.GetRoleColor;
ApiFormRoles.prototype["SetRoleColor"] = ApiFormRoles.prototype.SetRoleColor;
ApiFormRoles.prototype["MoveUp"] = ApiFormRoles.prototype.MoveUp;
ApiFormRoles.prototype["MoveDown"] = ApiFormRoles.prototype.MoveDown;
}(window, null));

View File

@ -34,6 +34,8 @@
(function(window)
{
let Api = window["asc_docs_api"];
/**
* @typedef {Object} ContentControl
* Content control object.
@ -62,7 +64,7 @@
* @returns {ContentControl[]} - An array with all the forms from the document.
* @see office-js-api/Examples/Plugins/Forms/Api/Methods/GetAllForms.js
*/
window["asc_docs_api"].prototype["pluginMethod_GetAllForms"] = function()
Api.prototype["pluginMethod_GetAllForms"] = function()
{
let oFormsManager = this.private_GetFormsManager();
if (!oFormsManager)
@ -85,7 +87,7 @@
* @returns {ContentControl[]} - An array with all the forms from the document with the specified tag.
* @see office-js-api/Examples/Plugins/Forms/Api/Methods/GetFormsByTag.js
*/
window["asc_docs_api"].prototype["pluginMethod_GetFormsByTag"] = function(tag)
Api.prototype["pluginMethod_GetFormsByTag"] = function(tag)
{
let oFormsManager = this.private_GetFormsManager();
if (!oFormsManager)
@ -111,7 +113,7 @@
* @param {string | boolean} value - Form value to be set. Its type depends on the form type.
* @see office-js-api/Examples/Plugins/Forms/Api/Methods/SetFormValue.js
*/
window["asc_docs_api"].prototype["pluginMethod_SetFormValue"] = function(internalId, value)
Api.prototype["pluginMethod_SetFormValue"] = function(internalId, value)
{
this.private_SetFormValue(internalId, value);
};
@ -124,7 +126,7 @@
* @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.
* @see office-js-api/Examples/Plugins/Forms/Api/Methods/GetFormValue.js
*/
window["asc_docs_api"].prototype["pluginMethod_GetFormValue"] = function(internalId)
Api.prototype["pluginMethod_GetFormValue"] = function(internalId)
{
if (!AscCommon.g_oTableId)
return "";

View File

@ -568,7 +568,7 @@
this.OForm.onChangeRoles();
};
CDocument.prototype.onChangeFieldGroup = function(fieldGroup)
CDocument.prototype.onChangeFieldGroupFilled = function(fieldGroup)
{
if (!this.OForm)
return;

View File

@ -69,7 +69,7 @@
AscCommon.History.Add(new AscDFH.CChangesOFormFieldGroupFilled(this, this.Filled, isFilled));
this.Filled = isFilled;
this.onChange();
this.onChangeFilled();
};
CFieldGroup.prototype.setWeight = function(value)
{

View File

@ -124,7 +124,7 @@
CUserMaster.prototype.initDefaultUser = function()
{
// TODO: Возможно стоит придумать уникальный id общий для дефолтовой роли
this.setRole(AscCommon.translateManager.getValue("Anyone"));
this.setRole("Anyone");
this.setColor(255, 239, 191);
};
CUserMaster.prototype.compare = function(user)

View File

@ -137,7 +137,7 @@
function(value)
{
this.Class.Filled = value;
this.Class.onChange();
this.Class.onChangeFilled();
},
false
);