Get Started
Plugins
Macros
More information

window.Asc.plugin.executeMethod ("AddContentControl", [args], callback)

Description

Defines the method that allows adding an empty content control to the document.

Usage

This method should be used in the following way:

window.Asc.plugin.executeMethod ("AddContentControl", [wrap, obj]);
Parameters
Parameter Description Type Example
wrap A numeric value that specifies the content control type. It can have one of the following values: 1 (block) or 2 (inline). number 2
obj A JSON object which can have the following values:
  • 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,
    type: number,
    example: 0;
  • Tag - a tag assigned to the content control. The same tag can be assigned to several content controls so that it is possible to make reference to them in your code,
    type: string,
    example: "{tag}";
  • Lock - a value that defines if it is possible to delete and/or edit the content control or not,
    type: number,
    example: 0.
object

The Lock parameter can have the following values:

Numeric value Edit Delete
0 No Yes
1 No No
2 Yes No
3 Yes Yes
Returns

The method returns a JSON object containing the data about the created content control in the following form:

{
    "Tag": "{tag}",
    "Id": 0,
    "Lock": 0,
    "InternalId": "1_713"
}
Example
window.Asc.plugin.executeMethod("AddContentControl", [1, {"Id" : 7, "Tag" : "{tag}", "Lock" : 0}]);