Difference between revisions of "CARenderingStyle"
(Marked this version for translation) |
|||
Line 3: | Line 3: | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
+ | <!--T:1--> | ||
[[ADE User Guide]] > [[ADE Server Class Reference]] > | [[ADE User Guide]] > [[ADE Server Class Reference]] > | ||
+ | <!--T:2--> | ||
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 controls how atomic values are returned by ADE methods and properties. For example, you may want numbers returned numerically, or as formatted text. | ||
+ | <!--T:3--> | ||
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 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]]. | ||
− | = Properties = | + | = Properties = <!--T:4--> |
− | === {get,put} bool [[CARenderingStyle::FullPrecision|FullPrecision]] === | + | === {get,put} bool [[CARenderingStyle::FullPrecision|FullPrecision]] === <!--T:5--> |
+ | <!--T:6--> | ||
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 [[CARenderingStyle::GeneralExpression|GeneralExpression]] === | + | === {get,put} bool [[CARenderingStyle::GeneralExpression|GeneralExpression]] === <!--T:7--> |
+ | <!--T:8--> | ||
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 [[CARenderingStyle::HandleFormat|HandleFormat]] === | + | === {get,put} short [[CARenderingStyle::HandleFormat|HandleFormat]] === <!--T:9--> |
+ | <!--T:10--> | ||
Controls how object terms are returned. | Controls how object terms are returned. | ||
:0=its textual identifier (in actual CamelCase as it is defined) | :0=its textual identifier (in actual CamelCase as it is defined) | ||
Line 27: | Line 33: | ||
: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 [[CARenderingStyle::NewLineAsCRLF|NewLineAsCRLF]] === | + | === {get,put} bool [[CARenderingStyle::NewLineAsCRLF|NewLineAsCRLF]] === <!--T:11--> |
+ | <!--T:12--> | ||
When true, newline characters in text are converted to [CRLF]. Default=true. | When true, newline characters in text are converted to [CRLF]. Default=true. | ||
+ | <!--T:13--> | ||
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 [[CARenderingStyle::NullValue|NullValue]] === | + | === {get,put} variant [[CARenderingStyle::NullValue|NullValue]] === <!--T:14--> |
+ | <!--T:15--> | ||
The value returned for the special value Null. | The value returned for the special value Null. | ||
− | === {get,put} bool [[CARenderingStyle::NumberAsText|NumberAsText]] === | + | === {get,put} bool [[CARenderingStyle::NumberAsText|NumberAsText]] === <!--T:16--> |
+ | <!--T:17--> | ||
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 [[CARenderingStyle::ReferenceAsText|ReferenceAsText]] === | + | === {get,put} bool [[CARenderingStyle::ReferenceAsText|ReferenceAsText]] === <!--T:18--> |
+ | <!--T:19--> | ||
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 [[CARenderingStyle::SafeArrayLowerBound|SafeArrayLowerBound]] === | + | === {get,put} long [[CARenderingStyle::SafeArrayLowerBound|SafeArrayLowerBound]] === <!--T:20--> |
+ | <!--T:21--> | ||
The lower bound of safe array dimensions returned by GetSafeArray. | The lower bound of safe array dimensions returned by GetSafeArray. | ||
− | === {get,put} short [[CARenderingStyle::StringQuotes|StringQuotes]] === | + | === {get,put} short [[CARenderingStyle::StringQuotes|StringQuotes]] === <!--T:22--> |
+ | <!--T:23--> | ||
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 [[CARenderingStyle::UndefValue|UndefValue]] === | + | === {get,put} variant [[CARenderingStyle::UndefValue|UndefValue]] === <!--T:24--> |
+ | <!--T:25--> | ||
The value returned for the special value Undefined. | The value returned for the special value Undefined. | ||
− | = Deprecated = | + | = Deprecated = <!--T:26--> |
− | === {get,put} short VarTermFormat([out,retval] SHORT* ) === | + | === {get,put} short VarTermFormat([out,retval] SHORT* ) === <!--T:27--> |
+ | <!--T:28--> | ||
deprecated - use CARenderingStyle::HandleFormat | deprecated - use CARenderingStyle::HandleFormat | ||
− | =See Also= | + | =See Also= <!--T:29--> |
{| style="margin: 1em auto 1em auto;width: 100%;border:0;table-layout: fixed;" cellpadding=5 | {| style="margin: 1em auto 1em auto;width: 100%;border:0;table-layout: fixed;" cellpadding=5 | ||
|- style="text-align: center" | |- style="text-align: center" | ||
| [[CAIndex]] <- || [[CARenderingStyle]] || -> [[CALicense]] | | [[CAIndex]] <- || [[CARenderingStyle]] || -> [[CALicense]] | ||
</translate> | </translate> |
Revision as of 18:51, 9 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