pengjunjie/sdkjs-forms
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/sdkjs-forms.git synced 2026-02-10 18:05:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

[forms][bu] Fix methods description

Browse Source
This commit is contained in:
Ilya Kirillov
2025-06-19 14:29:07 +03:00
parent 70503bde4c
commit 9bee906735
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
apiBuilder.js
View File

@ -480,7 +480,7 @@
* Class representing a collection of form roles. * Class representing a collection of form roles.
* @constructor * @constructor
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
*/ */
function ApiFormRoles(oform) function ApiFormRoles(oform)
{ {
@ -503,7 +503,7 @@
/** /**
* Returns a collection of form roles. * Returns a collection of form roles.
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @returns {ApiFormRoles} * @returns {ApiFormRoles}
* @see office-js-api/Examples/Forms/ApiDocument/Methods/GetFormRoles.js * @see office-js-api/Examples/Forms/ApiDocument/Methods/GetFormRoles.js
*/ */
@ -516,7 +516,7 @@
* Adds a new form role. * Adds a new form role.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @param {string} name - The name of role being added. * @param {string} name - The name of role being added.
* @param {RoleProperties} props - The role properties. * @param {RoleProperties} props - The role properties.
* @returns {boolean} * @returns {boolean}
@ -539,7 +539,7 @@
* Removes a role with the specified name. * Removes a role with the specified name.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @param {string} name - The name of role to be removed. * @param {string} name - The name of role to be removed.
* @param {string} [delegateRole] - The name of the role to which all forms bound to this role will be delegated. * @param {string} [delegateRole] - The name of the role to which all forms bound to this role will be delegated.
* @returns {boolean} * @returns {boolean}
@ -556,7 +556,7 @@
* Returns a number of form roles. * Returns a number of form roles.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @returns {number} * @returns {number}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetCount.js * @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetCount.js
*/ */
@ -571,7 +571,7 @@
* Lists all available roles. * Lists all available roles.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @returns {string[]} * @returns {string[]}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetAllRoles.js * @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetAllRoles.js
*/ */
@ -592,7 +592,7 @@
* Checks if a role with the specified name exists. * Checks if a role with the specified name exists.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @param {string} name - The role name. * @param {string} name - The role name.
* @returns {boolean} * @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/HaveRole.js * @see office-js-api/Examples/Forms/ApiFormRoles/Methods/HaveRole.js
@ -605,7 +605,7 @@
* Returns the RGB color of the specified role. * Returns the RGB color of the specified role.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @param {string} name - The role name. * @param {string} name - The role name.
* @returns {null | {r:byte, g:byte, b:byte}} * @returns {null | {r:byte, g:byte, b:byte}}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetRoleColor.js * @see office-js-api/Examples/Forms/ApiFormRoles/Methods/GetRoleColor.js
@ -629,7 +629,7 @@
* Sets the color for the specified role. * Sets the color for the specified role.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @param {string} name - The role name. * @param {string} name - The role name.
* @param {string} color - The role color. * @param {string} color - The role color.
* @returns {boolean} * @returns {boolean}
@ -652,7 +652,7 @@
* Moves a role up in filling order. * Moves a role up in filling order.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @param {string} name - The role name. * @param {string} name - The role name.
* @returns {boolean} * @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/MoveUp.js * @see office-js-api/Examples/Forms/ApiFormRoles/Methods/MoveUp.js
@ -668,7 +668,7 @@
* Moves a role down in filling order. * Moves a role down in filling order.
* @memberof ApiFormRoles * @memberof ApiFormRoles
* @since 9.0.0 * @since 9.0.0
* @typeofeditors ["CFE"] * @typeofeditors ["CDE", "CFE"]
* @param {string} name - The role name. * @param {string} name - The role name.
* @returns {boolean} * @returns {boolean}
* @see office-js-api/Examples/Forms/ApiFormRoles/Methods/MoveDown.js * @see office-js-api/Examples/Forms/ApiFormRoles/Methods/MoveDown.js