class CARenderingStyle (ADE)

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([out,retval] VARIANT_BOOL* )

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([out,retval] VARIANT_BOOL* )

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([out,retval] SHORT* )

Controls how object terms are returned. 0=its textual identifier, 1=CAObject*, 2=its textual title.

{get,put} bool NewLineAsCRLF([out,retval] VARIANT_BOOL* )

New in ADE 4.2

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([out,retval] VARIANT* )

The value returned for the special value Null.

{get,put} bool NumberAsText([out,retval] VARIANT_BOOL* )

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

{get,put} bool ReferenceAsText([out,retval] VARIANT_BOOL* )

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

{get,put} long SafeArrayLowerBound([out,retval] LONG* )

The lower bound of safe array dimensions returned by GetSafeArray.

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

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

{get,put} variant UndefValue([out,retval] VARIANT* )

The value returned for the special value Undefined.

Deprecated

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

deprecated - use CARenderingStyle::HandleFormat