Difference between revisions of "CAObject::CreateDefTable"
(Marked this version for translation) |
|||
| Line 4: | Line 4: | ||
<translate> | <translate> | ||
| − | = bool CreateDefTable(indexList) = | + | = bool CreateDefTable(indexList) = <!--T:1--> |
| + | <!--T:2--> | ||
Creates an input table object in the definition attribute of the specified Analytica object with | Creates an input table object in the definition attribute of the specified Analytica object with | ||
dimension specified by the indexList. The IndexList parameter must contain an array of identifiers | dimension specified by the indexList. The IndexList parameter must contain an array of identifiers | ||
| Line 15: | Line 16: | ||
methods of the class CATable. | methods of the class CATable. | ||
| − | == Parameters == | + | == Parameters == <!--T:3--> |
| + | <!--T:4--> | ||
«indexList»: A 1-D safe array of strings, containing the names of the indexes that will dimension the [[Table]]. | «indexList»: A 1-D safe array of strings, containing the names of the indexes that will dimension the [[Table]]. | ||
| − | == Return value == | + | == Return value == <!--T:5--> |
| + | <!--T:6--> | ||
Boolean. '''True''' on success. | Boolean. '''True''' on success. | ||
| + | <!--T:7--> | ||
See [[CAEngine::ErrorCode|ErrorCode]] and [[CAEngine::ErrorText|ErrorText]] for information about why it failed. | See [[CAEngine::ErrorCode|ErrorCode]] and [[CAEngine::ErrorText|ErrorText]] for information about why it failed. | ||
| − | = Usage = | + | = Usage = <!--T:8--> |
| − | == C# == | + | == C# == <!--T:9--> |
| − | [[CAObject]] x = ade.[[CAEngine::Get|Get]]("X"); | + | <!--T:10--> |
| + | [[CAObject]] x = ade.[[CAEngine::Get|Get]]("X"); | ||
string [] indexList = new string[3]{"I","J","K"}; | string [] indexList = new string[3]{"I","J","K"}; | ||
if (!x.CreateDefTable(indexList)) { | if (!x.CreateDefTable(indexList)) { | ||
| Line 37: | Line 42: | ||
... | ... | ||
| − | = See Also = | + | = See Also = <!--T:11--> |
| + | <!--T:12--> | ||
* [[CAObject::DefTable]] | * [[CAObject::DefTable]] | ||
* [[CAObject::SetAttribute]] | * [[CAObject::SetAttribute]] | ||
</translate> | </translate> | ||
Latest revision as of 00:41, 16 June 2015
ADE User Guide > ADE Server Class Reference > CAObject
bool CreateDefTable(indexList)
Creates an input table object in the definition attribute of the specified Analytica object with dimension specified by the indexList. The IndexList parameter must contain an array of identifiers of existing index variables (identical in form to the IndexNames method of class CATable). The number of indexes in indexList determines the number of dimensions of the table. One index can be Self, meaning that one of the dimensions are indexed by the Indexvals attribute of this variable. should be one of the entries in the array. Initially, the input table object’s array is filled with null elements, which can be changed using the SetDataByElements and SetDataByLabels methods of the class CATable.
Parameters
«indexList»: A 1-D safe array of strings, containing the names of the indexes that will dimension the Table.
Return value
Boolean. True on success.
See ErrorCode and ErrorText for information about why it failed.
Usage
C#
CAObject x = ade.Get("X"); string [] indexList = new string[3]{"I","J","K"}; if (!x.CreateDefTable(indexList)) { MessageBox.Show(ade.ErrorText,"Error creating table", MessageBoxButtons.Ok); return; } ...
Enable comment auto-refresher