DbOrderCondInfo Class |  |
Helper class to store information needed to create a conditional order.
Inheritance HierarchyNamespace: XSharp.RDD.Support
Assembly: XSharp.Core (in XSharp.Core.dll) Version: 2.19
SyntaxThe DbOrderCondInfo type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DbOrderCondInfo | Initializes a new instance of the DbOrderCondInfo class |
Methods| Name | Description | |
|---|---|---|
| Clone | Create a clone of the condition. |
| Compile | Compile the For and While expressions and store the result in the codeblocks (when any). |
| Validate | Validate the condition.. |
Fields| Name | Description | |
|---|---|---|
 | Active | A flag that is TRUE if one or more valid conditions have been specified in the structure. |
| Additive | A flag that is TRUE if open orders should remain open while the new order is being created. |
| All | A flag that is TRUE if all rows are to be processed during order creation. |
| Collation |
Collation for the FoxPro INDEX ON command
|
| Custom | A flag that is TRUE if the new order will be a custom built order. |
| Descending | A flag that is TRUE if the order should be created in descending order. |
| EvalBlock | A code block defining the expression to evaluate every StepSize rows during the creation of the order. The code block referenced should return a logical value: TRUE indicates that creation of the order should continue normally, and FALSE indicates that order creation should terminate. |
| ForBlock | A code block defining the for condition to use for the creation and maintenance of the order. |
| ForExpression | A string defining the for condition to use for the creation and maintenance of the order. |
| IsBinary |
Binary option for the FoxPro INDEX ON command
|
| IsCandidate |
Candidate option for the FoxPro INDEX ON command
|
| IsCompact |
Compact option for the FoxPro INDEX ON command
|
| NextCount | The number of rows to process for order creation. |
| NoOptimize | A flag that is TRUE if the for condition may NOT be optimized, |
| RecNo | A single row number to include in the order. |
| Rest | A flag that is TRUE if only the rows specified by lStartRecno through end-of-file are to be included in the order. |
| Scoped | A flag indicating whether the order is to be scoped. fScoped will be TRUE if WhileBlock, NextCount, Recno, Rest, or All is specified. |
| StartRecNo | The row at which to begin processing when either the NextCount or Rest scoping options are specified. |
| StepSize | The frequency of the evaluation of EvalBlock. |
| UseCurrent | A flag that is TRUE if only rows in the controlling order are to be included in the order. |
| WhileBlock | A code block defining the while condition to use for the creation of the order. An empty value indicates that no while condition is being imposed. |
| WhileExpression | A string defining the for while condition to use for the creation and maintenance of the order. |
See Also