Click or drag to resize

DataColumn Class (Typed)

X#
Create columns for use in a data browser.
Inheritance Hierarchy
Object
  VObject
    DataColumn

Namespace:  XSharp.VO.SDK
Assembly:  XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
Syntax
 CLASS DataColumn INHERIT VObject
Request Example View Source

The DataColumn type exposes the following members.

Constructors
  NameDescription
Public methodDataColumn
Construct a data column.
Top
Properties
  NameDescription
Public propertyAlignment
One of the following constants representing the alignment of this data column:
Public propertyBackground
The brush used for painting the background of this data column.
Public propertyCode exampleBlock
A code block associated with the data column. If set, it is used to filter the data in/out of the data column.
Public propertyBlockOwner
The owner of the code block associated with the data column. If a code block is assigned, this object will be called when the code block is evaluated. For an example, see DataColumn:Block.
Public propertyCaption
A string representing the caption of this data column for use in its caption area.
Public propertyCellBackground
The Brush object used to paint the background of a cell if DataColumn:EnableCellDraw has been called.
Public propertyCellTextColor
The Color object used to paint the text in a cell if DataColumn:EnableCellDraw has been called.
Public propertyFieldSpec
The FieldSpec object connected to this data column.
Public propertyHyperLabel
The hyperlabel connected to this data column.
Public propertyModified
A logical value indicating whether the contents of the current row of this data column has been changed by the user since it was last set. TRUE indicates that it has changed (even if it has not yet been validated or has failed validation); FALSE indicates that it has not.
Public propertyName
A string representing the name of this data column.
Public propertyNameSym
A symbol representing the name of this data column.
Public propertyOwner
The data browser that owns this data column.
Public propertyServer
The data server to which this data column is currently connected, if any.
Public propertyStatus
A hyperlabel that indicates the results of validations or recent actions to this data column.
Public propertyTextColor
The text color to be used for the text area of this data column.
Public propertyTextValue
A string representing the value held in the current row of this data column. Note that this string is formatted according to the picture clause held in the FieldSpec object inherited from the associated server field.
Public propertyValue
The value held in the current row of this data column, in whatever data type is held in the FieldSpec object inherited from the associated server field.
Public propertyValueChanged
A logical value indicating whether the data column value has been changed to a "valid" value, since it was last set.
Public propertyCode exampleVisualPos
Returns the number of the data column with respect to its visual position within a data browser from left to right.
Public propertyWidth
The width of this data column in canvas coordinates.
Top
Functions
  NameDescription
Public methodAsString
Return the current value in the current row of this data column as a formatted string.
Public methodCode exampleChangeBackground
Set a new background brush for this data column.
Public methodChangeTextColor(Long, Long)
Public methodCode exampleChangeTextColor(Color, Long)
Set a new pen in a particular area of this data column.
Public methodDestroy
Provide a method to de-instantiate a DataColumn object.
(Overrides Destroy.)
Public methodCode exampleEnableCellDraw
Enable the painting of individual cells by registering a cell-painting method.
Public methodEnableColumnMove
Enable/disable whether the user can move (rearrange) this data column with the mouse. If the method is not called, the default behavior is determined by the data browser that owns this column.
Public methodEnableColumnReSize
Enable/disable whether the user can resize this data column with the mouse. If this method is not called, the default behavior is determined by the data browser that owns this column.
Public methodGetModified
Determine whether the value in column has been modified.
Public methodGetValue
Get the value of the current data column.
Public methodLinkDF
Connect a column to a field in a data server.
Public methodPerformValidations
Perform all the validations defined to this data column's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
Public methodSetCaption
Set the caption for the data column.
Public methodSetModified
Mark the current data column, signifying that it has been modified.
Public methodSetStandardStyle
Set the appearance of this data column's caption area.
Public methodSetValue
Set the value of the current data column.
Top
Globals and Defines
  NameDescription
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
A data column is not a control; it is a component of a data browser. From a data management viewpoint, however, a data column is analogous to a control on a data window: when the browser is connected to a server, each column is linked to a data field.
See Also