DataWindowChild object

A DataWindowChild object is a nested report or a DropDownDataWindow within a DataWindow object. For example, a DataWindow object that populates a column having the DropDownDataWindow edit style is a DataWindowChild object.

The DataWindowChild object is used for accessing DataWindow objects independently from DataWindow functionality, and it inherits from the system Structure object because it needs storage and autoinstantiation.

A DataWindowChild object has no events.

Obsolete functions

Several DataWindowChild functions are described as obsolete, which means that although the functions operate as usual in this release, they will be removed in a future release. You should replace all use of these functions as soon as possible.

Properties

DataWindowChild property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.


Functions

DataWindowChild function

Datatype returned

Description

AcceptText in DataWindow Reference

Integer

Applies the contents of the edit control to the current item in the DataWindowChild buffer.

ClassName in DataWindow Reference

String

Returns the name assigned to the DataWindowChild.

ClearValues in DataWindow Reference

String

Deletes all the items from a value list or code table associated with a DataWindow column.

CrosstabDialog in DataWindow Reference

Integer

Displays the Crosstab Definition dialog box so that the user can modify the definition of a crosstab DataWindow object during execution.

DBCancel in DataWindow Reference

Integer

Cancels a database retrieval in progress.

DBErrorCode in DataWindow Reference

Long

Returns the error code (number) generated by a database error.

Obsolete function

DBErrorCode is an obsolete function and will be discontinued in a future release. Database error codes are now available as event arguments.

DBErrorMessage in DataWindow Reference

String

Returns a string containing the text of the error message generated by a database error.

Obsolete function

DBErrorMessage is an obsolete function and will be discontinued in a future release. Database error messages are now available as event arguments.

DeletedCount in DataWindow Reference

Long

Returns the number of rows that have been deleted from the DataWindowChild but have not yet been updated in the associated database table.

DeleteRow in DataWindow Reference

Integer

Deletes the specified row from the DataWindowChild.

Describe in DataWindow Reference

String

Returns requested information about the structure of the DataWindowChild.

Filter in DataWindow Reference

Integer

Displays specific rows of the DataWindowChild based on its current filter.

FilteredCount in DataWindow Reference

Integer

Returns the number of rows that are not visible because of the DataWindowChild's current filter.

Find in DataWindow Reference

Long

Returns the number of the first row that meets the search criteria within a specified search range in the detail area of a DataWindowChild.

FindGroupChange in DataWindow Reference

Long

Searches starting at a specified row for the first break for the specified group in the DataWindowChild.

GetBandAtPointer in DataWindow Reference

String

Returns the string containing the band in which the pointer is currently located followed by a tab character (~t) and the number of the row associated with the band.

GetBorderStyle in DataWindow Reference

Border (enumerated)

Returns a Border enumerated datatype indicating the border style of the specified column in the DataWindowChild. Values are:

Box!

Lowered!

NoBorder!

Raised!

ResizeBorder!

ShadowBox!

Underline!

GetChanges in DataWindow Reference

Long

Retrieves changes made to a DataWindow into a blob. This function is used primarily in distributed applications.

GetChild in DataWindow Reference

Integer

Provides a reference to a child DataWindow or to a report in a composite DataWindow, which you can use in DataWindow functions to manipulate that DataWindow or report.

GetClickedColumn in DataWindow Reference

Integer

Returns the number of the column in the DataWindowChild that the user clicked or double-clicked.

GetClickedRow in DataWindow Reference

Long

Returns the number of the row in the DataWindowChild that the user clicked or double-clicked.

GetColumn in DataWindow Reference

Integer

Returns the number of the current column in the DataWindowChild.

GetColumnName in DataWindow Reference

String

Returns the name of the current column in the DataWindowChild.

GetContextService in DataWindow Reference

Integer

Creates a reference to a context-specific instance of the specified service.

GetFormat in DataWindow Reference

String

Returns the format used for display in the specified column of the DataWindowChild.

GetItemDate in DataWindow Reference

Date

Returns the date data in the specified row and column of the DataWindowChild.

GetItemDateTime in DataWindow Reference

DateTime

Returns the datetime data in the specified row and column of the DataWindowChild.

GetItemDecimal in DataWindow Reference

Decimal

Returns the decimal data in the specified row and column of the DataWindowChild.

GetItemNumber in DataWindow Reference

Double

Returns the numeric data in the specified row and column of the DataWindowChild.

GetItemStatus in DataWindow Reference

dwItemStatus (enumerated)

