Difference between revisions of "CARenderingStyle"
Line 11: | Line 11: | ||
= Properties = | = Properties = | ||
− | === {get,put} bool FullPrecision === | + | === {get,put} bool [[CARenderingStyle::FullPrecision|FullPrecision]] === |
When numeric values are rendered as text, controls whether they are rendered with full precision or using the current object's number format. | 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 === | + | === {get,put} bool [[CARenderingStyle::GeneralExpression|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. | 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 === | + | === {get,put} short [[CARenderingStyle::HandleFormat|HandleFormat]] === |
Controls how object terms are returned. | Controls how object terms are returned. | ||
Line 27: | Line 27: | ||
:3=its textual identifier, but in Sentencecase (first letter upper, all others lower). ''New to [[Analytica 4.3]]'' | :3=its textual identifier, but in Sentencecase (first letter upper, all others lower). ''New to [[Analytica 4.3]]'' | ||
− | === {get,put} bool | + | === {get,put} bool [[CARenderingStyle::NewLineAsCRLF|NewLineAsCRLF]] === |
− | |||
− | |||
When true, newline characters in text are converted to [CRLF]. Default=true. | When true, newline characters in text are converted to [CRLF]. Default=true. | ||
Line 35: | Line 33: | ||
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. | 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 === | + | === {get,put} variant [[CARenderingStyle::NullValue|NullValue]] === |
The value returned for the special value Null. | The value returned for the special value Null. | ||
− | === {get,put} bool NumberAsText === | + | === {get,put} bool [[CARenderingStyle::NumberAsText|NumberAsText]] === |
Whether numeric values should be returned as strings or as numbers. | Whether numeric values should be returned as strings or as numbers. | ||
− | === {get,put} bool ReferenceAsText === | + | === {get,put} bool [[CARenderingStyle::ReferenceAsText|ReferenceAsText]] === |
Controls whether reference atoms are rendered as text (TRUE), or whether they are dereferenced and returned as a CATable (FALSE). | Controls whether reference atoms are rendered as text (TRUE), or whether they are dereferenced and returned as a CATable (FALSE). | ||
− | === {get,put} long SafeArrayLowerBound === | + | === {get,put} long [[CARenderingStyle::SafeArrayLowerBound|SafeArrayLowerBound]] === |
The lower bound of safe array dimensions returned by GetSafeArray. | The lower bound of safe array dimensions returned by GetSafeArray. | ||
− | === {get,put} short StringQuotes === | + | === {get,put} short [[CARenderingStyle::StringQuotes|StringQuotes]] === |
Controls whether string value are quoted. 0=unquoted, 1=single quotes, 2=double quotes. | Controls whether string value are quoted. 0=unquoted, 1=single quotes, 2=double quotes. | ||
− | === {get,put} variant UndefValue === | + | === {get,put} variant [[CARenderingStyle::UndefValue|UndefValue]] === |
The value returned for the special value Undefined. | The value returned for the special value Undefined. |
Revision as of 04:38, 13 May 2015
<< Analytica Decision Engine (ADE) API
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
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
Enable comment auto-refresher