CDocBuilderValue

Class used by ONLYOFFICE Document Builder for getting the results of called JS commands. It represents a wrapper for a JS object.

Syntax

class CDocBuilderValue

The CDocBuilderValue class can be created from the primitive data types:

Python

CDocBuilderValue(value)

Where value can be: bool, int, float, str

C++

CDocBuilderValue(const bool& value);
CDocBuilderValue(const int& value);
CDocBuilderValue(const unsigned int& value);
CDocBuilderValue(const double& value);
CDocBuilderValue(const char* value);
CDocBuilderValue(const wchar_t* value);

Java

CDocBuilderValue(boolean value);
CDocBuilderValue(int value);
CDocBuilderValue(double value);
CDocBuilderValue(String value);
CDocBuilderValue(Object[] values);

.Net

CDocBuilderValue(bool value);
CDocBuilderValue(int value);
CDocBuilderValue(unsigned int value);
CDocBuilderValue(double value);
CDocBuilderValue(String^ value);

Methods

Name	Description
Call	Calls the specified Document Builder method.
Clear	Clears the object.
CreateArray	Creates an array value. (Python, Java only)
CreateInstance	Creates an instance of the CDocBuilderValue class. (COM only)
CreateNull	Creates a null value. (not used in COM)
CreateUndefined	Creates an undefined value. (not used in COM)
Get	Returns an array value by its index.
GetLength	Returns the length if this object is an array/typed array.
GetProperty	Returns a property of this object.
IsArray	Returns true if this object is an array.
IsBool	Returns true if this object is a boolean value.
IsDouble	Returns true if this object is a double value.
IsEmpty	Returns true if this object is empty.
IsFunction	Returns true if this object is a function.
IsInt	Returns true if this object is an integer.
IsNull	Returns true if this object is null.
IsObject	Returns true if this object is an object.
IsString	Returns true if this object is a string.
IsTypedArray	Returns true if this object is a typed array. (C++, COM, .Net only)
IsUndefined	Returns true if this object is undefined.
Set	Sets an array value by its index.
SetProperty	Sets a property to this object.
ToBool	Converts this object to a boolean value.
ToDouble	Converts this object to a double value.
ToInt	Converts this object to an integer.
ToString	Converts this object to a string.

note

Java uses camelCase method names: call, clear, get, getLength, etc.