Click or drag to resize

DbOrderCondInfo Class

X#
Helper class to store information needed to create a conditional order.
Inheritance Hierarchy
Object
  DbOrderCondInfo

Namespace:  XSharp.RDD.Support
Assembly:  XSharp.Core (in XSharp.Core.dll) Version: 2.21
Syntax
 CLASS DbOrderCondInfo
Request Example View Source

The DbOrderCondInfo type exposes the following members.

Constructors
  NameDescription
Public methodDbOrderCondInfo
Initializes a new instance of the DbOrderCondInfo class
Top
Methods
  NameDescription
Public methodClone
Public methodCompile
Public methodValidate
Top
Fields
  NameDescription
Public fieldActive
A flag that is TRUE if one or more valid conditions have been specified in the structure.
Public fieldAdditive
A flag that is TRUE if open orders should remain open while the new order is being created.
Public fieldAll
A flag that is TRUE if all rows are to be processed during order creation.
Public fieldCollation
Collation for the FoxPro INDEX ON command
Public fieldCustom
A flag that is TRUE if the new order will be a custom built order.
Public fieldDescending
A flag that is TRUE if the order should be created in descending order.
Public fieldEvalBlock
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.
Public fieldForBlock
A code block defining the for condition to use for the creation and maintenance of the order.
Public fieldForExpression
A string defining the for condition to use for the creation and maintenance of the order.
Public fieldIsBinary
Binary option for the FoxPro INDEX ON command
Public fieldIsCandidate
Candidate option for the FoxPro INDEX ON command
Public fieldIsCompact
Compact option for the FoxPro INDEX ON command
Public fieldNextCount
The number of rows to process for order creation.
Public fieldNoOptimize
A flag that is TRUE if the for condition may NOT be optimized,
Public fieldRecNo
A single row number to include in the order.
Public fieldRest
A flag that is TRUE if only the rows specified by lStartRecno through end-of-file are to be included in the order.
Public fieldScoped
A flag indicating whether the order is to be scoped. fScoped will be TRUE if WhileBlock, NextCount, Recno, Rest, or All is specified.
Public fieldStartRecNo
The row at which to begin processing when either the NextCount or Rest scoping options are specified.
Public fieldStepSize
The frequency of the evaluation of EvalBlock.
Public fieldUseCurrent
A flag that is TRUE if only rows in the controlling order are to be included in the order.
Public fieldWhileBlock
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.
Public fieldWhileExpression
A string defining the for while condition to use for the creation and maintenance of the order.
Top
See Also