CARenderingStyle

ADE User Guide > ADE Server Class Reference >

A CARenderingStyle controls how atomic values are returned by ADE methods and properties. For example, you may want numbers returned numerically, or as formatted text.

A CARenderingStyle is already present as a property on any CAObject or CATable. Separate default CARenderingStyle for both DefTables and ResultTables are maintained on CAEngine::DefaultDefTableRenderingStyle and CAEngine::DefaultRenderingStyle.

Properties

{get,put} bool FullPrecision

When numeric values are rendered as text, controls whether they are rendered with full precision or using the current object's number format.

{get,put} bool GeneralExpression

When setting values in a DefTable, controls whether the values are constant strings or expressions. If true, they are expressions and constant string values must be quoted.

{get,put} short HandleFormat

Controls how object terms are returned.

0=its textual identifier (in actual CamelCase as it is defined)

1=CAObject*

2=its textual title

3=its textual identifier, but in Sentencecase (first letter upper, all others lower). New to Analytica 4.3

{get,put} bool NewLineAsCRLF

When true, newline characters in text are converted to [CRLF]. Default=true.

New-lines won't print correctly when printed to a console window, such as from cscripts, unless this is true. But if you want to obtain exactly the characters present in a text value, set to false.

{get,put} variant NullValue

The value returned for the special value Null.

{get,put} bool NumberAsText

Whether numeric values should be returned as strings or as numbers.

{get,put} bool ReferenceAsText

Controls whether reference atoms are rendered as text (TRUE), or whether they are dereferenced and returned as a CATable (FALSE).

{get,put} long SafeArrayLowerBound

The lower bound of safe array dimensions returned by GetSafeArray.

{get,put} short StringQuotes

Controls whether string value are quoted. 0=unquoted, 1=single quotes, 2=double quotes.

{get,put} variant UndefValue

The value returned for the special value Undefined.

Deprecated

{get,put} short VarTermFormat([out,retval] SHORT* )

deprecated - use CARenderingStyle::HandleFormat

{get,put} bool PictureAsText

new in Analytica 5.0

Controls how image atoms are returned. Some computed results may contain images, such as the result of functions like ReadImageFile, ReadFromURL, ImageFromHex, or CanvasImage. An image can also result from evaluating (Pict of obj). In these cases, the return value from CAObject::Result, CATable::GetDataByElements, CATable::GetDataByLabels or CATable::GetSafeArray may be an image. When PictureAsText is true, the value returned by these methods is text, i.e., "«Picture»". When PictureAsText is false (the default), a CAPicture object is returned, which your program can then use to access the image itself.

See Also

CAIndex <-

CARenderingStyle

-> CALicense