Returns the status of the item at the specified row and column location in the specified buffer. Values are:

DataModified!

New!

NewModified!

NotModified!

GetItemString in DataWindow Reference

String

Returns the string data in the specified row and column of the DataWindowChild.

GetItemTime in DataWindow Reference

Time

Returns the time data in the specified row and column of the DataWindowChild.

GetNextModified in DataWindow Reference

Long

Returns the number of the first row that was modified in the specified buffer in the specified DataWindowChild after the specified row.

GetObjectAtPointer in DataWindow Reference

String

Returns the string containing the name of the DataWindowChild column or graphic control under the pointer in the DataWindowChild, then a tab character (~t), and then the row number.

GetParent in DataWindow Reference

PowerObject

Returns a reference to the name of the parent object.

GetRow in DataWindow Reference

Long

Returns an integer containing the number of the current row in the DataWindowChild.

GetRowFromRowId in DataWindow Reference

Long

Gets the row number of a row in a DataWindow control from the unique row identifier associated with that row.

GetRowIdFromRow in DataWindow Reference

Long

Gets the unique row identifier of a row in a DataWindow control from the row number associated with that row.

GetSelectedRow in DataWindow Reference

Integer

Returns the number of the first selected row after the specified row number in the DataWindowChild.

GetSQLPreview in DataWindow Reference

String

Returns the current SQL statement the DataWindowChild is submitting to the database.

Obsolete function

GetSQLPreview is an obsolete function and will be discontinued in a future release. SQL syntax is now available as an event argument.

GetSQLSelect in DataWindow Reference

String

Returns the current SELECT statement for the DataWindowChild.

GetText in DataWindow Reference

String

Returns the text in the edit control over the current row and column of the DataWindowChild.

GetTrans in DataWindow Reference

Integer

Returns the values in the DataWindowChild Transaction object.

GetUpdateStatus in DataWindow Reference

Integer

Stores the number of the row that will be updated in a variable and the dwBuffer enumerated datatype identifying the buffer containing the row in another variable.

Obsolete function

GetUpdateStatus is an obsolete function and will be discontinued in a future release. Update status is now available as an argument in the DataWindow DBError and SQLPreview events.

GetValidate in DataWindow Reference

String

Returns the validation rule used in the specified column of the DataWindowChild.

GetValue in DataWindow Reference

String

Returns the specified item in the value list for the specified column.

GroupCalc in DataWindow Reference

Integer

Recalculates the breaks in the groups in the DataWindowChild.

ImportClipboard in DataWindow Reference

Long

Copies data from the clipboard to the DataWindowChild.

ImportFile in DataWindow Reference

Long

Copies data from a file to the DataWindowChild.

ImportString in DataWindow Reference

Long

Copies data from a string to the DataWindowChild.

InsertRow in DataWindow Reference

Long

Inserts a new initialized row before the specified row in the DataWindowChild.

IsSelected in DataWindow Reference

Boolean

Returns true if the specified row in the DataWindowChild is selected; returns false if the row is not selected or is greater than the number of rows in the DataWindowChild.

ModifiedCount in DataWindow Reference

Long

Returns the number of rows that have been modified in the DataWindowChild but have not yet been updated in the associated database table.

Modify in DataWindow Reference

String

Uses the specification contained in a string to modify the DataWindowChild.

OLEActivate in DataWindow Reference

Integer

Activates OLE for the OLE object in the specified row and column of the DataWindowChild.

ReselectRow in DataWindow Reference

Integer

Accesses the database to reselect all columns that can be updated and refreshes all timestamp columns in a row in the DataWindowChild.

Reset in DataWindow Reference

Integer

Clears all the data from a DataWindowChild.

ResetTransObject in DataWindow Reference

Integer

Stops the DataWindowChild from using a programmer-defined Transaction object (thereafter, the DataWindow uses its internal Transaction object).

ResetUpdate in DataWindow Reference

Integer

Resets the update flags for the DataWindowChild.

Retrieve in DataWindow Reference

Long

Causes the DataWindowChild to retrieve rows from the database.

RowCount in DataWindow Reference

Long

Returns the number of rows currently available in the DataWindowChild (all the rows retrieved minus any deleted rows plus any inserted rows minus any rows that have been filtered out).

RowsCopy in DataWindow Reference

Integer

Copies a range of rows from one DataWindowChild to another or from one buffer to another within a single DataWindowChild.

RowsDiscard in DataWindow Reference

Integer

Discards a range of rows. The rows cannot be restored unless retrieved from the database.

