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(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);

Methods

NameDescription
CallCalls the specified Document Builder method.
ClearClears the object.
CreateNullCreates a null value.
CreateUndefinedCreates an undefined value.
GetReturns an array value by its index.
GetLengthReturns the length if this object is an array/typed 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.
IsTypedArrayReturns true if this object is a typed array.
IsUndefinedReturns true if this object is undefined.
SetSets an array value by its index.
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).