Difference between revisions of "CAIndex"
(Filled in list of members) |
(Marked this version for translation) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:ADE Classes]] | [[Category:ADE Classes]] | ||
| − | << [[ | + | [[Category:ADE User Guide]] |
| + | <languages /> | ||
| + | <translate> | ||
| + | <!--T:1--> | ||
| + | [[ADE User Guide]] > [[ADE Server Class Reference]] > | ||
| − | + | <!--T:2--> | |
| + | The CAIndex class provides information about the index of a [[CATable]]. | ||
| − | + | = Properties = <!--T:3--> | |
| − | + | === {get} int [[CAIndex::IndexElements|IndexElements]] === <!--T:4--> | |
| − | |||
| − | === {get} int [[CAIndex::IndexElements|IndexElements]] === | ||
| + | <!--T:5--> | ||
Returns the number of elements in the index. | Returns the number of elements in the index. | ||
| − | === {get,put} string [[CAIndex::Name|Name]] === | + | === {get,put} string [[CAIndex::Name|Name]] === <!--T:6--> |
| + | <!--T:7--> | ||
Sets and returns the name of the object. | Sets and returns the name of the object. | ||
| − | === {get,put} [[CARenderingStyle]] [[CAIndex::RenderingStyle|RenderingStyle]] === | + | === {get,put} [[CARenderingStyle]] [[CAIndex::RenderingStyle|RenderingStyle]] === <!--T:8--> |
| + | <!--T:9--> | ||
Settings controlling how atomic values are returned. | Settings controlling how atomic values are returned. | ||
| − | = Methods = | + | = Methods = <!--T:10--> |
| − | === int [[CAIndex::GetNumberByValue|GetNumberByValue]](variant w) === | + | === int [[CAIndex::GetNumberByValue|GetNumberByValue]](variant w) === <!--T:11--> |
Returns an index element's position in the index given its label. | Returns an index element's position in the index given its label. | ||
| − | === variant [[CAIndex::GetValueByNumber|GetValueByNumber]](int i) === | + | === variant [[CAIndex::GetValueByNumber|GetValueByNumber]](int i) === <!--T:12--> |
Returns an index elements label, based on its position in the index. | Returns an index elements label, based on its position in the index. | ||
| − | = Internal Use Only = | + | = Internal Use Only = <!--T:13--> |
| + | <!--T:14--> | ||
These methods are used internally by ADE, and should not be called by your program. | These methods are used internally by ADE, and should not be called by your program. | ||
| − | === bool Send() === | + | === bool Send() === <!--T:15--> |
=== bool ObtainIndex(string indexName) === | === bool ObtainIndex(string indexName) === | ||
| − | = See Also = | + | =See Also= <!--T:16--> |
| − | + | {| style="margin: 1em auto 1em auto;width: 100%;border:0;table-layout: fixed;" cellpadding=5 | |
| − | < | + | |- style="text-align: center" |
| + | | [[CATable]] <- || [[CAIndex]] || -> [[CARenderingStyle]] | ||
| + | </translate> | ||
Latest revision as of 18:51, 9 June 2015
ADE User Guide > ADE Server Class Reference >
The CAIndex class provides information about the index of a CATable.
Properties
{get} int IndexElements
Returns the number of elements in the index.
{get,put} string Name
Sets and returns the name of the object.
{get,put} CARenderingStyle RenderingStyle
Settings controlling how atomic values are returned.
Methods
int GetNumberByValue(variant w)
Returns an index element's position in the index given its label.
variant GetValueByNumber(int i)
Returns an index elements label, based on its position in the index.
Internal Use Only
These methods are used internally by ADE, and should not be called by your program.
bool Send()
bool ObtainIndex(string indexName)
See Also
| CATable <- | CAIndex | -> CARenderingStyle |
Comments
Enable comment auto-refresher