CDocBuilderValue

new CDocBuilderValue

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

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

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

Methods

NameDescription
callCalls the specified Document Builder method.
clearClears the object.
createArrayCreates an array value.
createNullCreates a null value.
createUndefinedCreates an undefined value.
getReturns an array value by its index or name.
getLengthReturns the length if this object is an array.
getPropertyReturns a property of this object.
isArrayReturns true if this object is an array.
isBoolReturns true if this object is a boolean value.
isDoubleReturns true if this object is a double value.
isEmptyReturns true if this object is empty.
isFunctionReturns true if this object is a function.
isIntReturns true if this object is an integer.
isNullReturns true if this object is null.
isObjectReturns true if this object is an object.
isStringReturns true if this object is a string.
isUndefinedReturns true if this object is undefined.
setSets an array value by its index or name.
setPropertySets a property to this object.
toBoolConverts this object to a boolean value.
toDoubleConverts this object to a double value.
toIntConverts this object to an integer.
toStringConverts this object to a string.

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).