RowsMove in DataWindow Reference

Integer

Clears a range of rows from a DataWindowChild and inserts the rows in another DataWindowChild or another buffer of the same DataWindowChild.

SaveAs in DataWindow Reference

Integer

Saves the contents of the DataWindowChild control to the specified file, in the specified format, with or without column headings at the beginning

ScrollNextPage in DataWindow Reference

Long

Scrolls forward by the number of rows showing in the DataWindowChild.

ScrollNextRow in DataWindow Reference

Long

Scrolls the DataWindowChild to the next row. ScrollNextRow changes the current row but does not change the current column.

ScrollPriorPage in DataWindow Reference

Long

Scrolls backward by the number of rows showing in the DataWindowChild.

ScrollPriorRow in DataWindow Reference

Long

Scrolls to the previous row. The ScrollPriorRow function changes the current row in the DataWindowChild but does not change the current column.

ScrollToRow in DataWindow Reference

Integer

Causes the control to scroll to the specified row. ScrollToRow changes the current row in the DataWindowChild but does not change the current column.

SelectRow in DataWindow Reference

Integer

Selects or deselects the specified row of the DataWindowChild.

SetBorderStyle in DataWindow Reference

Integer

Sets the border style of the specified column in the DataWindowChild.

SetChanges in DataWindow Reference

Long

Applies changes captured with GetChanges to a DataWindow. This function is used primarily in distributed applications.

SetColumn in DataWindow Reference

Integer

Makes the specified column the current column in the DataWindowChild.

SetDetailHeight in DataWindow Reference

Integer

Sets the height of each row in a specified range.

SetFilter in DataWindow Reference

Integer

Defines the filter criteria for the DataWindowChild. The actual filtering is performed by the Filter function.

SetFormat in DataWindow Reference

Integer

Sets the display format for the specified column of the DataWindowChild.

SetItem in DataWindow Reference

Integer

Sets the value of the specified row and column of the specified DataWindowChild.

SetItemStatus in DataWindow Reference

Integer

Sets the status of a row in a specified column of the DataWindowChild in the specified buffer.

SetPosition in DataWindow Reference

Integer

Moves an object within the DataWindowChild to another band or changes the front-to-back order of objects within a band.

SetRedraw in DataWindow Reference

Integer

Controls automatic redrawing of the DataWindowChild after each change in its properties or contents.

SetRow in DataWindow Reference

Integer

Makes the specified row the current row in the DataWindowChild.

SetRowFocusIndicator in DataWindow Reference

Integer

Sets the current row indicator for the DataWindowChild.

SetSort in DataWindow Reference

Integer

Defines the sort criteria for the DataWindowChild. The actual sorting is performed by the Sort function.

SetSQLPreview in DataWindow Reference

Integer

Sets the current SQL statement for the DataWindowChild.

SetSQLSelect in DataWindow Reference

Integer

Changes the current SELECT statement for the DataWindowChild.

SetTabOrder in DataWindow Reference

Integer

Changes the tab value of the specified column in the DataWindowChild.

SetText in DataWindow Reference

Integer

Replaces the text in the edit control at the current row and column of the DataWindowChild with the specified text.

SetTrans in DataWindow Reference

Integer

Sets values in the DataWindowChild's internal Transaction object.

SetTransObject in DataWindow Reference

Integer

Sets the Transaction object for the DataWindowChild and provides control over the transaction, including the ability to commit from a script.

SetValidate in DataWindow Reference

Integer

Changes the validation rule used for the specified column of the DataWindowChild.

SetValue in DataWindow Reference

Integer

Sets the value of the specified item in the value list or the code table of the specified column of the DataWindowChild.

SetWSObject in DataWindow Reference

Integer

Causes a DataWindowChild to use a programmer-specified connection object. The connection object provides the information necessary for communicating with a Web service data source.

ShareData in DataWindow Reference

Integer

Shares data between a primary DataWindowChild and a secondary DataWindowChild.

ShareDataOff in DataWindow Reference

Integer

Turns off sharing for the DataWindowChild. If that object is the primary DataWindowChild, all secondary DataWindowChild objects are disconnected and their DataWindow objects no longer contain data.

Sort in DataWindow Reference

Integer

Sorts the rows of the DataWindowChild based on its current sort criteria.

TypeOf in DataWindow Reference

Object

Returns the type of the control.

Update in DataWindow Reference

Integer

Sends to the database all inserts, deletes, and updates of the DataWindowChild.