Difference between revisions of "CARenderingStyle"
| Line 1: | Line 1: | ||
[[Category:ADE Classes]] | [[Category:ADE Classes]] | ||
| − | + | [[Category:ADE User Guide]] | |
| + | [[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 [[CAObject::DefTable|DefTables]] and [[CAObject::ResultTable|ResultTables]] are maintained on [[CAEngine::DefaultDefTableRenderingStyle]] and [[CAEngine::DefaultRenderingStyle]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | A | ||
= Properties = | = Properties = | ||
| Line 62: | Line 60: | ||
deprecated - use CARenderingStyle::HandleFormat | deprecated - use CARenderingStyle::HandleFormat | ||
| + | |||
| + | =See Also= | ||
| + | {| style="margin: 1em auto 1em auto;width: 100%;border:0;table-layout: fixed;" cellpadding=5 | ||
| + | |- style="text-align: center" | ||
| + | | [[CAIndex]] <- || [[CARenderingStyle]] || -> [[CALicense]] | ||
Revision as of 21:13, 2 June 2015
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
See Also
| CAIndex <- | CARenderingStyle | -> CALicense |
Enable comment auto-refresher