window.Asc.plugin.executeMethod ("AddContentControlCheckBox", [args], callback)
Defines the method that allows adding an empty content control checkbox to the document.
This method should be used in the following way:
window.Asc.plugin.executeMethod ("AddContentControlCheckBox", [checkBoxPr, commonPr]);
| Parameter |
Description |
Type |
Example |
| checkBoxPr |
Defines the content control checkbox properties:
-
Checked - defines if the content control checkbox is checked or not,
type: boolean,
example: false;
-
CheckedSymbol - a symbol in the HTML code format that is used when the checkbox is checked,
type: number,
example: 9746;
-
UncheckedSymbol - a symbol in the HTML code format that is used when the checkbox is not checked,
type: number,
example: 9744.
|
object |
|
| commonPr |
Defines the common content control properties:
-
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: integer,
example: 2;
-
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 which defines if it is possible to delete and/or edit the content control or not,
type: integer,
example: 0;
-
InternalId - a unique internal identifier of the content control,
type: string,
example: "1_713";
-
Alias - the alias attribute,
type: string,
example: "№1";
-
PlaceHolderText - the content control placeholder text,
type: string,
example: "placeholder text";
-
Appearance - defines if the content control is shown as the bounding box (1) or not (2),
type: integer,
example: 1;
-
Color - the color for the current content control in the RGB format (R - red color component value, G - green color component value,
B - blue color component value). For example: {"R": 0, "G": 0, "B": 255},
type: object.
|
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 |
The method returns the undefined value.
window.Asc.plugin.executeMethod ("AddContentControlCheckBox", [{"Checked" : false, "CheckedSymbol" : 9756, "UncheckedSymbol" : 9744}, {"Id" : 7, "Tag" : "{tag}", "Lock" : 0}]);